@Entity @NamesWithHomotypicRelationshipsMustBelongToSameGroup(groups=Level3.class) @BasionymsMustShareEpithetsAndAuthors(groups=Level3.class) public class NameRelationship extends RelationshipBase<TaxonName,TaxonName,NameRelationshipType> implements IRuleConsidered
taxon names
according
to the nomenclatural code
which governs both of them.
This includes a name relationship type
(for instance "later homonym" or
"orthographic variant") and the article of the corresponding nomenclatural
code on which the assignation of the relationship type is based.
This class corresponds partially to:
RelationshipBase.Direction
annotations, markers
CLOB_LENGTH, uuid
Modifier | Constructor and Description |
---|---|
protected |
NameRelationship(TaxonName toName,
TaxonName fromName,
NameRelationshipType type,
Reference citation,
java.lang.String citationMicroReference,
java.lang.String ruleConsidered,
NomenclaturalCodeEdition codeEdition)
Class constructor: creates a new name relationship instance including
its
reference source and adds it to the respective
taxon name relation sets of both involved names. |
protected |
NameRelationship(TaxonName toName,
TaxonName fromName,
NameRelationshipType type,
java.lang.String ruleConsidered,
NomenclaturalCodeEdition codeEdition)
Class constructor: creates a new name relationship instance with no
reference and adds it to the respective
taxon name relation sets of both involved names. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clones this name relationship.
|
NomenclaturalCodeEdition |
getCodeEdition()
The
code edition for the rule considered . |
TaxonName |
getFromName()
Returns the
taxon name that plays the source role
in this taxon name relationship. |
protected TaxonName |
getRelatedFrom() |
protected TaxonName |
getRelatedTo() |
java.lang.String |
getRuleConsidered()
Returns the nomenclatural code rule considered (that is the
article/note/recommendation in the nomenclatural code ruling
the taxon name(s) of this nomenclatural status).
|
TaxonName |
getToName()
Returns the
taxon name that plays the target role
in this taxon name relationship. |
NameRelationshipType |
getType() |
void |
setCodeEdition(NomenclaturalCodeEdition codeEdition) |
protected void |
setRelatedFrom(TaxonName relatedFrom) |
protected void |
setRelatedTo(TaxonName relatedTo) |
void |
setRuleConsidered(java.lang.String ruleConsidered) |
void |
setType(NameRelationshipType type) |
isDoubtful, setDoubtful
equalsByShallowCompare, getCitation, getCitationMicroReference, getOriginalNameString, setCitation, setCitationMicroReference, setOriginalNameString
addAnnotation, addMarker, addMarker, getAnnotations, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker, setAnnotations
cloneLanguageString, 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, isBlank, isInstanceOf, isNotBlank, isPersited, 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, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid
protected NameRelationship(TaxonName toName, TaxonName fromName, NameRelationshipType type, java.lang.String ruleConsidered, NomenclaturalCodeEdition codeEdition)
taxon name relation sets
of both involved names.toName
- the taxon name to be set as target for the new name relationshipfromName
- the taxon name to be set as source for the new name relationshiptype
- the relationship type to be assigned to the new name relationshipruleConsidered
- the string indicating the article of the nomenclatural code for the new name relationshipcodeEdition
- the edition of the nomenclatural code where the ruleConsidered
has been published.#NameRelationship(TaxonName, TaxonName, NameRelationshipType, Reference, String, String)
,
TaxonName.addNameRelationship(NameRelationship)
,
TaxonName#addRelationshipFromName(TaxonName, NameRelationshipType, String)
,
TaxonName#addRelationshipToName(TaxonName, NameRelationshipType, String)
protected NameRelationship(TaxonName toName, TaxonName fromName, NameRelationshipType type, Reference citation, java.lang.String citationMicroReference, java.lang.String ruleConsidered, NomenclaturalCodeEdition codeEdition)
reference source
and adds it to the respective
taxon name relation sets
of both involved names.toName
- the taxon name to be set as target for the new name relationshipfromName
- the taxon name to be set as source for the new name relationshiptype
- the relationship type to be assigned to the new name relationshipcitation
- the reference source for the new name relationshipcitationMicroReference
- the string with the details describing the exact localisation within the referenceruleConsidered
- the string indicating the article of the nomenclatural code justifying the new name relationshipcodeEdition
- the edition of the nomenclatural code where the ruleConsidered
has been published.#NameRelationship(TaxonName, TaxonName, NameRelationshipType, String)
,
TaxonName.addNameRelationship(NameRelationship)
,
TaxonName#addRelationshipFromName(TaxonName, NameRelationshipType, String)
,
TaxonName#addRelationshipToName(TaxonName, NameRelationshipType, String)
public TaxonName getFromName()
taxon name
that plays the source role
in this taxon name relationship.getToName()
,
RelationshipBase.getRelatedFrom()
public TaxonName getToName()
taxon name
that plays the target role
in this taxon name relationship.getFromName()
,
RelationshipBase.getRelatedTo()
public java.lang.String getRuleConsidered()
name relationship type
has been
assigned to this name relation.getRuleConsidered
in interface IRuleConsidered
IRuleConsidered.getCodeEdition()
public void setRuleConsidered(java.lang.String ruleConsidered)
setRuleConsidered
in interface IRuleConsidered
getRuleConsidered()
public NomenclaturalCodeEdition getCodeEdition()
code edition
for the rule considered
.getCodeEdition
in interface IRuleConsidered
public void setCodeEdition(NomenclaturalCodeEdition codeEdition)
setCodeEdition
in interface IRuleConsidered
protected TaxonName getRelatedFrom()
getRelatedFrom
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
protected TaxonName getRelatedTo()
getRelatedTo
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
public NameRelationshipType getType()
getType
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
protected void setRelatedFrom(TaxonName relatedFrom)
setRelatedFrom
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
protected void setRelatedTo(TaxonName relatedTo)
setRelatedTo
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
public void setType(NameRelationshipType type)
setType
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
public java.lang.Object clone()
relatedFrom
and relatedTo
objects. The method is meant to be used
mainly for internal purposes (e.g. used within TaxonName.clone()
clone
in class RelationshipBase<TaxonName,TaxonName,NameRelationshipType>
RelationshipBase.clone()
,
Object.clone()
Copyright © 2007-2020 EDIT. All Rights Reserved.