eu.etaxonomy.cdm.model.taxon
Class SynonymRelationshipType

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.common.RelationshipTermBase<SynonymRelationshipType>
                                  eu.etaxonomy.cdm.model.taxon.SynonymRelationshipType

All Implemented Interfaces:

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

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

The class representing categories of synonym relationships (like "heterotypic synonym of").

A standard (ordered) list of synonym relationship type instances will be automatically created as the project starts. But this class allows to extend this standard list by creating new instances of additional synonym relationship types if needed.

This class corresponds in part to:

• TaxonRelationshipTerm according to the TDWG ontology
• RelationshipType according to the TCS

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

protected static Map<UUID,SynonymRelationshipType>	termMap
static UUID	uuidHeterotypicSynonymOf
static UUID	uuidHomotypicSynonymOf
static UUID	uuidInferredEpithetOf
static UUID	uuidInferredGenusOf
static UUID	uuidInferredSynonymOf
static UUID	uuidPotentialCombinationOf
static UUID	uuidSynonymOf

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

SynonymRelationshipType()
Class constructor: creates a new empty synonym relationship type instance.

SynonymRelationshipType(String term, String label, String labelAbbrev)
Class constructor: creates an additional synonym relationship type instance with a description (in the default language), a label and a label abbreviation.

Method Summary

protected static SynonymRelationshipType	getTermByUuid(UUID uuid)
static SynonymRelationshipType	HETEROTYPIC_SYNONYM_OF() Returns the synonym relationship type "is heterotypic synonym of" ("is taxonomic synonym of" in zoology).
static SynonymRelationshipType	HOMOTYPIC_SYNONYM_OF() Returns the synonym relationship type "is homotypic synonym of" ("is nomenclatural synonym of" in zoology).
static SynonymRelationshipType	INFERRED_EPITHET_OF() Returns the synonym relationship type "is inferred synonym of".
static SynonymRelationshipType	INFERRED_GENUS_OF() Returns the synonym relationship type "is inferred genus of".
static SynonymRelationshipType	INFERRED_SYNONYM_OF() Returns the synonym relationship type "is inferred synonym of".
static SynonymRelationshipType	POTENTIAL_COMBINATION_OF()
SynonymRelationshipType	readCsvLine(Class<SynonymRelationshipType> termClass, List<String> csvLine, Map<UUID,DefinedTermBase> terms) Fills the term with contents from a csvLine.
void	resetTerms()
protected void	setDefaultTerms(TermVocabulary<SynonymRelationshipType> termVocabulary)
static SynonymRelationshipType	SYNONYM_OF() Returns the synonym relationship type "is synonym of".

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

addInverseRepresentation, addRepresentation, clone, getInverseDescription, getInverseDescription, getInverseLabel, getInverseLabel, getInverseRepresentation, getInverseRepresentations, getPreferredInverseRepresentation, isSymmetric, isTransitive, removeInverseRepresentation, setSymmetric, setTransitive, writeCsvLine

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

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

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

uuidSynonymOf

public static final UUID uuidSynonymOf

uuidHomotypicSynonymOf

public static final UUID uuidHomotypicSynonymOf

uuidHeterotypicSynonymOf

public static final UUID uuidHeterotypicSynonymOf

uuidInferredSynonymOf

public static final UUID uuidInferredSynonymOf

uuidInferredGenusOf

public static final UUID uuidInferredGenusOf

uuidInferredEpithetOf

public static final UUID uuidInferredEpithetOf

uuidPotentialCombinationOf

public static final UUID uuidPotentialCombinationOf

Constructor Detail

SynonymRelationshipType

public SynonymRelationshipType()

Class constructor: creates a new empty synonym relationship type instance.

See Also:

SynonymRelationshipType(String, String, String)

SynonymRelationshipType

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

Class constructor: creates an additional synonym relationship type instance with a description (in the default language), a label and a label abbreviation. Synonym relationships types can be neither symmetric nor transitive.

Parameters:

term - the string (in the default language) describing the new synonym relationship type to be created

label - the string identifying the new synonym relationship type to be created

labelAbbrev - the string identifying (in abbreviated form) the new synonym relationship type to be created

See Also:

SynonymRelationshipType()

Method Detail

resetTerms

public void resetTerms()

Specified by:

resetTerms in class DefinedTermBase<SynonymRelationshipType>

getTermByUuid

protected static SynonymRelationshipType getTermByUuid(UUID uuid)

SYNONYM_OF

public static final SynonymRelationshipType SYNONYM_OF()

Returns the synonym relationship type "is synonym of". This indicates that the reference asserting the synonym relationship does not know whether both taxon names involved are typified by the same type or not.

See Also:

HOMOTYPIC_SYNONYM_OF(), HETEROTYPIC_SYNONYM_OF()

HOMOTYPIC_SYNONYM_OF

public static final SynonymRelationshipType HOMOTYPIC_SYNONYM_OF()

Returns the synonym relationship type "is homotypic synonym of" ("is nomenclatural synonym of" in zoology). This indicates that the the reference asserting the synonym relationship holds that the taxon name used as a synonym and the taxon name used as the ("accepted/correct") taxon are typified by the same type. In this case they should belong to the same homotypical group.

See Also:

HETEROTYPIC_SYNONYM_OF(), SYNONYM_OF()

HETEROTYPIC_SYNONYM_OF

public static final SynonymRelationshipType HETEROTYPIC_SYNONYM_OF()

Returns the synonym relationship type "is heterotypic synonym of" ("is taxonomic synonym of" in zoology). This indicates that the the reference asserting the synonym relationship holds that the taxon name used as a synonym and the taxon name used as the ("accepted/correct") taxon are not typified by the same type. In this case they should not belong to the same homotypical group.

See Also:

HOMOTYPIC_SYNONYM_OF(), SYNONYM_OF()

INFERRED_SYNONYM_OF

public static final SynonymRelationshipType INFERRED_SYNONYM_OF()

Returns the synonym relationship type "is inferred synonym of". This synonym relationship type is used in zoology whenever a synonymy relationship on species or infraspecific level is derived from a genus synonymy.

INFERRED_GENUS_OF

public static final SynonymRelationshipType INFERRED_GENUS_OF()

Returns the synonym relationship type "is inferred genus of". This synonym relationship type is used in zoology whenever a synonymy relationship on species or infraspecific level is derived from a epithet synonymy.

INFERRED_EPITHET_OF

public static final SynonymRelationshipType INFERRED_EPITHET_OF()

Returns the synonym relationship type "is inferred synonym of". This synonym relationship type is used in zoology whenever a synonymy relationship on species or infraspecific level is derived from a genus synonymy.

POTENTIAL_COMBINATION_OF

public static SynonymRelationshipType POTENTIAL_COMBINATION_OF()

readCsvLine

public SynonymRelationshipType readCsvLine(Class<SynonymRelationshipType> termClass,
                                           List<String> csvLine,
                                           Map<UUID,DefinedTermBase> terms)

Description copied from interface: ILoadableTerm

Fills the term with contents from a csvLine. If the csvLine represents the default language the csvLine attributes are merged into the existing default language and the default Language is returned.

Specified by:

readCsvLine in interface ILoadableTerm<SynonymRelationshipType>

Overrides:

readCsvLine in class RelationshipTermBase<SynonymRelationshipType>

Returns:

setDefaultTerms

protected void setDefaultTerms(TermVocabulary<SynonymRelationshipType> termVocabulary)

Specified by:

setDefaultTerms in class DefinedTermBase<SynonymRelationshipType>