gov.nih.nlm.umls.meta
Interface Term

All Superinterfaces:

Comparable, ConceptElement

All Known Implementing Classes:

TermImpl

public interface Term

extends Comparable, ConceptElement

Represents Concept term information. This is a higher level view of a Concept's names than Atom.

Following is a UML Class diagram showing the neighborhood around Term

Author:

Brian Carlsen, Deborah Shapiro

Method Summary

void	addTermAttribute(TermAttribute ta) Adds the specified TermAttribute.
void	addTermVariant(StringInfo tv) Adds the specified term variant.
void	clearTermAttributes() Removes all TermAttributes.
void	clearTermVariants() Removes all term variants.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
Language	getLanguage() Returns the Language (LAT).
Language	getLat() Returns the Language (LAT).
String	getLui() Returns the term identifier (LUI).
String	getName() Sets the name (STR).
String	getStr() Returns the name (STR).
TermAttribute[]	getTermAttributes() Returns all TermAttributes.
List	getTermAttributesAsList() Returns all TermAttributes as a List.
String	getTermIdentifier() Returns the term identifier (LUI).
TermStatus	getTermStatus() Returns the TermStatus (TS).
StringInfo[]	getTermVariants() Returns all StringInfo term variants.
List	getTermVariantsAsList() Returns all StringInfo term variants as a List.
TermStatus	getTs() Returns the TermStatus (TS).
boolean	hasPreferredLui() Indicates whether or not this Term is the preferred Term of the Concept.
boolean	hasPreferredTermIdentifier() Indicates whether or not this Term is the preferred Term of the Concept.
void	removeTermAttribute(TermAttribute ta) Removes the specified TermAttribute.
void	removeTermVariant(StringInfo tv) Removes the specified term variant.
void	setLanguage(Language lat) Sets the Language (LAT).
void	setLat(Language lat) Sets the Language (LAT).
void	setLui(String lui) Sets the term identifier (LUI).
void	setName(String str) Sets the name (STR).
void	setStr(String str) Sets the name (STR).
void	setTermAttributes(List tas) Replaces TermAttributes with the specified List
void	setTermAttributes(TermAttribute[] tas) Replaces the TermAttributes with the specified TermAttribute objects.
void	setTermIdentifier(String lui) Sets the term identifier (LUI).
void	setTermStatus(TermStatus ts) Sets the TermStatus (TS).
void	setTermVariants(List tvs) Replaces term variants with the specified List
void	setTermVariants(StringInfo[] tvs) Replaces term variants with the specified StringInfo objects.
void	setTs(TermStatus ts) Sets the TermStatus (TS).

Methods inherited from interface java.lang.Comparable

compareTo

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

getConcept, setConcept

Method Detail

getLanguage

public Language getLanguage()

Returns the Language (LAT).

Returns:

the Language

getLat

public Language getLat()

Returns the Language (LAT). This is shorthand for getLanguage().

Returns:

Language

setLanguage

public void setLanguage(Language lat)

Sets the Language (LAT).

Parameters:

lat - the Language

setLat

public void setLat(Language lat)

Sets the Language (LAT). This is shorthand for setLanguage(Language).

Parameters:

lat - the Language

getTermStatus

public TermStatus getTermStatus()

Returns the TermStatus (TS).

Returns:

the TermStatus

getTs

public TermStatus getTs()

Returns the TermStatus (TS). This is shorthand for getTermStatus().

Returns:

the TermStatus

setTermStatus

public void setTermStatus(TermStatus ts)

Sets the TermStatus (TS).

Parameters:

ts - the TermStatus

setTs

public void setTs(TermStatus ts)

Sets the TermStatus (TS). This is shorthand for setTermStatus(TermStatus).

Parameters:

ts - the TermStatus

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

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

getTermVariants

public StringInfo[] getTermVariants()

Returns all StringInfo term variants.

Returns:

an array of StringInfo objects

getTermVariantsAsList

public List getTermVariantsAsList()

Returns all StringInfo term variants as a List.

Returns:

all StringInfo term variants as a List

addTermVariant

public void addTermVariant(StringInfo tv)

Adds the specified term variant.

Parameters:

tv - a StringInfo term variant to add

clearTermVariants

public void clearTermVariants()

Removes all term variants.

removeTermVariant

public void removeTermVariant(StringInfo tv)

Removes the specified term variant.

Parameters:

tv - a StringInfo term variant to remove

setTermVariants

public void setTermVariants(StringInfo[] tvs)

Replaces term variants with the specified StringInfo objects.

Parameters:

tvs - an array of StringInfo objects

setTermVariants

public void setTermVariants(List tvs)

Replaces term variants with the specified List

Parameters:

tvs - a List of StringInfo objects

getTermAttributes

public TermAttribute[] getTermAttributes()

Returns all TermAttributes.

Returns:

an array of TermAttribute objects

getTermAttributesAsList

public List getTermAttributesAsList()

Returns all TermAttributes as a List.

Returns:

all TermAttributes as a List

addTermAttribute

public void addTermAttribute(TermAttribute ta)

Adds the specified TermAttribute.

Parameters:

ta - a TermAttribute to add

clearTermAttributes

public void clearTermAttributes()

Removes all TermAttributes.

removeTermAttribute

public void removeTermAttribute(TermAttribute ta)

Removes the specified TermAttribute.

Parameters:

ta - the TermAttribute to remove

setTermAttributes

public void setTermAttributes(TermAttribute[] tas)

Replaces the TermAttributes with the specified TermAttribute objects.

Parameters:

tas - an array of TermAttribute objects

setTermAttributes

public void setTermAttributes(List tas)

Replaces TermAttributes with the specified List

Parameters:

tas - a List of TermAttribute objects

hasPreferredTermIdentifier

public boolean hasPreferredTermIdentifier()

Indicates whether or not this Term is the preferred Term of the Concept. In other words, does this Term have the same LUI as the preferred Term of the Concept.

Returns:

true if so, false otherwise

hasPreferredLui

public boolean hasPreferredLui()

Indicates whether or not this Term is the preferred Term of the Concept. This is shorthand for hasPreferredTermIdentifier()

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 Term fields