|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objecteu.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.DefinedTermBase<Feature>
eu.etaxonomy.cdm.model.description.Feature
@Indexed(index="eu.etaxonomy.cdm.model.common.DefinedTermBase") public class Feature
The class for individual properties (also designed as character, type or
category) of observed phenomena able to be described or measured. It also
covers categories of informations on taxon names not
taken in account in nomenclature.
Descriptions require features in order to be structured and disaggregated
in description elements.
Experts do not use the word feature for the actual description
but only for the property itself. Therefore naming this class FeatureType
would have leaded to confusion.
Since features are defined terms they have a hierarchical
structure that allows to specify ("kind of") or generalize
("generalization of") features. "Kind of" / "generalization of" relations
are bidirectional (a feature F1 is a "Kind of" a feature F2 if and only
if the feature F2 is a "generalization of" the feature F1. This hierarchical
structure has nothing in common with feature trees used for determination.
A standard set of feature instances will be automatically
created as the project starts. But this class allows to extend this standard
set by creating new instances of additional features if needed.
This class corresponds to DescriptionsSectionType according to the SDD schema.
| Field Summary | |
|---|---|
protected static Map<UUID,Feature> |
termMap
|
| Fields inherited from class eu.etaxonomy.cdm.model.common.DefinedTermBase |
|---|
partOf, vocabulary |
| 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 | |
|---|---|
|
Feature()
Class constructor: creates a new empty feature instance. |
protected |
Feature(String term,
String label,
String labelAbbrev)
Class constructor: creates a new feature instance with a description (in the default language),
a label and a label abbreviation. |
| Method Summary | |
|---|---|
static Feature |
ADDITIONAL_PUBLICATION()
Returns the "additional_publication" feature. |
void |
addRecommendedMeasurementUnit(MeasurementUnit recommendedMeasurementUnit)
Adds a statistical measure to the set of
recommended statistical measures assigned
to this feature. |
void |
addRecommendedModifierEnumeration(TermVocabulary<Modifier> recommendedModifierEnumeration)
Adds a term vocabulary (with modifiers) to the set of
recommended modifier vocabularies assigned
to this feature. |
void |
addRecommendedStatisticalMeasure(StatisticalMeasure recommendedStatisticalMeasure)
Adds a statistical measure to the set of
recommended statistical measures assigned
to this feature. |
void |
addSupportedCategoricalEnumeration(TermVocabulary<State> supportedCategoricalEnumeration)
Adds a term vocabulary to the set of
supported state vocabularies assigned
to this feature. |
static Feature |
ANATOMY()
Returns the "anatomy" feature. |
static Feature |
BIOLOGY_ECOLOGY()
Returns the "biology_ecology" feature. |
static Feature |
CHROMOSOME_NUMBER()
Returns the "chromosome number" feature. |
static Feature |
CITATION()
Returns the "citation" feature. |
static Feature |
COMMON_NAME()
Returns the "common_name" feature. |
static Feature |
CONSERVATION()
Returns the "conservation" feature. |
static Feature |
CULTIVATION()
Returns the "cultivation" feature. |
static Feature |
DESCRIPTION()
Returns the "description" feature. |
static Feature |
DIAGNOSIS()
Returns the "diagnosis" feature. |
static Feature |
DISCUSSION()
Returns the "discussion" feature. |
static Feature |
DISTRIBUTION()
Returns the "distribution" feature. |
static Feature |
ECOLOGY()
Returns the "ecology" feature. |
static Feature |
ETYMOLOGY()
Returns the "etymology" feature. |
Set<Feature> |
getGeneralizationOf()
Returns all defined terms this term is a generalization for. |
Set<Feature> |
getIncludes()
Returns all defined terms this term includes. |
Feature |
getKindOf()
Returns the defined term this term is a kind of. |
Feature |
getPartOf()
Returns the defined term this term is a part of. |
Set<MeasurementUnit> |
getRecommendedMeasurementUnits()
Returns the set of statistical measures recommended to be used
in case of quantitative data with this feature. |
Set<TermVocabulary<Modifier>> |
getRecommendedModifierEnumeration()
Returns the set of term vocabularies containing the
modifiers recommended to be used for description elements
with this feature. |
Set<StatisticalMeasure> |
getRecommendedStatisticalMeasures()
Returns the set of statistical measures recommended to be used
in case of quantitative data with this feature. |
Set<TermVocabulary<State>> |
getSupportedCategoricalEnumerations()
Returns the set of term vocabularies containing the list of
possible states to be used in categorical data
with this feature. |
protected static Feature |
getTermByUuid(UUID uuid)
|
static Feature |
HABITAT_ECOLOGY()
Returns the "habitat & ecology" feature. |
static Feature |
HABITAT()
Returns the "habitat" feature. |
static Feature |
HOSTPLANT()
Returns the "hostplant" feature. |
static Feature |
HYBRID_PARENT()
Returns the "hybrid_parent" feature. |
static Feature |
IMAGE()
Returns the "image" feature. |
static Feature |
INDIVIDUALS_ASSOCIATION()
Returns the "individuals association" feature. |
static Feature |
INTRODUCTION()
Returns the "introduction" feature. |
boolean |
isSupportsCategoricalData()
Returns the boolean value of the flag indicating whether this feature can be described with categorical data
(true) or not (false). |
boolean |
isSupportsCommonTaxonName()
Returns the boolean value of the flag indicating whether this feature can be described with common names
(true) or not (false). |
boolean |
isSupportsDistribution()
Returns the boolean value of the flag indicating whether this feature can be described with distribution objects
(true) or not (false). |
boolean |
isSupportsIndividualAssociation()
Returns the boolean value of the flag indicating whether this feature can be described with individuals associations
(true) or not (false). |
boolean |
isSupportsQuantitativeData()
Returns the boolean value of the flag indicating whether this feature can be described with quantitative data (true)
or not (false). |
boolean |
isSupportsTaxonInteraction()
Returns the boolean value of the flag indicating whether this feature can be described with taxon interactions
(true) or not (false). |
boolean |
isSupportsTextData()
Returns the boolean value of the flag indicating whether this feature can be described with text data (true)
or not (false). |
static Feature |
KEY()
Returns the "key" feature. |
static Feature |
MATERIALS_EXAMINED()
Returns the "materials_examined" feature. |
static Feature |
MATERIALS_METHODS()
Returns the "materials_methods" feature. |
static Feature |
NewInstance()
Creates a new empty feature instance. |
static Feature |
NewInstance(String term,
String label,
String labelAbbrev)
Creates a new feature instance with a description (in the default language),
a label and a label abbreviation. |
static Feature |
OBSERVATION()
|
static Feature |
OCCURRENCE()
Returns the "occurrence" feature. |
static Feature |
PATHOGEN_AGENT()
Returns the "pathogen agent" feature. |
static Feature |
PHENOLOGY()
Returns the "phenology" feature. |
static Feature |
PROTOLOGUE()
Returns the "protologue" feature. |
Feature |
readCsvLine(Class<Feature> termClass,
List<String> csvLine,
Map<UUID,DefinedTermBase> terms)
Creates and returns a new feature instance on the basis of a given string list (containing an UUID, an URI, a label and a description) and a given language to be associated with the description. |
void |
removeRecommendedMeasurementUnit(MeasurementUnit recommendedMeasurementUnit)
Removes one element from the set of recommended statistical measures
assigned to this feature. |
void |
removeRecommendedModifierEnumeration(TermVocabulary<Modifier> recommendedModifierEnumeration)
Removes one element from the set of recommended modifier vocabularies
assigned to this feature. |
void |
removeRecommendedStatisticalMeasure(StatisticalMeasure recommendedStatisticalMeasure)
Removes one element from the set of recommended statistical measures
assigned to this feature. |
void |
removeSupportedCategoricalEnumeration(TermVocabulary<State> supportedCategoricalEnumeration)
Removes one element from the set of supported state vocabularies
assigned to this feature. |
void |
resetTerms()
|
protected void |
setDefaultTerms(TermVocabulary<Feature> termVocabulary)
|
protected void |
setGeneralizationOf(Set<Feature> value)
|
protected void |
setIncludes(Set<Feature> includes)
|
void |
setKindOf(Feature kindOf)
|
void |
setPartOf(Feature partOf)
|
void |
setSupportsCategoricalData(boolean supportsCategoricalData)
|
void |
setSupportsCommonTaxonName(boolean supportsCommonTaxonName)
|
void |
setSupportsDistribution(boolean supportsDistribution)
|
void |
setSupportsIndividualAssociation(boolean supportsIndividualAssociation)
|
void |
setSupportsQuantitativeData(boolean supportsQuantitativeData)
|
void |
setSupportsTaxonInteraction(boolean supportsTaxonInteraction)
|
void |
setSupportsTextData(boolean supportsTextData)
|
static Feature |
SPECIMEN()
|
static Feature |
STATUS()
The status of a taxon. |
static Feature |
SYSTEMATICS()
|
static Feature |
UNKNOWN()
Returns the "unknown" feature. |
static Feature |
USERECORD()
|
static Feature |
USES()
Returns the "uses" feature. |
| Methods inherited from class eu.etaxonomy.cdm.model.common.DefinedTermBase |
|---|
addGeneralizationOf, addIncludes, addMedia, clone, getByUuid, getMedia, getVocabulary, readCsvLine, removeGeneralization, removeIncludes, removeMedia, setVocabulary, writeCsvLine |
| 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.IDefinedTerm |
|---|
getUuid |
| 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 |
| Field Detail |
|---|
protected static Map<UUID,Feature> termMap
| Constructor Detail |
|---|
public Feature()
Feature(String, String, String)
protected Feature(String term,
String label,
String labelAbbrev)
default language),
a label and a label abbreviation.
term - the string (in the default language) describing the
new feature to be createdlabel - the string identifying the new feature to be createdlabelAbbrev - the string identifying (in abbreviated form) the
new feature to be createdFeature()| Method Detail |
|---|
public static Feature NewInstance()
NewInstance(String, String, String)
public static Feature NewInstance(String term,
String label,
String labelAbbrev)
default language),
a label and a label abbreviation.
term - the string (in the default language) describing the
new feature to be createdlabel - the string identifying the new feature to be createdlabelAbbrev - the string identifying (in abbreviated form) the
new feature to be created#readCsvLine(List, Language),
NewInstance()public void resetTerms()
resetTerms in class DefinedTermBase<Feature>public boolean isSupportsQuantitativeData()
quantitative data (true)
or not (false). If this flag is set this feature can only apply to
taxon descriptions or specimen descriptions.
public void setSupportsQuantitativeData(boolean supportsQuantitativeData)
isSupportsQuantitativeData()public boolean isSupportsTextData()
text data (true)
or not (false).
public void setSupportsTextData(boolean supportsTextData)
isSupportsTextData()public boolean isSupportsDistribution()
distribution objects
(true) or not (false). This flag is set if and only if this feature
is the distribution feature.
public void setSupportsDistribution(boolean supportsDistribution)
isSupportsDistribution()public boolean isSupportsIndividualAssociation()
individuals associations
(true) or not (false).
public void setSupportsIndividualAssociation(boolean supportsIndividualAssociation)
isSupportsIndividualAssociation()public boolean isSupportsTaxonInteraction()
taxon interactions
(true) or not (false).
public void setSupportsTaxonInteraction(boolean supportsTaxonInteraction)
isSupportsTaxonInteraction()public boolean isSupportsCommonTaxonName()
common names
(true) or not (false). This flag is set if and only if this feature
is the common name feature.
public void setSupportsCommonTaxonName(boolean supportsCommonTaxonName)
isSupportsTaxonInteraction()public boolean isSupportsCategoricalData()
categorical data
(true) or not (false).
public void setSupportsCategoricalData(boolean supportsCategoricalData)
#supportsCategoricalData()public Set<TermVocabulary<Modifier>> getRecommendedModifierEnumeration()
term vocabularies containing the
modifiers recommended to be used for description elements
with this feature.
public void addRecommendedModifierEnumeration(TermVocabulary<Modifier> recommendedModifierEnumeration)
term vocabulary (with modifiers) to the set of
recommended modifier vocabularies assigned
to this feature.
recommendedModifierEnumeration - the term vocabulary to be addedgetRecommendedModifierEnumeration()public void removeRecommendedModifierEnumeration(TermVocabulary<Modifier> recommendedModifierEnumeration)
recommended modifier vocabularies
assigned to this feature.
recommendedModifierEnumeration - the term vocabulary which should be removedgetRecommendedModifierEnumeration(),
addRecommendedModifierEnumeration(TermVocabulary)public Set<StatisticalMeasure> getRecommendedStatisticalMeasures()
statistical measures recommended to be used
in case of quantitative data with this feature.
public void addRecommendedStatisticalMeasure(StatisticalMeasure recommendedStatisticalMeasure)
statistical measure to the set of
recommended statistical measures assigned
to this feature.
recommendedStatisticalMeasure - the statistical measure to be addedgetRecommendedStatisticalMeasures()public void removeRecommendedStatisticalMeasure(StatisticalMeasure recommendedStatisticalMeasure)
recommended statistical measures
assigned to this feature.
recommendedStatisticalMeasure - the statistical measure which should be removedgetRecommendedStatisticalMeasures(),
addRecommendedStatisticalMeasure(StatisticalMeasure)public Set<MeasurementUnit> getRecommendedMeasurementUnits()
statistical measures recommended to be used
in case of quantitative data with this feature.
public void addRecommendedMeasurementUnit(MeasurementUnit recommendedMeasurementUnit)
statistical measure to the set of
recommended statistical measures assigned
to this feature.
recommendedStatisticalMeasure - the statistical measure to be addedgetRecommendedStatisticalMeasures()public void removeRecommendedMeasurementUnit(MeasurementUnit recommendedMeasurementUnit)
recommended statistical measures
assigned to this feature.
recommendedStatisticalMeasure - the statistical measure which should be removedgetRecommendedStatisticalMeasures(),
addRecommendedStatisticalMeasure(StatisticalMeasure)public Set<TermVocabulary<State>> getSupportedCategoricalEnumerations()
term vocabularies containing the list of
possible states to be used in categorical data
with this feature.
public void addSupportedCategoricalEnumeration(TermVocabulary<State> supportedCategoricalEnumeration)
term vocabulary to the set of
supported state vocabularies assigned
to this feature.
supportedCategoricalEnumeration - the term vocabulary which should be removedgetSupportedCategoricalEnumerations()public void removeSupportedCategoricalEnumeration(TermVocabulary<State> supportedCategoricalEnumeration)
supported state vocabularies
assigned to this feature.
supportedCategoricalEnumeration - the term vocabulary which should be removedgetSupportedCategoricalEnumerations(),
addSupportedCategoricalEnumeration(TermVocabulary)public Feature getKindOf()
IDefinedTermthis term
getKindOf in interface IDefinedTerm<Feature>getKindOf in class DefinedTermBase<Feature>public void setKindOf(Feature kindOf)
setKindOf in class DefinedTermBase<Feature>public Feature getPartOf()
IDefinedTermthis term
getPartOf in interface IDefinedTerm<Feature>getPartOf in class DefinedTermBase<Feature>public void setPartOf(Feature partOf)
setPartOf in class DefinedTermBase<Feature>public Set<Feature> getGeneralizationOf()
IDefinedTermthis term
getGeneralizationOf in interface IDefinedTerm<Feature>getGeneralizationOf in class DefinedTermBase<Feature>protected void setGeneralizationOf(Set<Feature> value)
setGeneralizationOf in class DefinedTermBase<Feature>public Set<Feature> getIncludes()
IDefinedTermthis term
getIncludes in interface IDefinedTerm<Feature>getIncludes in class DefinedTermBase<Feature>protected void setIncludes(Set<Feature> includes)
setIncludes in class DefinedTermBase<Feature>
public Feature readCsvLine(Class<Feature> termClass,
List<String> csvLine,
Map<UUID,DefinedTermBase> terms)
language to be associated with the description. Furthermore
the flags concerning the supported subclasses of description elements
are set according to a particular string belonging to the given
string list.DefinedTermBase.
readCsvLine in interface ILoadableTerm<Feature>readCsvLine in class DefinedTermBase<Feature>csvLine - the string list with elementary information for attributeslang - the language in which the description has been formulated
NewInstance(String, String, String)protected static Feature getTermByUuid(UUID uuid)
public static final Feature UNKNOWN()
description elements even if it is momentarily
not known what they mean.
public static final Feature DESCRIPTION()
description elements for a global description.
public static final Feature DISTRIBUTION()
distributions.
isSupportsDistribution()public static final Feature DISCUSSION()
text data.
isSupportsTextData()public static final Feature ECOLOGY()
specimen descriptions or to taxon descriptions.
public static final Feature HABITAT()
specimen descriptions or to taxon descriptions.
public static final Feature HABITAT_ECOLOGY()
specimen descriptions or to taxon descriptions.
public static final Feature BIOLOGY_ECOLOGY()
specimen descriptions or to taxon descriptions.
ECOLOGY()public static final Feature CHROMOSOME_NUMBER()
specimen descriptions or to taxon descriptions.
public static final Feature KEY()
public static final Feature MATERIALS_EXAMINED()
text data or eventually with categorical data
mentioning which material has been examined in order to accomplish
the description. This feature applies only to
specimen descriptions or to taxon descriptions.
public static final Feature MATERIALS_METHODS()
text data or eventually with categorical data
mentioning which methods have been adopted to analyze the material in
order to accomplish the description. This feature applies only to
specimen descriptions or to taxon descriptions.
public static final Feature ETYMOLOGY()
text data or eventually with categorical data
giving some information about the history of the taxon name. This feature applies only to
taxon name descriptions.
public static final Feature DIAGNOSIS()
text data or eventually with categorical data.
This feature applies only to specimen descriptions or to
taxon descriptions.
public static final Feature INTRODUCTION()
text data.
isSupportsTextData()public static final Feature PROTOLOGUE()
text data reproducing the content of the protologue
(or some information about it) of the taxon name. This feature applies only to
taxon name descriptions.
isSupportsTextData()public static final Feature COMMON_NAME()
common names.
isSupportsCommonTaxonName()public static final Feature PHENOLOGY()
categorical data or eventually with text data
containing information time about recurring natural phenomena.
This feature only applies to taxon descriptions.
public static final Feature OCCURRENCE()
public static final Feature ANATOMY()
public static final Feature HOSTPLANT()
public static final Feature PATHOGEN_AGENT()
public static final Feature CITATION()
text data.
isSupportsTextData()public static final Feature ADDITIONAL_PUBLICATION()
text data with information about a
publication where a taxon name has also been published
but which is not the nomenclatural reference.
This feature applies only to taxon name descriptions.
isSupportsTextData()public static final Feature USES()
taxon descriptions.
public static final Feature USERECORD()
public static final Feature CONSERVATION()
specimen descriptions and generalizes
methods and conditions for the conservation of specimens.
public static final Feature CULTIVATION()
public static final Feature IMAGE()
public static final Feature INDIVIDUALS_ASSOCIATION()
public static final Feature SPECIMEN()
public static final Feature OBSERVATION()
public static final Feature STATUS()
distribution.
If this is not possible for some reason (e.g. the area is not well defined) the status feature
may be used.
public static final Feature SYSTEMATICS()
public static final Feature HYBRID_PARENT()
taxon interactions.
Note: It must be distinguished between hybrid relationships as
relevant nomenclatural relationships between plant names
on the one side and the biological relation between two taxa
as it is here the case on the other one.
isSupportsTaxonInteraction(),
HybridRelationshipTypeprotected void setDefaultTerms(TermVocabulary<Feature> termVocabulary)
setDefaultTerms in class DefinedTermBase<Feature>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||