|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a relationship between two Concept
s or two
Atom
s.
Following is a UML Class diagram showing the neighborhood around Relationship
All data in a row of the MRREL
file is represented here.
Nested Class Summary |
Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement |
SourceElement.BySourceComparator, SourceElement.BySourceRestrictor |
Method Summary | |
void |
addAttribute(RelationshipAttribute att)
Adds the specified RelationshipAttribute . |
void |
clearAttributes()
Remove all RelationshipAttribute s. |
AdditionalRelationshipLabel |
getAdditionalRelationshipLabel()
Returns the AdditionalRelationshipLabel (RELA). |
RelationshipAttribute[] |
getAttributes()
Returns the RelationshipAttribute s. |
RelationshipAttribute[] |
getAttributes(Restrictor restrictor)
Returns a subset of this Relationship 's RelationshipAttribute s. |
List |
getAttributesAsList()
Returns the RelationshipAttribute s as a List . |
String |
getDir()
Returns the directionality value (DIR). |
String |
getKeyFields()
Returns a String key which can be used
by equals, compareTo, and hashCode methods. |
RelationshipLabel |
getRel()
Returns the RelationshipLabel (REL). |
AdditionalRelationshipLabel |
getRela()
Returns the AdditionalRelationshipLabel (RELA). |
String |
getRelationshipGroup()
Returns the relationship group (RG). |
String |
getRelationshipIdentifier()
Returns the Relationship unique identifier (RUI) related to this Relationship . |
RelationshipLabel |
getRelationshipLabel()
Returns the RelationshipLabel (REL). |
String |
getRg()
Returns the relationship group (RG). |
String |
getRui()
Shorthand for getRelationshipIdentifier() . |
Source |
getSl()
Returns the source of the relationship label (SL). |
Source |
getSourceOfLabel()
Returns the source of the relationship label (SL). |
String |
getSourceRelationshipIdentifier()
Returns the source asserted relationship identifier (SRUI). |
String |
getSrui()
Returns the source asserted relationship identifier (SRUI). |
boolean |
isAssertedDirection()
Indicates the directionality of this Relationship . |
void |
removeAttribute(RelationshipAttribute att)
Removes the specified RelationshipAttribute . |
void |
setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)
Sets the AdditionalRelationshipLabel (RELA). |
void |
setAttributes(List atts)
Replace RelationshipAttribute s with the ones in the specified List . |
void |
setAttributes(RelationshipAttribute[] atts)
Replace RelationshipAttribute s with the ones in the specified array. |
void |
setDir(String dir)
Sets the directionality value (DIR). |
void |
setIsAssertedDirection(boolean dir)
Sets the flag indicating the directionality of the Relationship . |
void |
setRel(RelationshipLabel rel)
Sets the RelationshipLabel (REL). |
void |
setRela(AdditionalRelationshipLabel rela)
Sets the AdditionalRelationshipLabel (RELA). |
void |
setRelationshipGroup(String rg)
Sets the relationship group (RG). |
void |
setRelationshipIdentifier(String rui)
Sets the Relationship unique identifier (RUI) related to this Relationship . |
void |
setRelationshipLabel(RelationshipLabel rel)
Sets the RelationshipLabel (REL). |
void |
setRg(String rg)
Sets the relationship group (RG). |
void |
setRui(String rui)
Shorthand for setRelationshipIdentifier(String) . |
void |
setSl(Source sl)
Sets the source of the relationship label (SL). |
void |
setSourceOfLabel(Source sl)
Sets the source of the relationship label (SL). |
void |
setSourceRelationshipIdentifier(String srui)
Sets the source asserted relationship identifier (SRUI). |
void |
setSrui(String srui)
Sets the source asserted relationship identifier (SRUI). |
Methods inherited from interface java.lang.Comparable |
compareTo |
Methods inherited from interface gov.nih.nlm.umls.meta.ConceptElement |
getConcept, setConcept |
Methods inherited from interface gov.nih.nlm.umls.meta.ContentViewElement |
getContentView, getCvf, setContentView, setCvf |
Methods inherited from interface gov.nih.nlm.umls.meta.RelatedConceptElement |
getRelatedConcept, setRelatedConcept |
Methods inherited from interface gov.nih.nlm.umls.meta.RelatedSourceIdentifierElement |
getRelatedSourceIdentifierType, setRelatedSourceIdentifierType |
Methods inherited from interface gov.nih.nlm.umls.meta.SourceElement |
getSource, setSource |
Methods inherited from interface gov.nih.nlm.umls.meta.SourceIdentifierElement |
getSourceIdentifierType, setSourceIdentifierType |
Methods inherited from interface gov.nih.nlm.umls.meta.SuppressibleElement |
getSuppress, isObsolete, isSuppressible, setSuppress |
Method Detail |
public RelationshipLabel getRelationshipLabel()
RelationshipLabel
(REL).
RelationshipLabel
public RelationshipLabel getRel()
RelationshipLabel
(REL).
This is shorthand for getRelationshipLabel()
.
RelationshipLabel
public void setRelationshipLabel(RelationshipLabel rel)
RelationshipLabel
(REL).
rel
- the RelationshipLabel
public void setRel(RelationshipLabel rel)
RelationshipLabel
(REL).
This is shorthand for setRelationshipLabel(RelationshipLabel)
.
rel
- the RelationshipLabel
public AdditionalRelationshipLabel getAdditionalRelationshipLabel()
AdditionalRelationshipLabel
(RELA).
AdditionalRelationshipLabel
public AdditionalRelationshipLabel getRela()
AdditionalRelationshipLabel
(RELA).
This is shorthand for getAdditionalRelationshipLabel()
.
AdditionalRelationshipLabel
public void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)
AdditionalRelationshipLabel
(RELA).
rela
- the AdditionalRelationshipLabel
public void setRela(AdditionalRelationshipLabel rela)
AdditionalRelationshipLabel
(RELA).
This is shorthand for
setAdditionalRelationshipLabel(AdditionalRelationshipLabel)
.
rela
- the AdditionalRelationshipLabel
public String getSourceRelationshipIdentifier()
public String getSrui()
getSourceRelationshipIdentifier()
.
public void setSourceRelationshipIdentifier(String srui)
srui
- the source asserted relationship identifierpublic void setSrui(String srui)
setSourceRelationshipIdentifier(String)
.
srui
- the source asserted relationship identifierpublic Source getSourceOfLabel()
public Source getSl()
getSourceOfLabel()
.
public void setSourceOfLabel(Source sl)
sl
- the source of the relationship labelpublic void setSl(Source sl)
setSourceOfLabel(Source)
.
sl
- the source of the relationship labelpublic String getRelationshipGroup()
public String getRg()
getRelationshipGroup()
.
public void setRelationshipGroup(String rg)
rg
- the relationship grouppublic void setRg(String rg)
getRelationshipGroup()
.
rg
- the relationship grouppublic void setDir(String dir)
dir
- the directionality valuepublic String getDir()
public boolean isAssertedDirection()
Relationship
.
true
if directionality is in order read,
false
if directionality is reversedpublic void setIsAssertedDirection(boolean dir)
Relationship
.
dir
- true
if directionality is in order read,
false
if directionality is reversedpublic String getRui()
getRelationshipIdentifier()
.
public void setRui(String rui)
setRelationshipIdentifier(String)
.
rui
- the RUIpublic String getRelationshipIdentifier()
Relationship
.
public void setRelationshipIdentifier(String rui)
Relationship
.
rui
- the RUIpublic String getKeyFields()
String
key which can be used
by equals, compareTo, and hashCode methods.
String
composed from key Relationship
fieldspublic RelationshipAttribute[] getAttributes()
RelationshipAttribute
s.
RelationshipAttribute
[]
public List getAttributesAsList()
RelationshipAttribute
s as a List
.
RelationshipAttribute
s as a List
public void addAttribute(RelationshipAttribute att)
RelationshipAttribute
.
att
- the RelationshipAttribute
to be addedpublic void removeAttribute(RelationshipAttribute att)
RelationshipAttribute
.
att
- the RelationshipAttribute
to be removedpublic void clearAttributes()
RelationshipAttribute
s.
public void setAttributes(RelationshipAttribute[] atts)
RelationshipAttribute
s with the ones in the specified array.
atts
- an RelationshipAttribute
[]
public void setAttributes(List atts)
RelationshipAttribute
s with the ones in the specified List
.
atts
- a List
of RelationshipAttribute
spublic RelationshipAttribute[] getAttributes(Restrictor restrictor)
Relationship
's RelationshipAttribute
s.
Restricts the return based on the given Restrictor
.
restrictor
- Restrictor
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |