eu.etaxonomy.cdm.model.location
Class NamedAreaLevel

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<NamedAreaLevel>
                              eu.etaxonomy.cdm.model.location.NamedAreaLevel

All Implemented Interfaces:

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

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

Controlled vocabulary to differentiate levels of areas such as province, state, etc.

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

protected static Map<UUID,NamedAreaLevel>

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

	NamedAreaLevel() Constructor
protected	NamedAreaLevel(String term, String label, String labelAbbrev)

Method Summary

static NamedAreaLevel	COUNTRY()
protected static NamedAreaLevel	getTermByUuid(UUID uuid)
static boolean	isTDWG_LEVEL1(String str)
static boolean	isTDWG_LEVEL2(String str)
static boolean	isTDWG_LEVEL3(String str)
static boolean	isTDWG_LEVEL4(String str)
static NamedAreaLevel	NATURE_RESERVE()
static NamedAreaLevel	NewInstance() Factory method
static NamedAreaLevel	NewInstance(String term, String label, String labelAbbrev) Factory method
static NamedAreaLevel	PROVINCE()
void	resetTerms()
protected void	setDefaultTerms(TermVocabulary<NamedAreaLevel> termVocabulary)
static NamedAreaLevel	STATE()
static NamedAreaLevel	TDWG_LEVEL1() continents
static NamedAreaLevel	TDWG_LEVEL2() larger regions
static NamedAreaLevel	TDWG_LEVEL3() mostly countries
static NamedAreaLevel	TDWG_LEVEL4()
static NamedAreaLevel	TOWN()

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

Constructor Detail

NamedAreaLevel

public NamedAreaLevel()

Constructor

NamedAreaLevel

protected NamedAreaLevel(String term,
                         String label,
                         String labelAbbrev)

Method Detail

NewInstance

public static NamedAreaLevel NewInstance()

Factory method

Returns:

NewInstance

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

Factory method

Returns:

getTermByUuid

protected static NamedAreaLevel getTermByUuid(UUID uuid)

TDWG_LEVEL1

public static final NamedAreaLevel TDWG_LEVEL1()

continents

TDWG_LEVEL2

public static final NamedAreaLevel TDWG_LEVEL2()

larger regions

TDWG_LEVEL3

public static final NamedAreaLevel TDWG_LEVEL3()

mostly countries

TDWG_LEVEL4

public static final NamedAreaLevel TDWG_LEVEL4()

NATURE_RESERVE

public static final NamedAreaLevel NATURE_RESERVE()

STATE

public static final NamedAreaLevel STATE()

PROVINCE

public static final NamedAreaLevel PROVINCE()

TOWN

public static final NamedAreaLevel TOWN()

COUNTRY

public static final NamedAreaLevel COUNTRY()

isTDWG_LEVEL1

public static final boolean isTDWG_LEVEL1(String str)

isTDWG_LEVEL2

public static final boolean isTDWG_LEVEL2(String str)

isTDWG_LEVEL3

public static final boolean isTDWG_LEVEL3(String str)

isTDWG_LEVEL4

public static final boolean isTDWG_LEVEL4(String str)

resetTerms

public void resetTerms()

Specified by:

resetTerms in class DefinedTermBase<NamedAreaLevel>

setDefaultTerms

protected void setDefaultTerms(TermVocabulary<NamedAreaLevel> termVocabulary)

Specified by:

setDefaultTerms in class DefinedTermBase<NamedAreaLevel>