gov.nih.nlm.umls.meta
Interface ContextMember

All Superinterfaces:

Comparable, RelatedAtomElement, RelatedConceptElement

All Known Implementing Classes:

ContextMemberImpl

public interface ContextMember
extends Comparable, RelatedAtomElement, RelatedConceptElement

Represents information about ancestors, children, or siblings in a hierarchy.

Following is a UML Class diagram showing the neighborhood around ContextMember

Some data in MRCXT is represented here.

Author:

Brian Carlsen, Deborah Shapiro

See Also:

Context, SourceContext

Method Summary

AdditionalRelationshipLabel	getAdditionalRelationshipLabel() Returns the AdditionalRelationshipLabel (RELA) from the context member to its parent.
String	getCxl() Returns the label for this ContextMember (CXL).
String	getHcd() Returns the hierarchical code (HCD).
String	getHierarchicalCode() Returns the hierarchical code (HCD).
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
String	getLabel() Returns the label for this ContextMember (CXL).
int	getRank() Returns the rank (RNK) if the member is an ancestor.
AdditionalRelationshipLabel	getRela() Returns the AdditionalRelationshipLabel (RELA) from the context member to its parent.
String	getXc() Returns the "has child flag" value (XC).
boolean	hasChild() Indicates whether or not this context member has children.
void	setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela) Sets the AdditionalRelationshipLabel (RELA) from the context member to its parent.
void	setCxl(String cxl) Sets the label for this ContextMember (CXL).
void	setHasChild(boolean xc) Sets the flag indicating whether or not this ContextMember has a child.
void	setHcd(String hcd) Sets the hierarchical code (HCD).
void	setHierarchicalCode(String hcd) Sets the hierarchical code (HCD).
void	setLabel(String cxl) Sets the label for this ContextMember.
void	setRank(int rnk) Sets the rank (RNK) if the member is an ancestor
void	setRela(AdditionalRelationshipLabel rela) Sets the AdditionalRelationshipLabel (RELA) from the context member to its parent.
void	setXc(String xc) Sets the "has child flag" value (XC).

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface gov.nih.nlm.umls.meta.RelatedAtomElement

getRelatedAtom, setRelatedAtom

Methods inherited from interface gov.nih.nlm.umls.meta.RelatedConceptElement

getRelatedConcept, setRelatedConcept

Method Detail

getRank

int getRank()

Returns the rank (RNK) if the member is an ancestor.

Returns:

the int rank

setRank

void setRank(int rnk)

Sets the rank (RNK) if the member is an ancestor

Parameters:

rnk - the int rank

getHierarchicalCode

String getHierarchicalCode()

Returns the hierarchical code (HCD).

Returns:

the hierarchical code

getHcd

String getHcd()

Returns the hierarchical code (HCD). This is shorthand for getHierarchicalCode().

Returns:

the hierarchical code

setHierarchicalCode

void setHierarchicalCode(String hcd)

Sets the hierarchical code (HCD).

Parameters:

hcd - the hierarchical code

setHcd

void setHcd(String hcd)

Sets the hierarchical code (HCD). This is shorthand for setHierarchicalCode(String).

Parameters:

hcd - the hierarchical code

getAdditionalRelationshipLabel

AdditionalRelationshipLabel getAdditionalRelationshipLabel()

Returns the AdditionalRelationshipLabel (RELA) from the context member to its parent.

Returns:

the AdditionalRelationshipLabel

getRela

AdditionalRelationshipLabel getRela()

Returns the AdditionalRelationshipLabel (RELA) from the context member to its parent. This is shorthand for getAdditionalRelationshipLabel().

Returns:

the AdditionalRelationshipLabel

setAdditionalRelationshipLabel

void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)

Sets the AdditionalRelationshipLabel (RELA) from the context member to its parent.

Parameters:

rela - the AdditionalRelationshipLabel

setRela

void setRela(AdditionalRelationshipLabel rela)

Sets the AdditionalRelationshipLabel (RELA) from the context member to its parent. This is shorthand for setAdditionalRelationshipLabel(AdditionalRelationshipLabel).

Parameters:

rela - the AdditionalRelationshipLabel

getXc

String getXc()

Returns the "has child flag" value (XC).

Returns:

the "has child flag" value

setXc

void setXc(String xc)

Sets the "has child flag" value (XC).

Parameters:

xc - the "has child flag" value

hasChild

boolean hasChild()

Indicates whether or not this context member has children.

Returns:

true if ContextMember has a child, false if ContextMember does not have a child

setHasChild

void setHasChild(boolean xc)

Sets the flag indicating whether or not this ContextMember has a child.

Parameters:

xc - true if ContextMember has a child, false if ContextMember does not have a child

getLabel

String getLabel()

Returns the label for this ContextMember (CXL).

Returns:

the label for this ContextMember

getCxl

String getCxl()

Returns the label for this ContextMember (CXL). This is shorthand for getLabel().

Returns:

the label for this ContextMember

setLabel

void setLabel(String cxl)

Sets the label for this ContextMember.

Parameters:

cxl - label

setCxl

void setCxl(String cxl)

Sets the label for this ContextMember (CXL). This is shorthand for setLabel(String).

Parameters:

cxl - the label for this ContextMember

getKeyFields

String getKeyFields()

Returns a String key which can be used by equals, compareTo, and hashCode methods.

Returns:

a String composed from key ContextMember fields