@Entity @HomotypicSynonymsShouldBelongToGroup(groups=Level3.class) public class SynonymRelationship extends RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
synonym
to an
("accepted/correct") taxon
. This includes a synonym relationship type
(for instance "heterotypic synonym of"). Within a synonym relationship the
synonym plays the source role and the taxon the target role. Between a
synonym and an ("accepted/correct") taxon there should exist at most one
synonym relationship.concept reference
.
This class corresponds in part to:
RelationshipBase.Direction
annotations, markers
Modifier | Constructor and Description |
---|---|
protected |
SynonymRelationship(Synonym synonym,
Taxon taxon,
SynonymRelationshipType type,
Reference citation,
String citationMicroReference)
Class constructor: creates a new synonym relationship instance (with the
given
synonym , the given "accepted/correct" taxon ,
the given synonym relationship type and with the
reference source on which the relationship assertion is based). |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clones this SynonymRelationship.
|
Taxon |
getAcceptedTaxon()
Returns the ("accepted/correct")
taxon involved in this
synonym relationship. |
protected Synonym |
getRelatedFrom() |
protected Taxon |
getRelatedTo() |
Synonym |
getSynonym()
Returns the
synonym involved in this synonym
relationship. |
SynonymRelationshipType |
getType() |
boolean |
isPartial()
Returns "true" if the ProParte flag is set.
|
boolean |
isProParte()
Returns "true" if the ProParte flag is set.
|
void |
setAcceptedTaxon(Taxon acceptedTaxon)
Sets the given ("accepted/valid")
taxon to this
synonym relationship. |
void |
setPartial(boolean partial) |
void |
setProParte(boolean proParte) |
protected void |
setRelatedFrom(Synonym relatedFrom) |
protected void |
setRelatedTo(Taxon relatedTo) |
void |
setSynonym(Synonym synonym)
Sets the given
synonym to this synonym relationship. |
void |
setType(SynonymRelationshipType type) |
isDoubtful, isRemoved, setDoubtful
equalsByShallowCompare, getCitation, getCitationMicroReference, getOriginalNameString, setCitation, setCitationMicroReference, setOriginalNameString
addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker
equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
addPropertyChangeListener, addPropertyChangeListener, addToSetWithChangeEvent, deproxy, deproxy, fireOnCreateEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUserFriendlyDescription, getUserFriendlyFieldName, getUserFriendlyTypeName, getUuid, hashCode, hasListeners, initListener, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid, toString
finalize, getClass, notify, notifyAll, wait, wait, wait
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid
protected SynonymRelationship(Synonym synonym, Taxon taxon, SynonymRelationshipType type, Reference citation, String citationMicroReference)
synonym
, the given "accepted/correct" taxon
,
the given synonym relationship type
and with the
reference source
on which the relationship assertion is based).
Moreover the new synonym relationship will be added to the respective
sets of synonym relationships assigned to the synonym and to the
"accepted/correct" taxon.synonym
- the synonym instance involved in the new synonym relationshiptaxon
- the taxon instance involved in the new synonym relationshiptype
- the synonym relationship type of the new synonym relationshipcitation
- the reference source for the new synonym relationshipcitationMicroReference
- the string with the details describing the exact localisation within the referenceRelationshipBase.RelationshipBase(IRelated, IRelated, RelationshipTermBase, Reference, String)
public boolean isProParte()
taxon name
used as a
synonym
designated originally a real taxon which later has
been split. In this case the synonym is therefore the synonym of at least
two different ("accepted/correct") taxa
and at least one
more synonym relationship with the same synonym should exist.public void setProParte(boolean proParte)
isProParte()
public boolean isPartial()
taxon name
used as a
synonym
designated originally a real taxon which later has
been lumped together with another one. In this case the
("accepted/correct") taxon
has therefore at least
two different synonyms (for the two lumped real taxa) and at least one
more synonym relationship with the same ("accepted/correct") taxon should
exist.public void setPartial(boolean partial)
isPartial()
public Taxon getAcceptedTaxon()
taxon
involved in this
synonym relationship. The taxon plays the target role in the relationship.public void setAcceptedTaxon(Taxon acceptedTaxon)
taxon
to this
synonym relationship. Therefore this synonym relationship will be
added to the corresponding set of synonym relationships assigned to the
given taxon.acceptedTaxon
- the taxon instance to be set in this synonym relationshipgetAcceptedTaxon()
,
Taxon.getSynonymRelations()
public Synonym getSynonym()
synonym
involved in this synonym
relationship. The synonym plays the source role in the relationship.public void setSynonym(Synonym synonym)
synonym
to this synonym relationship.
Therefore this synonym relationship will be
added to the corresponding set of synonym relationships assigned to the
given synonym. Furthermore if the given synonym replaces an "old" one
this synonym relationship will be removed from the set of synonym
relationships assigned to the "old" synonym.synonym
- the synonym instance to be set in this synonym relationshipgetSynonym()
,
Synonym.getSynonymRelations()
protected Synonym getRelatedFrom()
getRelatedFrom
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
protected Taxon getRelatedTo()
getRelatedTo
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
public SynonymRelationshipType getType()
getType
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
protected void setRelatedFrom(Synonym relatedFrom)
setRelatedFrom
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
protected void setRelatedTo(Taxon relatedTo)
setRelatedTo
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
public void setType(SynonymRelationshipType type)
setType
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
public Object clone()
clone
in class RelationshipBase<Synonym,Taxon,SynonymRelationshipType>
RelationshipBase.clone()
,
Object.clone()
Copyright © 2007-2016 EDIT. All Rights Reserved.