project35.soa.ontology.provenance
Class OntologyTermProvenanceManager

java.lang.Object
  project35.soa.ontology.provenance.OntologyTermProvenanceManager

public class OntologyTermProvenanceManager
extends java.lang.Object

manages the meta data about all the ontology terms that have been used to tag a document. It manages a collection of OntologyTermProvenance objects, which capture a variety of meta data about an ontology term This class is used to serialise ontology terms in the *.meta information layer of Project35's native *.pdz files

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Constructor Summary

OntologyTermProvenanceManager()

Method Summary

void	addTerm(java.lang.String recordClassName, java.lang.String fieldName, OntologyTermProvenance ontologyTermProvenance)
void	addTerms(java.lang.String recordClassName, java.lang.String fieldName, java.util.ArrayList ontologyTerms)
void	clearField(java.lang.String recordClassName, java.lang.String fieldName)
void	clearTerms()
boolean	containsTerm(java.lang.String identifier) searches for term amongst all terms document wide
boolean	containsTerm(java.lang.String recordClassName, java.lang.String identifier) searches for a match between identifier and any terms that have been used with record type X
boolean	containsTerm(java.lang.String recordClassName, java.lang.String fieldName, java.lang.String identifier) searches for a match between identifier and any terms that have been used with record type X
void	deleteAllReferences(java.util.ArrayList itemsToDelete) deletes terms from entire collection
void	deleteTerm(OntologyTermProvenance ontologyTerm)
void	deleteTerm(java.lang.String recordClassName, OntologyTermProvenance ontologyTerm)
void	deleteTerm(java.lang.String recordClassName, java.lang.String fieldName, OntologyTermProvenance ontologyTerm)
void	deleteTerms(java.util.ArrayList itemsToDelete)
void	deleteTerms(java.lang.String recordClassName, java.util.ArrayList itemsToDelete)
void	deleteTerms(java.lang.String recordClassName, java.lang.String fieldName, java.util.ArrayList itemsToDelete)
java.util.ArrayList	getAllTerms()
java.util.ArrayList	getRecordClassNames()
java.util.ArrayList	getTerms(java.lang.String recordClassName)
java.util.ArrayList	getTerms(java.lang.String recordClassName, java.lang.String fieldName)
java.util.ArrayList	getUsedFieldNames(java.lang.String recordClassName) returns a list of field names that are associated with ontology terms

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OntologyTermProvenanceManager

public OntologyTermProvenanceManager()

Method Detail

getTerms

public java.util.ArrayList getTerms(java.lang.String recordClassName)

getTerms

public java.util.ArrayList getTerms(java.lang.String recordClassName,
                                    java.lang.String fieldName)

getUsedFieldNames

public java.util.ArrayList getUsedFieldNames(java.lang.String recordClassName)

returns a list of field names that are associated with ontology terms

getRecordClassNames

public java.util.ArrayList getRecordClassNames()

containsTerm

public boolean containsTerm(java.lang.String identifier)

searches for term amongst all terms document wide

containsTerm

public boolean containsTerm(java.lang.String recordClassName,
                            java.lang.String identifier)

searches for a match between identifier and any terms that have been used with record type X

containsTerm

public boolean containsTerm(java.lang.String recordClassName,
                            java.lang.String fieldName,
                            java.lang.String identifier)

searches for a match between identifier and any terms that have been used with record type X

getAllTerms

public java.util.ArrayList getAllTerms()

addTerm

public void addTerm(java.lang.String recordClassName,
                    java.lang.String fieldName,
                    OntologyTermProvenance ontologyTermProvenance)

addTerms

public void addTerms(java.lang.String recordClassName,
                     java.lang.String fieldName,
                     java.util.ArrayList ontologyTerms)

deleteAllReferences

public void deleteAllReferences(java.util.ArrayList itemsToDelete)

deletes terms from entire collection

deleteTerm

public void deleteTerm(OntologyTermProvenance ontologyTerm)

deleteTerm

public void deleteTerm(java.lang.String recordClassName,
                       OntologyTermProvenance ontologyTerm)

deleteTerm

public void deleteTerm(java.lang.String recordClassName,
                       java.lang.String fieldName,
                       OntologyTermProvenance ontologyTerm)

deleteTerms

public void deleteTerms(java.util.ArrayList itemsToDelete)

deleteTerms

public void deleteTerms(java.lang.String recordClassName,
                        java.util.ArrayList itemsToDelete)

deleteTerms

public void deleteTerms(java.lang.String recordClassName,
                        java.lang.String fieldName,
                        java.util.ArrayList itemsToDelete)

clearField

public void clearField(java.lang.String recordClassName,
                       java.lang.String fieldName)

clearTerms

public void clearTerms()