gov.nih.nlm.umls.meta
Interface TermAttribute

All Superinterfaces:
Comparable, ConceptElement, TermElement
All Known Implementing Classes:
TermAttributeImpl

public interface TermAttribute
extends Comparable, ConceptElement, TermElement

Represents information about attributes sharing the same Term.

Following is a UML Class diagram showing the neighborhood around TermAttribute

Author:
Brian Carlsen, Deborah Shapiro

Method Summary
 void addStringAttribute(StringAttribute as)
          Adds the specified StringAttribute.
 void clearStringAttributes()
          Removes all StringAttributes.
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 String getLui()
          Returns the term identifier (LUI).
 StringAttribute[] getStringAttributes()
          Returns all StringAttributes.
 List getStringAttributesAsList()
          Returns all StringAttributes as a List.
 String getTermIdentifier()
          Returns the term identifier (LUI).
 void removeStringAttribute(StringAttribute av)
          Removes the specified StringAttribute.
 void setLui(String lui)
          Sets the term identifier (LUI).
 void setStringAttributes(List avs)
          Replaces the StringAttributes with the ones in the specified List.
 void setStringAttributes(StringAttribute[] avs)
          Replaces the StringAttributes with the ones in the specified array.
 void setTermIdentifier(String lui)
          Sets the term identifier (LUI).
 
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.TermElement
getTerm, setTerm
 

Method Detail

getLui

public String getLui()
Returns the term identifier (LUI). This is shorthand for getTermIdentifier().

Returns:
the LUI

setLui

public void setLui(String lui)
Sets the term identifier (LUI). This is shorthand for setTermIdentifier(String).

Parameters:
lui - the LUI

getTermIdentifier

public String getTermIdentifier()
Returns the term identifier (LUI).

Returns:
the LUI

setTermIdentifier

public void setTermIdentifier(String lui)
Sets the term identifier (LUI).

Parameters:
lui - the LUI

getStringAttributes

public StringAttribute[] getStringAttributes()
Returns all StringAttributes.

Returns:
a array of StringAttributes

getStringAttributesAsList

public List getStringAttributesAsList()
Returns all StringAttributes as a List.

Returns:
a List of StringAttributes

addStringAttribute

public void addStringAttribute(StringAttribute as)
Adds the specified StringAttribute.

Parameters:
as - the StringAttribute to be added

removeStringAttribute

public void removeStringAttribute(StringAttribute av)
Removes the specified StringAttribute.

Parameters:
av - the StringAttribute to be removed

clearStringAttributes

public void clearStringAttributes()
Removes all StringAttributes.


setStringAttributes

public void setStringAttributes(StringAttribute[] avs)
Replaces the StringAttributes with the ones in the specified array.

Parameters:
avs - a StringAttribute[]

setStringAttributes

public void setStringAttributes(List avs)
Replaces the StringAttributes with the ones in the specified List.

Parameters:
avs - a List of StringAttributes

getKeyFields

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

Returns:
a String composed from key TermAttribute fields


Copyright ©2005