eu.etaxonomy.cdm.model.description
Class PresenceTerm

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<IIdentifiableEntityCacheStrategy>
                  eu.etaxonomy.cdm.model.common.TermBase
                      eu.etaxonomy.cdm.model.common.DefinedTermBase<T>
                          eu.etaxonomy.cdm.model.common.OrderedTermBase<T>
                              eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase<PresenceTerm>
                                  eu.etaxonomy.cdm.model.description.PresenceTerm

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IDefinedTerm<PresenceTerm>, IIdentifiableEntity, ILoadableTerm<PresenceTerm>, ISourceable<IdentifiableSource>, IVersionableEntity, Serializable, Cloneable, Comparable<PresenceTerm>

@Entity
@Indexed(index="eu.etaxonomy.cdm.model.common.DefinedTermBase")
public class PresenceTerm
extends PresenceAbsenceTermBase<PresenceTerm>

This class represents terms describing different types of presence (like "native" or "introduced") of a taxon in a particular area.

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

protected static Map<UUID,PresenceTerm>

termMap

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

orderIndex

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

PresenceTerm()
Class constructor: creates a new empty presence term.

PresenceTerm(String term, String label, String labelAbbrev)
Class constructor: creates a new presence term with a description (in the default language), a label and a label abbreviation.

Method Summary

static PresenceTerm	CULTIVATED()
static PresenceTerm	ENDEMIC_FOR_THE_RELEVANT_AREA()
static PresenceTerm	getPresenceTermByAbbreviation(String abbrev)
protected static PresenceTerm	getTermByUuid(UUID uuid)
static PresenceTerm	INTRODUCED_ADVENTITIOUS()
static PresenceTerm	INTRODUCED_CULTIVATED()
static PresenceTerm	INTRODUCED_DOUBTFULLY_INTRODUCED()
static PresenceTerm	INTRODUCED_NATURALIZED()
static PresenceTerm	INTRODUCED_PRESENCE_QUESTIONABLE()
static PresenceTerm	INTRODUCED_UNCERTAIN_DEGREE_OF_NATURALISATION()
static PresenceTerm	INTRODUCED()
static PresenceTerm	INVASIVE()
static PresenceTerm	NATIVE_DOUBTFULLY_NATIVE()
static PresenceTerm	NATIVE_PRESENCE_QUESTIONABLE()
static PresenceTerm	NATIVE()
static PresenceTerm	NATURALISED()
static PresenceTerm	NewInstance() Creates a new empty presence term.
static PresenceTerm	NewInstance(String term, String label, String labelAbbrev) Creates a new presence term with a description (in the default language), a label and a label abbreviation.
static PresenceTerm	PRESENT_DOUBTFULLY()
static PresenceTerm	PRESENT()
void	resetTerms()
protected void	setDefaultTerms(TermVocabulary<PresenceTerm> termVocabulary)

Methods inherited from class eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase

getDefaultColor, readCsvLine, setDefaultColor

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

clone, compareTo, decreaseIndex, equals, getOrderIndex, incrementIndex, isHigher, isLower, performCompareTo

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

addGeneralizationOf, addIncludes, addMedia, getByUuid, getGeneralizationOf, getIncludes, getKindOf, getMedia, getPartOf, getVocabulary, readCsvLine, removeGeneralization, removeIncludes, removeMedia, setGeneralizationOf, setIncludes, setKindOf, setPartOf, setVocabulary, writeCsvLine

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

addRepresentation, 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, regenerateTitleCache, 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, instanceToString, 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

termMap

protected static Map<UUID,PresenceTerm> termMap

Constructor Detail

PresenceTerm

public PresenceTerm()

Class constructor: creates a new empty presence term.

See Also:

PresenceTerm(String, String, String)

PresenceTerm

public PresenceTerm(String term,
                    String label,
                    String labelAbbrev)

Class constructor: creates a new presence term with a description (in the default language), a label and a label abbreviation.

Parameters:

term - the string (in the default language) describing the new presence term to be created

label - the string identifying the new presence term to be created

labelAbbrev - the string identifying (in abbreviated form) the new presence term to be created

See Also:

PresenceTerm()

Method Detail

NewInstance

public static PresenceTerm NewInstance()

Creates a new empty presence term.

See Also:

NewInstance(String, String, String)

NewInstance

public static PresenceTerm NewInstance(String term,
                                       String label,
                                       String labelAbbrev)

Creates a new presence term with a description (in the default language), a label and a label abbreviation.

Parameters:

term - the string (in the default language) describing the new presence term to be created

label - the string identifying the new presence term to be created

labelAbbrev - the string identifying (in abbreviated form) the new presence term to be created

See Also:

NewInstance()

getTermByUuid

protected static PresenceTerm getTermByUuid(UUID uuid)

PRESENT

public static final PresenceTerm PRESENT()

PRESENT_DOUBTFULLY

public static final PresenceTerm PRESENT_DOUBTFULLY()

CULTIVATED

public static final PresenceTerm CULTIVATED()

ENDEMIC_FOR_THE_RELEVANT_AREA

public static final PresenceTerm ENDEMIC_FOR_THE_RELEVANT_AREA()

INTRODUCED

public static final PresenceTerm INTRODUCED()

INTRODUCED_ADVENTITIOUS

public static final PresenceTerm INTRODUCED_ADVENTITIOUS()

INTRODUCED_CULTIVATED

public static final PresenceTerm INTRODUCED_CULTIVATED()

INTRODUCED_DOUBTFULLY_INTRODUCED

public static final PresenceTerm INTRODUCED_DOUBTFULLY_INTRODUCED()

INTRODUCED_NATURALIZED

public static final PresenceTerm INTRODUCED_NATURALIZED()

INTRODUCED_PRESENCE_QUESTIONABLE

public static final PresenceTerm INTRODUCED_PRESENCE_QUESTIONABLE()

INTRODUCED_UNCERTAIN_DEGREE_OF_NATURALISATION

public static final PresenceTerm INTRODUCED_UNCERTAIN_DEGREE_OF_NATURALISATION()

NATIVE

public static final PresenceTerm NATIVE()

NATIVE_DOUBTFULLY_NATIVE

public static final PresenceTerm NATIVE_DOUBTFULLY_NATIVE()

NATIVE_PRESENCE_QUESTIONABLE

public static final PresenceTerm NATIVE_PRESENCE_QUESTIONABLE()

INVASIVE

public static final PresenceTerm INVASIVE()

NATURALISED

public static final PresenceTerm NATURALISED()

getPresenceTermByAbbreviation

public static PresenceTerm getPresenceTermByAbbreviation(String abbrev)

resetTerms

public void resetTerms()

Specified by:

resetTerms in class DefinedTermBase<PresenceTerm>

setDefaultTerms

protected void setDefaultTerms(TermVocabulary<PresenceTerm> termVocabulary)

Specified by:

setDefaultTerms in class DefinedTermBase<PresenceTerm>