eu.etaxonomy.cdm.model.common
Class OrderedTermVocabulary<T extends OrderedTermBase>

java.lang.Object
  eu.etaxonomy.cdm.model.common.CdmBase
      eu.etaxonomy.cdm.model.common.VersionableEntity
          eu.etaxonomy.cdm.model.common.AnnotatableEntity
              eu.etaxonomy.cdm.model.common.IdentifiableEntity
                  eu.etaxonomy.cdm.model.common.TermBase
                      eu.etaxonomy.cdm.model.common.TermVocabulary<T>
                          eu.etaxonomy.cdm.model.common.OrderedTermVocabulary<T>

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, ISourceable<IdentifiableSource>, IVersionableEntity, Serializable, Cloneable, Iterable<T>

@Indexed(index="eu.etaxonomy.cdm.model.common.TermVocabulary")
public class OrderedTermVocabulary<T extends OrderedTermBase>
extends TermVocabulary<T>

Author:

a.mueller

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.etaxonomy.cdm.model.common.TermVocabulary

terms

Fields inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

cacheStrategy, NOT_PROTECTED, PROTECTED, protectedTitleCache, titleCache

Fields inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

annotations, markers

Fields inherited from class eu.etaxonomy.cdm.model.common.CdmBase

uuid

Constructor Summary

protected	OrderedTermVocabulary()
protected	OrderedTermVocabulary(String term, String label, String labelAbbrev, URI termSourceUri)

Method Summary

void	addTerm(T term) Adds a term to the the end / lowest
void	addTermAbove(T termToBeAdded, T lowerTerm)
void	addTermBelow(T termToBeAdded, T higherTerm)
void	addTermEqualLevel(T termToBeAdded, T equalLevelTerm)
SortedSet<T>	getEqualTerms(T otb)
SortedSet<T>	getHigherAndEqualTerms(T otb)
SortedSet<T>	getHigherTerms(T otb)
T	getHighestTerm()
SortedSet<T>	getLowerAndEqualTerms(T otb)
SortedSet<T>	getLowerTerms(T otb)
T	getLowestTerm()
Set<T>	getNewTermSet()
T	getNextHigherTerm(T otb)
T	getNextLowerTerm(T otb)
SortedSet<T>	getOrderedTerms()
boolean	indexChangeAllowed(OrderedTermBase<T> orderedTermBase)
static OrderedTermVocabulary	NewInstance(String term, String label, String labelAbbrev, URI termSourceUri)
void	removeTerm(T term)

Methods inherited from class eu.etaxonomy.cdm.model.common.TermVocabulary

clone, findTermByUuid, getTerms, getTermsOrderedByLabels, getTermSourceUri, iterator, readCsvLine, readCsvLine, setTermSourceUri, size

Methods inherited from class eu.etaxonomy.cdm.model.common.TermBase

addRepresentation, equals, getDescription, getDescription, getLabel, getLabel, getPreferredRepresentation, getPreferredRepresentation, getRepresentation, getRepresentations, getUri, removeRepresentation, setLabel, setLabel, setUri, toString

Methods inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

addCredit, addCredit, addExtension, addExtension, addRights, addSource, addSource, compareTo, generateTitle, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getExtensions, getExtensions, getLsid, getRights, getSources, getTitleCache, getTruncatedCache, initListener, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeRights, removeSource, setCacheStrategy, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache

Methods inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker

Methods inherited from class eu.etaxonomy.cdm.model.common.VersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from class eu.etaxonomy.cdm.model.common.CdmBase

addPropertyChangeListener, addPropertyChangeListener, clone, deproxy, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hashCode, hasListeners, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removePropertyChangeListener, removePropertyChangeListener, setCreated, setCreatedBy, setId, setUuid

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface eu.etaxonomy.cdm.model.common.IAnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker

Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Constructor Detail

OrderedTermVocabulary

protected OrderedTermVocabulary()

OrderedTermVocabulary

protected OrderedTermVocabulary(String term,
                                String label,
                                String labelAbbrev,
                                URI termSourceUri)

Parameters:

term -

label -

termSourceUri -

Method Detail

NewInstance

public static OrderedTermVocabulary NewInstance(String term,
                                                String label,
                                                String labelAbbrev,
                                                URI termSourceUri)

getNewTermSet

public Set<T> getNewTermSet()

getOrderedTerms

public SortedSet<T> getOrderedTerms()

getHigherAndEqualTerms

public SortedSet<T> getHigherAndEqualTerms(T otb)

getHigherTerms

public SortedSet<T> getHigherTerms(T otb)

getLowerAndEqualTerms

public SortedSet<T> getLowerAndEqualTerms(T otb)

getLowerTerms

public SortedSet<T> getLowerTerms(T otb)

getEqualTerms

public SortedSet<T> getEqualTerms(T otb)

getNextHigherTerm

public T getNextHigherTerm(T otb)

getNextLowerTerm

public T getNextLowerTerm(T otb)

getLowestTerm

public T getLowestTerm()

getHighestTerm

public T getHighestTerm()

addTerm

public void addTerm(T term)

Adds a term to the the end / lowest

Overrides:

addTerm in class TermVocabulary<T extends OrderedTermBase>

See Also:

TermVocabulary.addTerm(eu.etaxonomy.cdm.model.common.DefinedTermBase)

addTermAbove

public void addTermAbove(T termToBeAdded,
                         T lowerTerm)

addTermBelow

public void addTermBelow(T termToBeAdded,
                         T higherTerm)

addTermEqualLevel

public void addTermEqualLevel(T termToBeAdded,
                              T equalLevelTerm)
                       throws WrongTermTypeException

Throws:

WrongTermTypeException

removeTerm

public void removeTerm(T term)

Overrides:

removeTerm in class TermVocabulary<T extends OrderedTermBase>

indexChangeAllowed

public boolean indexChangeAllowed(OrderedTermBase<T> orderedTermBase)