gov.nih.nlm.umls.meta
Interface Locator

All Superinterfaces:

AtomElement, AttributeElement, Comparable, ConceptElement, ContentViewElement, SourceElement

All Known Implementing Classes:

LocatorImpl

public interface Locator

extends AtomElement, AttributeElement, Comparable, ConceptElement, ContentViewElement, SourceElement

Represents information about a locator, which provides linkings between Metathesaurus concepts and external databases.

Following is a UML Class diagram showing the neighborhood around Locator

All of the data in the MRLO file is represented here.

Author:

Brian Carlsen, Deborah Shapiro

Nested Class Summary

Nested classes inherited from class gov.nih.nlm.umls.meta.AtomElement

AtomElement.ByLanguageRestrictor, AtomElement.BySourceRestrictor

Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement

SourceElement.BySourceComparator, SourceElement.BySourceRestrictor

Method Summary

String	getExternalName() Returns the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus.
int	getFr() Returns the frequency (FR).
int	getFrequency() Returns the frequency (FR).
String	getFrequencyMeaning() Returns the meaning of the frequency (UN), if the frequency is set.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
String	getRecordIdentifier() Returns the record identifier (SOUI) corresponding to this Locator in the actual information source.
String	getSna() Returns the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus.
String	getSoui() Returns the record identifier (SOUI) corresponding to this Locator in the actual information source.
String	getStringIdentifier() Return the string identifier (SUI).
String	getSui() Return the string identifier (SUI).
String	getUn() Returns the meaning of the frequency (UN), if the frequency is set.
void	setExternalName(String sna) Sets the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus.
void	setFr(int fr) Set the frequency (FR).
void	setFrequency(int fr) Sets the frequency (FR).
void	setFrequencyMeaning(String un) Returns the meaning of the frequency (UN), if the frequency is set.
void	setRecordIdentifier(String soui) Sets the record identifier (SOUI) corresponding to this Locator in the actual information source.
void	setSna(String sna) Sets the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus.
void	setSoui(String soui) Sets the record identifier (SOUI) corresponding to this Locator in the actual information source.
void	setStringIdentifier(String sui) Sets the string identifier (SUI).
void	setSui(String sui) Sets the string identifier (SUI).
void	setUn(String un) Sets the meaning of the frequency (UN), if the frequency is set.

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

getAtom, setAtom

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

getAttributeIdentifier, getAtui, getSatui, getSourceAttributeIdentifier, setAttributeIdentifier, setAtui, setSatui, setSourceAttributeIdentifier

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.ContentViewElement

getContentView, getCvf, setContentView, setCvf

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

getSource, setSource

Method Detail

getFrequency

public int getFrequency()

Returns the frequency (FR).

Returns:

the frequency

See Also:

getFrequencyMeaning()

getFr

public int getFr()

Returns the frequency (FR). This is shorthand for getFrequency().

Returns:

the frequency

setFrequency

public void setFrequency(int fr)

Sets the frequency (FR).

Parameters:

fr - the frequency

setFr

public void setFr(int fr)

Set the frequency (FR). This is shorthand for setFrequency(int).

Parameters:

fr - the frequency

getUn

public String getUn()

Returns the meaning of the frequency (UN), if the frequency is set. This is shorthand for getFrequencyMeaning().

Returns:

the meaning of the frequency, if the frequency is set.

getFrequencyMeaning

public String getFrequencyMeaning()

Returns the meaning of the frequency (UN), if the frequency is set.

Returns:

the meaning of the frequency, if the frequency is set.

setUn

public void setUn(String un)

Sets the meaning of the frequency (UN), if the frequency is set. This is shorthand for setFrequencyMeaning(String).

Parameters:

un - the meaning of the frequency, if the frequency is set.

setFrequencyMeaning

public void setFrequencyMeaning(String un)

Returns the meaning of the frequency (UN), if the frequency is set.

Parameters:

un - the meaning of the frequency, if the frequency is set.

getExternalName

public String getExternalName()

Returns the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus.

Returns:

the actual name that occurs in the information source

getSna

public String getSna()

Returns the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus. This is shorthand for getExternalName().

Returns:

the actual name that occurs in the information source

setExternalName

public void setExternalName(String sna)

Sets the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus.

Parameters:

sna - the actual name that occurs in the information source

setSna

public void setSna(String sna)

Sets the actual name that occurs in the information source (SNA) if not otherwise present in the Metathesaurus. This is shorthand for setExternalName(String).

Parameters:

sna - the actual name that occurs in the information source

getSoui

public String getSoui()

Returns the record identifier (SOUI) corresponding to this Locator in the actual information source. This is shorthand for getRecordIdentifier().

Returns:

the record identifier

getRecordIdentifier

public String getRecordIdentifier()

Returns the record identifier (SOUI) corresponding to this Locator in the actual information source.

Returns:

the record identifier

setSoui

public void setSoui(String soui)

Sets the record identifier (SOUI) corresponding to this Locator in the actual information source.

Parameters:

soui - the record identifier

setRecordIdentifier

public void setRecordIdentifier(String soui)

Sets the record identifier (SOUI) corresponding to this Locator in the actual information source. This is shorthand for setRecordIdentifier(String).

Parameters:

soui - the record identifier

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

getKeyFields

public String getKeyFields()

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

Returns:

a String composed from key Locator fields