is represented here.
- Author:
- Brian Carlsen, Deborah Shapiro
getContextNumber
public int getContextNumber()
- Returns the context number (CXN).
- Returns:
- the
int
context number
setContextNumber
public void setContextNumber(int cxn)
- Sets the context number (CXN).
- Parameters:
cxn
- the int
context number
getCxn
public int getCxn()
- Returns the context number (CXN).
This is a shorthand for
getContextNumber()
- Returns:
- cxn context number
int
setCxn
public void setCxn(int cxn)
- Sets the context number (CXN).
This is shorthand for
setContextNumber(int)
.
- Parameters:
cxn
- int
context number
getPaui
public String getPaui()
- Returns the parent atom identifier (PAUI).
This is shorthand for
getParentAtomIdentifier()
.
- Returns:
- the PAUI
setPaui
public void setPaui(String paui)
- Sets the parent atom identifier (PAUI).
This is shorthand for
setParentAtomIdentifier(String)
.
- Parameters:
paui
- the PAUI
getParentAtomIdentifier
public String getParentAtomIdentifier()
- Returns the parent atom identifier (PAUI).
- Returns:
- the PAUI
setParentAtomIdentifier
public void setParentAtomIdentifier(String paui)
- Sets the parent atom identifier (PAUI).
- Parameters:
paui
- the PAUI
getPathToRootAsString
public String getPathToRootAsString()
- Returns the path to the root (PTR) as a "." separated list of AUI values.
- Returns:
- the path to the root
getPathToRootAsList
public List getPathToRootAsList()
- Returns the path to the root (PTR) as a
List
of AUI values.
- Returns:
- the path to the root as a
List
of AUI values
getPathToRoot
public String[] getPathToRoot()
- Returns the path to the root (PTR) as a
String
[]
of AUI values.
- Returns:
- the path to the root as a
String
[]
of AUI values
getPtr
public String getPtr()
- Returns the path to the root (PTR) as a "." separated list of AUI values.
This is shorthand for
getPathToRootAsString()
.
- Returns:
- the path to the root
setPathToRoot
public void setPathToRoot(String ptr)
- Sets the path to the root (PTR) as a "." separated list of AUI values.
- Parameters:
ptr
- the path to the root
setPtr
public void setPtr(String ptr)
- Sets the path to the root (PTR) as a "." separated list of AUI values.
This is shorthand for
setPathToRoot(String)
.
- Parameters:
ptr
- the path to the root
getContextMembers
public ContextMember[] getContextMembers()
- Returns all
ContextMember
s. These are the ancestors,
children, and siblings.
- Returns:
- a sorted array of
ContextMember
s
getContextMembersAsList
public List getContextMembersAsList()
- Returns all
ContextMember
s as a List
. These are the ancestors,
children, and siblings.
- Returns:
- a sorted
List
of ContextMember
s
addContextMember
public void addContextMember(ContextMember cm)
- Adds the specified
ContextMember
.
- Parameters:
cm
- the ContextMember
to be added
removeContextMember
public void removeContextMember(ContextMember cm)
- Removes the specified
ContextMember
.
- Parameters:
cm
- the ContextMember
to be removed
clearContextMembers
public void clearContextMembers()
- Removes all
ContextMember
s.
setContextMembers
public void setContextMembers(ContextMember[] cms)
- Replaces the
ContextMember
s with the ones in the specified array.
- Parameters:
cms
- a ContextMember
[]
setContextMembers
public void setContextMembers(List cms)
- Replaces the
ContextMember
s with the ones in the specified List
.
- Parameters:
cms
- a List
of ContextMember
s
getHierarchicalCode
public String getHierarchicalCode()
- Returns the hierarchical code (HCD).
- Returns:
- the hierarchical code
getHcd
public String getHcd()
- Returns the hierarchical code (HCD).
This is shorthand for
getHierarchicalCode()
.
- Returns:
- the hierarchical code
setHierarchicalCode
public void setHierarchicalCode(String hcd)
- Sets the hierarchical code (HCD).
- Parameters:
hcd
- the hierarchical code
setHcd
public void setHcd(String hcd)
- Sets the hierarchical code (HCD).
This is shorthand for
setHierarchicalCode(String)
.
- Parameters:
hcd
- the hierarchical code
getAdditionalRelationshipLabel
public AdditionalRelationshipLabel getAdditionalRelationshipLabel()
- Returns the
AdditionalRelationshipLabel
(RELA) from the context member to its parent.
- Returns:
- the
AdditionalRelationshipLabel
getRela
public AdditionalRelationshipLabel getRela()
- Returns the
AdditionalRelationshipLabel
(RELA) from the context member to its parent.
This is shorthand for getAdditionalRelationshipLabel()
.
- Returns:
- the
AdditionalRelationshipLabel
setAdditionalRelationshipLabel
public void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)
- Sets the
AdditionalRelationshipLabel
(RELA) from the context member to its parent.
- Parameters:
rela
- the AdditionalRelationshipLabel
setRela
public 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
getSelfMember
public ContextMember getSelfMember()
- Returns the
ContextMember
that has the context
member label (CXL) of "CCP" or self.
- Returns:
ContextMember
with label "CCP"
getChildMembers
public ContextMember[] getChildMembers()
- Returns only the
ContextMember
s that have the context
member label (CXL) of "CHD" or child.
- Returns:
ContextMember
[] of members with label "CHD"
getChildMembersAsList
public List getChildMembersAsList()
- Returns only the
ContextMember
s that have the context
member label (CXL) of "CHD" or child.
- Returns:
ContextMember
[] of members with label "CHD"
getAncestorMembers
public ContextMember[] getAncestorMembers()
- Returns only the
ContextMember
s that have the context
member label (CXL) of "ANC" or self.
- Returns:
ContextMember
[] of members with label "ANC"
getAncestorMembersAsList
public List getAncestorMembersAsList()
- Returns only the
ContextMember
s that have the context
member label (CXL) of "ANC" or self.
- Returns:
ContextMember
[] of members with label "ANC"
getSiblingMembers
public ContextMember[] getSiblingMembers()
- Returns only the
ContextMember
s that have the context
member label (CXL) of "SIB" or self.
- Returns:
ContextMember
[] of members with label "SIB"
getSiblingMembersAsList
public List getSiblingMembersAsList()
- Returns only the
ContextMember
s that have the context
member label (CXL) of "SIB" or self.
- Returns:
ContextMember
[] of members with label "SIB"
isTopLevel
public boolean isTopLevel()
- Indicates if context is of the top level.
- Returns:
boolean
true if top level
false if otherwise
getKeyFields
public String getKeyFields()
- Returns a
String
key which can be used
by equals, compareTo, and hashCode methods.
- Returns:
- a
String
composed from key Context
fields
Copyright ©2005