gov.nih.nlm.umls.meta
Interface IndexEntry

All Known Implementing Classes:

IndexEntryImpl

public interface IndexEntry

Represents an entry from an cui index. The Metathesaurus is released with string and word indexes, and this class represents a single entry from one of those indexes.

Author:

Deborah Shapiro, Brian Carlsen

Method Summary

String	getConceptIdentifier() Returns a String representation of the CUI.
String	getCui() Returns a String representation of the CUI.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
String	getLanguage() Returns a String representation of the language.
String	getLat() Returns a String representation of the language.
String	getLui() Returns a String representation of the LUI.
String	getStringIdentifier() Return the string identifier (SUI).
String	getSui() Returns a String representation of the SUI.
String	getTermIdentifier() Returns the term identifier (LUI).
String	getValue() Returns the String that is being indexed.
void	setConceptIdentifier(String cui) Sets the CUI.
void	setCui(String cui) Sets the CUI.
void	setLanguage(String lat) Sets the language abbreviation.
void	setLat(String lat) Sets the language abbreviation.
void	setLui(String lui) Sets the LUI.
void	setStringIdentifier(String sui) Sets the string identifier (SUI).
void	setSui(String sui) Sets the SUI.
void	setTermIdentifier(String lui) Sets the term identifier (LUI).
void	setValue(String value) Set the String being indexed

Method Detail

getCui

public String getCui()

Returns a String representation of the CUI.

Returns:

a String representation of the CUI

setCui

public void setCui(String cui)

Sets the CUI.

Parameters:

cui - the String CUI value

getConceptIdentifier

public String getConceptIdentifier()

Returns a String representation of the CUI.

Returns:

a String representation of the CUI

setConceptIdentifier

public void setConceptIdentifier(String cui)

Sets the CUI.

Parameters:

cui - the String CUI value

getLui

public String getLui()

Returns a String representation of the LUI.

Returns:

a String representation of the LUI

setLui

public void setLui(String lui)

Sets the LUI.

Parameters:

lui - the String LUI value

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

getSui

public String getSui()

Returns a String representation of the SUI.

Returns:

a String representation of the SUI

setSui

public void setSui(String sui)

Sets the SUI.

Parameters:

sui - a String SUI value

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

getLat

public String getLat()

Returns a String representation of the language.

Returns:

a String representation of the language

setLat

public void setLat(String lat)

Sets the language abbreviation.

Parameters:

lat - the language abbreviation

getLanguage

public String getLanguage()

Returns a String representation of the language.

Returns:

a String representation of the language

setLanguage

public void setLanguage(String lat)

Sets the language abbreviation.

Parameters:

lat - the language abbreviation

getValue

public String getValue()

Returns the String that is being indexed.

Returns:

the String that is being indexed

setValue

public void setValue(String value)

Set the String being indexed

Parameters:

value - the String being indexed

getKeyFields

public String getKeyFields()

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

Returns:

a String composed from key Atom fields