@Entity public class PolytomousKey extends IdentifiableEntity<PolytomousKeyDefaultCacheStrategy> implements IIdentificationKey, IIntextReferenceTarget
taxon
to) a specimen or observation
. The key may be written manually or may be generated automatically
e.g. by the PolytomousKeyGenerator
. The different paths to the taxa are expressed
by a decision graph consisting of PolytomousKeyNodes
. The root node of such graph is accessible by
getRoot()
. Refer to PolytomousKeyNode
for detailed
documentation on the decision graph structure.cacheStrategy, NOT_PROTECTED, PROTECTED, protectedTitleCache, titleCache
annotations, markers
CLOB_LENGTH, uuid
Modifier | Constructor and Description |
---|---|
protected |
PolytomousKey()
Class constructor: creates a new empty multi-access key instance.
|
Modifier and Type | Method and Description |
---|---|
void |
addCoveredTaxon(Taxon taxon)
Adds a
taxa to the set of covered
taxa corresponding to this identification key. |
void |
addGeographicalScope(NamedArea geoScope)
Adds a
geoScope to the set of geogspatial scopes corresponding to this identification key. |
void |
addScopeRestriction(DefinedTerm scopeRestriction)
Adds a
scope restriction to the set of
scope restrictions corresponding to
this identification key. |
void |
addTaxonomicScope(Taxon taxon)
Adds a
taxa to the set of taxonomic scopes corresponding to this identification key. |
java.lang.Object |
clone()
Clones this PolytomousKey.
|
java.util.Set<Taxon> |
getCoveredTaxa()
Returns the set of possible
taxa corresponding to
this identification key. |
java.util.Set<NamedArea> |
getGeographicalScope()
Returns the set of
named areas indicating the
geospatial data where this identification key is valid. |
PolytomousKeyNode |
getRoot()
Returns the topmost
polytomous key node (root
node) of this polytomous key. |
java.util.Set<DefinedTerm> |
getScopeRestrictions()
Returns the set of
scope restrictions corresponding to
this identification key |
int |
getStartNumber()
The first number for the automated numbering of
key nodes . |
java.util.Set<Taxon> |
getTaxonomicScope()
Returns the set of
taxa that define the taxonomic scope of
this identification key |
static PolytomousKey |
NewInstance()
Creates a new empty identification multi-access key instance.
|
static PolytomousKey |
NewTitledInstance(java.lang.String title)
Creates a new empty identification polytomous key instance.
|
java.lang.String |
print(java.io.PrintStream stream) |
void |
removeCoveredTaxon(Taxon taxon)
Removes one element from the set of
covered
taxa corresponding to this identification key. |
void |
removeGeographicalScope(NamedArea geoScope)
Removes one element from the set of
geogspatial
scopes corresponding to this identification key. |
void |
removeScopeRestriction(DefinedTerm scopeRestriction)
Removes one element from the set of
scope
restrictions corresponding to this identification key. |
void |
removeTaxonomicScope(Taxon taxon)
Removes one element from the set of
taxonomic
scopes corresponding to this identification key. |
protected void |
setCoveredTaxa(java.util.Set<Taxon> coveredTaxa) |
void |
setRoot(PolytomousKeyNode root)
This method should be used by Hibernate only.
|
void |
setStartNumber(int startNumber) |
addCredit, addCredit, addExtension, addExtension, addIdentifier, addIdentifier, addIdentifier, addRights, addSource, addSources, createNewSource, generateTitle, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getExtensions, getExtensions, getExtensionsConcat, getExtensionsConcat, getFilteredExtensions, getIdentifiers, getIdentifiers, getIdentifiers, getLsid, getRights, getTitleCache, getTruncatedCache, hasEmptyTitleCache, hasExtension, hasExtension, initListener, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeIdentifier, removeIdentifier, removeRights, replaceCredit, replaceIdentifier, resetTitleCache, setCacheStrategy, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString, updateCaches, updateCaches
addAggregationSource, addImportSource, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, getSources, removeSource, removeSources
addAnnotation, addMarker, addMarker, getAnnotations, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker, setAnnotations
cloneLanguageString, equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
addPropertyChangeListener, addPropertyChangeListener, addToSetWithChangeEvent, deproxy, deproxy, fireOnCreateEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUserFriendlyDescription, getUserFriendlyFieldName, getUserFriendlyTypeName, getUuid, hashCode, hasListeners, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isBlank, isInstanceOf, isNotBlank, isPersited, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid
finalize, getClass, notify, notifyAll, wait, wait, wait
getCreated, getCreatedBy, getId, getUuid, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid
removeSources
addAggregationSource, addImportSource, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, getSources, removeSource
addAnnotation, addMarker, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
protected PolytomousKey()
public static PolytomousKey NewInstance()
public static PolytomousKey NewTitledInstance(java.lang.String title)
public PolytomousKeyNode getRoot()
polytomous key node
(root
node) of this polytomous key. The root node does not have any
parent. Since polytomous key nodes recursively point to their child nodes
the complete polytomous key is defined by its root node.public void setRoot(PolytomousKeyNode root)
getRoot()
public java.util.Set<Taxon> getCoveredTaxa()
taxa
corresponding to
this identification key.getCoveredTaxa
in interface IIdentificationKey
protected void setCoveredTaxa(java.util.Set<Taxon> coveredTaxa)
getCoveredTaxa()
public void addCoveredTaxon(Taxon taxon)
taxa
to the set of covered
taxa
corresponding to this identification key.addCoveredTaxon
in interface IIdentificationKey
taxon
- the taxon to be added to this identification keygetCoveredTaxa()
public void removeCoveredTaxon(Taxon taxon)
covered
taxa
corresponding to this identification key.removeCoveredTaxon
in interface IIdentificationKey
taxon
- the taxon which should be removedgetCoveredTaxa()
,
addCoveredTaxon(Taxon)
public java.util.Set<NamedArea> getGeographicalScope()
named areas
indicating the
geospatial data where this identification key is valid.getGeographicalScope
in interface IIdentificationKey
public void addGeographicalScope(NamedArea geoScope)
geoScope
to the set of geogspatial scopes
corresponding to this identification key.addGeographicalScope
in interface IIdentificationKey
geoScope
- the named area to be added to this identification key#getGeoScopes()
public void removeGeographicalScope(NamedArea geoScope)
geogspatial
scopes
corresponding to this identification key.removeGeographicalScope
in interface IIdentificationKey
geoScope
- the named area which should be removed#getGeoScopes()
,
#addGeoScope(NamedArea)
public java.util.Set<Taxon> getTaxonomicScope()
taxa
that define the taxonomic scope of
this identification keygetTaxonomicScope
in interface IIdentificationKey
public void addTaxonomicScope(Taxon taxon)
taxa
to the set of taxonomic scopes
corresponding to this identification key.addTaxonomicScope
in interface IIdentificationKey
taxon
- the taxon to be added to this identification keygetTaxonomicScope()
public void removeTaxonomicScope(Taxon taxon)
taxonomic
scopes
corresponding to this identification key.removeTaxonomicScope
in interface IIdentificationKey
taxon
- the taxon which should be removedgetTaxonomicScope()
,
addTaxonomicScope(Taxon)
public java.util.Set<DefinedTerm> getScopeRestrictions()
scope restrictions
corresponding to
this identification keygetScopeRestrictions
in interface IIdentificationKey
public void addScopeRestriction(DefinedTerm scopeRestriction)
scope restriction
to the set of
scope restrictions
corresponding to
this identification key.addScopeRestriction
in interface IIdentificationKey
scopeRestriction
- the scope restriction to be added to this
identification keygetScopeRestrictions()
public void removeScopeRestriction(DefinedTerm scopeRestriction)
scope
restrictions
corresponding to this identification key.removeScopeRestriction
in interface IIdentificationKey
scopeRestriction
- the scope restriction which should be removedgetScopeRestrictions()
,
#addScopeRestriction(Scope)
public int getStartNumber()
key nodes
.
Default value is 1.public void setStartNumber(int startNumber)
startNumber
- getStartNumber()
public java.lang.String print(java.io.PrintStream stream)
public java.lang.Object clone()
clone
in class IdentifiableEntity<PolytomousKeyDefaultCacheStrategy>
IdentifiableEntity.clone()
,
Object.clone()
Copyright © 2007-2020 EDIT. All Rights Reserved.