eu.etaxonomy.cdm.model.description
Class Modifier

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<Modifier>
                              eu.etaxonomy.cdm.model.description.Modifier

All Implemented Interfaces:

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

Direct Known Subclasses:

DeterminationModifier, Scope

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

This class represents possible modulations for the validity of information pieces (DescriptionElementBase description elements). It can cover probability ("perhaps"), frequency ("often") intensity ("very"), timing ("spring") and other domains. Its instances can be grouped to build different controlled term vocabularies.

This class corresponds to GeneralModifierNLDType according to the SDD schema.

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

protected static Map<UUID,Modifier>

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

Modifier()
Class constructor: creates a new empty modifier instance.

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

Method Summary

static Modifier	NewInstance() Creates a new empty modifier instance.
static Modifier	NewInstance(String term, String label, String labelAbbrev)
void	resetTerms()
protected void	setDefaultTerms(TermVocabulary<Modifier> termVocabulary)

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, 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,Modifier> termMap

Constructor Detail

Modifier

public Modifier()

Class constructor: creates a new empty modifier instance.

See Also:

Modifier(String, String, String)

Modifier

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

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

Parameters:

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

label - the string identifying the new modifier to be created

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

See Also:

Modifier()

Method Detail

NewInstance

public static Modifier NewInstance()

Creates a new empty modifier instance.

See Also:

Modifier(String, String, String)

NewInstance

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

resetTerms

public void resetTerms()

Specified by:

resetTerms in class DefinedTermBase<Modifier>

setDefaultTerms

protected void setDefaultTerms(TermVocabulary<Modifier> termVocabulary)

Specified by:

setDefaultTerms in class DefinedTermBase<Modifier>