gov.nih.nlm.umls.meta
Interface StringInfo

All Superinterfaces:
Comparable, TermElement
All Known Implementing Classes:
StringInfoImpl

public interface StringInfo
extends Comparable, TermElement

Represents string information for a Term.

Following is a UML Class diagram showing the neighborhood around StringInfo

Author:
Brian Carlsen, Deborah Shapiro
See Also:
Term

Method Summary
 void addAtom(Atom str_source)
          Adds the specified Atom.
 void clearAtoms()
          Removes all Atoms.
 Atom[] getAtoms()
          Returns all Atoms.
 List getAtomsAsList()
          Returns all Atoms as a List.
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 String getName()
          Sets the name (STR).
 String getStr()
          Returns the name (STR).
 String getStringIdentifier()
          Return the string identifier (SUI).
 StringType getStringType()
          Returns the StringType (STT).
 StringType getStt()
          Returns the StringType (STT).
 String getSui()
          Return the string identifier (SUI).
 boolean hasPreferredStringIdentifier()
          Indicates whether or not this atom has the preferred string identifier of the Term it is part of.
 boolean hasPreferredSui()
          Indicates whether or not this atom has the preferred string identifier of the Term it is part of.
 void removeAtom(Atom str_source)
          Removes the specified Atom.
 void setAtoms(Atom[] str_source)
          Replaces the Atoms with those in the specified array.
 void setAtoms(List str_source)
          Replaces the Atoms with those in the specified List
 void setName(String str)
          Sets the name (STR).
 void setStr(String str)
          Sets the name (STR).
 void setStringIdentifier(String sui)
          Sets the string identifier (SUI).
 void setStringType(StringType stt)
          Sets the StringType (STT).
 void setStt(StringType stt)
          Sets the StringType (STT).
 void setSui(String sui)
          Sets the string identifier (SUI).
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface gov.nih.nlm.umls.meta.TermElement
getTerm, setTerm
 

Method Detail

getStringType

public StringType getStringType()
Returns the StringType (STT).

Returns:
the StringType

getStt

public StringType getStt()
Returns the StringType (STT). This is shorthand for getStringType().

Returns:
the StringType

setStringType

public void setStringType(StringType stt)
Sets the StringType (STT).

Parameters:
stt - the STT

setStt

public void setStt(StringType stt)
Sets the StringType (STT). This is shorthand for setStringType(StringType).

Parameters:
stt - the STT

getSui

public String getSui()
Return the string identifier (SUI). This is shorthand for getStringIdentifier().

Returns:
the SUI

setSui

public void setSui(String sui)
Sets the string identifier (SUI). This is shorthand for setStringIdentifier(String).

Parameters:
sui - the SUI

getStringIdentifier

public String getStringIdentifier()
Return the string identifier (SUI).

Returns:
the SUI

setStringIdentifier

public void setStringIdentifier(String sui)
Sets the string identifier (SUI).

Parameters:
sui - the SUI

getName

public String getName()
Sets the name (STR).

Returns:
the name

getStr

public String getStr()
Returns the name (STR). This is shorthand for getName().

Returns:
the name

setName

public void setName(String str)
Sets the name (STR).

Parameters:
str - the name

setStr

public void setStr(String str)
Sets the name (STR). This is shorthand for setName(String).

Parameters:
str - the name

getAtoms

public Atom[] getAtoms()
Returns all Atoms.

Returns:
an array of Atoms

getAtomsAsList

public List getAtomsAsList()
Returns all Atoms as a List.

Returns:
all Atoms as a List

addAtom

public void addAtom(Atom str_source)
Adds the specified Atom.

Parameters:
str_source - the Atom to add

removeAtom

public void removeAtom(Atom str_source)
Removes the specified Atom.

Parameters:
str_source - the Atom to remove

clearAtoms

public void clearAtoms()
Removes all Atoms.


setAtoms

public void setAtoms(Atom[] str_source)
Replaces the Atoms with those in the specified array.

Parameters:
str_source - an array of Atoms

setAtoms

public void setAtoms(List str_source)
Replaces the Atoms with those in the specified List

Parameters:
str_source - a List of Atoms

hasPreferredStringIdentifier

public boolean hasPreferredStringIdentifier()
Indicates whether or not this atom has the preferred string identifier of the Term it is part of. In other words, does this Atom have the same SUI as the preferred Atom of the Term.

Returns:
true if so, false otherwise

hasPreferredSui

public boolean hasPreferredSui()
Indicates whether or not this atom has the preferred string identifier of the Term it is part of. This is shorthand for hasPreferredStringIdentifier().

Returns:
true if so, false 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 StringInfo fields


Copyright ©2005