gov.nih.nlm.umls.meta
Interface IndexEntry

All Known Implementing Classes:

IndexEntryImpl, LowercaseWordIndexEntryImpl, NormalizedStringIndexEntryImpl, NormalizedWordIndexEntryImpl

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

String getCui()

Returns a String representation of the CUI.

Returns:

a String representation of the CUI

setCui

void setCui(String cui)

Sets the CUI.

Parameters:

cui - the String CUI value

getConceptIdentifier

String getConceptIdentifier()

Returns a String representation of the CUI.

Returns:

a String representation of the CUI

setConceptIdentifier

void setConceptIdentifier(String cui)

Sets the CUI.

Parameters:

cui - the String CUI value

getLui

String getLui()

Returns a String representation of the LUI.

Returns:

a String representation of the LUI

setLui

void setLui(String lui)

Sets the LUI.

Parameters:

lui - the String LUI value

getTermIdentifier

String getTermIdentifier()

Returns the term identifier (LUI).

Returns:

the LUI

setTermIdentifier

void setTermIdentifier(String lui)

Sets the term identifier (LUI).

Parameters:

lui - the LUI

getSui

String getSui()

Returns a String representation of the SUI.

Returns:

a String representation of the SUI

setSui

void setSui(String sui)

Sets the SUI.

Parameters:

sui - a String SUI value

getStringIdentifier

String getStringIdentifier()

Return the string identifier (SUI).

Returns:

the SUI

setStringIdentifier

void setStringIdentifier(String sui)

Sets the string identifier (SUI).

Parameters:

sui - the SUI

getLat

String getLat()

Returns a String representation of the language.

Returns:

a String representation of the language

setLat

void setLat(String lat)

Sets the language abbreviation.

Parameters:

lat - the language abbreviation

getLanguage

String getLanguage()

Returns a String representation of the language.

Returns:

a String representation of the language

setLanguage

void setLanguage(String lat)

Sets the language abbreviation.

Parameters:

lat - the language abbreviation

getValue

String getValue()

Returns the String that is being indexed.

Returns:

the String that is being indexed

setValue

void setValue(String value)

Set the String being indexed

Parameters:

value - the String being indexed

getKeyFields

String getKeyFields()

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

Returns:

a String composed from key Atom fields