|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a context associated with a source and a string identifier.
A StringContext
will have a number of SourceContext
s
associated with it. The context number differentiates between
contexts within the same string and source.
Following is a UML Class diagram showing the neighborhood around SourceContext
StringContext
Nested Class Summary |
Nested classes inherited from class gov.nih.nlm.umls.meta.AtomElement |
AtomElement.ByLanguageRestrictor, AtomElement.BySourceRestrictor |
Method Summary | |
void |
addContextMember(ContextMember cm)
Adds the specified ContextMember . |
void |
clearContextMembers()
Removes all ContextMember s. |
ContextMember[] |
getAncestorMembers()
Returns only the ContextMember s that have the context
member label (CXL) of "ANC" or self. |
List |
getAncestorMembersAsList()
Returns only the ContextMember s that have the context
member label (CXL) of "ANC" or self. |
ContextMember[] |
getChildMembers()
Returns only the ContextMember s that have the context
member label (CXL) of "CHD" or child. |
List |
getChildMembersAsList()
Returns only the ContextMember s that have the context
member label (CXL) of "CHD" or child. |
ContextMember[] |
getContextMembers()
Returns the ContextMember s. |
List |
getContextMembersAsList()
Returns the ContextMember s. |
int |
getContextNumber()
Returns the context number (CXN). |
int |
getCxn()
Returns the context number (CXN). |
String |
getKeyFields()
Returns a String key which can be used
by equals, compareTo, and hashCode methods. |
String |
getParentAtomIdentifier()
Returns the parent atom identifier (PAUI). |
String[] |
getPathToRoot()
Returns the path to the root (PTR) as a String []
of AUI values. |
List |
getPathToRootAsList()
Returns the path to the root (PTR) as a List of AUI values. |
String |
getPathToRootAsString()
Returns the path to the root (PTR) as a "." separated list of AUI values. |
String |
getPaui()
Returns the parent atom identifier (PAUI). |
String |
getPtr()
Returns the path to the root (PTR) as a "." separated list of AUI values. |
ContextMember[] |
getSelfMembers()
Returns only the ContextMember s that have the context
member label (CXL) of "CCP" or self. |
List |
getSelfMembersAsList()
Returns only the ContextMember s that have the context
member label (CXL) of "CCP" or self. |
ContextMember[] |
getSiblingMembers()
Returns only the ContextMember s that have the context
member label (CXL) of "SIB" or self. |
List |
getSiblingMembersAsList()
Returns only the ContextMember s that have the context
member label (CXL) of "SIB" or self. |
StringContext |
getStringContext()
Returns the StringContext that holds this SourceContext . |
void |
removeContextMember(ContextMember cm)
Removes the specified ContextMember . |
void |
setContextMembers(ContextMember[] cms)
Set the ContextMember s with the ones in the specified array. |
void |
setContextMembers(List cms)
Set the ContextMember s with the ones in the specified List . |
void |
setContextNumber(int cxn)
Sets the context number (CXN). |
void |
setCxn(int cxn)
Sets the context number (CXN). |
void |
setParentAtomIdentifier(String paui)
Sets the parent atom identifier (PAUI). |
void |
setPathToRoot(String ptr)
Sets the path to the root (PTR) as a "." separated list of AUI values. |
void |
setPaui(String paui)
Sets the parent atom identifier (PAUI). |
void |
setPtr(String ptr)
Sets the path to the root (PTR) as a "." separated list of AUI values. |
void |
setStringContext(StringContext sc)
Sets the StringContext that holds this SourceContext . |
Methods inherited from interface gov.nih.nlm.umls.meta.AtomElement |
getAtom, setAtom |
Methods inherited from interface java.lang.Comparable |
compareTo |
Methods inherited from interface gov.nih.nlm.umls.meta.ContentViewElement |
getContentView, getCvf, setContentView, setCvf |
Method Detail |
public int getContextNumber()
int
context numberpublic void setContextNumber(int cxn)
cxn
- the int
context numberpublic int getCxn()
getContextNumber()
int
public void setCxn(int cxn)
setContextNumber(int)
.
cxn
- int
context numberpublic String getPaui()
getParentAtomIdentifier()
.
public void setPaui(String paui)
setParentAtomIdentifier(String)
.
paui
- the PAUIpublic String getParentAtomIdentifier()
public void setParentAtomIdentifier(String paui)
paui
- the PAUIpublic String getPathToRootAsString()
public List getPathToRootAsList()
List
of AUI values.
List
of AUI valuespublic String[] getPathToRoot()
String
[]
of AUI values.
String
[]
of AUI valuespublic String getPtr()
getPathToRootAsString()
.
public void setPathToRoot(String ptr)
ptr
- the path to the rootpublic void setPtr(String ptr)
setPathToRoot(String)
.
ptr
- the path to the rootpublic ContextMember[] getContextMembers()
ContextMember
s. These are the ancestors,
children, and siblings.
ContextMember
spublic List getContextMembersAsList()
ContextMember
s. These are the ancestors,
children, and siblings.
ContextMember
spublic void addContextMember(ContextMember cm)
ContextMember
.
cm
- the ContextMember
to be addedpublic void removeContextMember(ContextMember cm)
ContextMember
.
cm
- the ContextMember
to be removedpublic void clearContextMembers()
ContextMember
s.
public void setContextMembers(ContextMember[] cms)
ContextMember
s with the ones in the specified array.
cms
- a ContextMember
[]
public void setContextMembers(List cms)
ContextMember
s with the ones in the specified List
.
cms
- a List
of ContextMember
spublic ContextMember[] getSelfMembers()
ContextMember
s that have the context
member label (CXL) of "CCP" or self.
ContextMember
[] of members with label "CCP"public List getSelfMembersAsList()
ContextMember
s that have the context
member label (CXL) of "CCP" or self.
List
of members with label "CCP"public ContextMember[] getChildMembers()
ContextMember
s that have the context
member label (CXL) of "CHD" or child.
ContextMember
[] of members with label "CHD"public List getChildMembersAsList()
ContextMember
s that have the context
member label (CXL) of "CHD" or child.
ContextMember
[] of members with label "CHD"public ContextMember[] getAncestorMembers()
ContextMember
s that have the context
member label (CXL) of "ANC" or self.
ContextMember
[] of members with label "ANC"public List getAncestorMembersAsList()
ContextMember
s that have the context
member label (CXL) of "ANC" or self.
ContextMember
[] of members with label "ANC"public ContextMember[] getSiblingMembers()
ContextMember
s that have the context
member label (CXL) of "SIB" or self.
ContextMember
[] of members with label "SIB"public List getSiblingMembersAsList()
ContextMember
s that have the context
member label (CXL) of "SIB" or self.
ContextMember
[] of members with label "SIB"public StringContext getStringContext()
StringContext
that holds this SourceContext
.
StringContext
that holds this SourceContext
public void setStringContext(StringContext sc)
StringContext
that holds this SourceContext
.
sc
- the StringContext
that holds this SourceContext
public String getKeyFields()
String
key which can be used
by equals, compareTo, and hashCode methods.
String
composed from key SourceContext
fields
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |