gov.nih.nlm.umls.meta
Interface SourceMetaDescription

All Superinterfaces:

Comparable

All Known Implementing Classes:

Source, SourceMetaDescriptionImpl

public interface SourceMetaDescription

extends Comparable

Represents information about a UMLS source. All of the data in a row of MRSAB is represented here.

Author:

Brian Carlsen, Deborah Shapiro

Method Summary

String	getAtnl() Returns the attribute names as a comma (,) separated list of attribute name abbreviations (ATNL).
AttributeName[]	getAttributeNames() Get the AttributeNames for this Source.
List	getAttributeNamesAsList() Returns the AttributeNames as a List.
String	getAttributeNamesAsString() Returns the attribute names as a comma (,) separated list of attribute name abbreviations (ATNL).
String	getCenc() Returns the ISO character encoding (CENC).
int	getCfr() Returns the frequency of concepts (CFR).
String	getCharacterEncoding() Returns the ISO character encoding (CENC).
String	getCitation() Returns the source citation (SCIT).
int	getConceptFrequency() Returns the frequency of concepts (CFR).
String	getContentContact() Returns the content contact information (SCC).
String	getContextType() Returns the context type (CXTY).
String	getCurver() Returns the "is current version" value (CURVER).
String	getCxty() Returns the context type (CXTY).
String	getImeta() Returns the version of the Metathesaurus in which this source first appeared (IMETA).
String	getInsertMetaVersion() Returns the version of the Metathesaurus in which this source first appeared (IMETA).
Language	getLanguage() Returns the Language (LAT).
Language	getLat() Returns the Language (LAT).
String	getLicenseContact() Returns the license contact information (SLC).
Date	getMend() Returns the date when this source is no longer valid in the Metathesaurus (MEND).
Date	getMstart() Returns the date when this source becomes valid in the Metathesaurus (MSTART).
String	getOfficialName() Returns the source official name (SON).
String	getRcui() Returns the concept identifier for the root SRC concept (VCUI).
String	getRemoveMetaVersion() Returns the first version of the Metathesaurus in which this source no longer (RMETA).
String	getRestrictionLevel() Returns the restriction level (SRL).
String	getRmeta() Returns the first version of the Metathesaurus in which this source no longer (RMETA).
String	getRootConceptIdentifier() Returns the concept identifier for the root SRC concept (VCUI).
String	getRootSourceAbbreviation() Returns the root source abbreviation (RSAB).
String	getRsab() Returns the root source abbreviation (RSAB).
String	getSabin() Returns the "in current subset" value (SABIN).
String	getScc() Returns the content contact information (SCC).
String	getScit() Returns the source citation (SCIT).
String	getSf() Returns the source family (SF).
String	getShortName() Returns the source short name (SSN).
String	getSlc() Returns the license contact information (SLC).
String	getSon() Returns the source official name (SON).
String	getSourceFamily() Returns the source family (SF).
String	getSrl() Returns the restriction level (SRL).
String	getSsn() Returns the source short name (SSN).
String	getSver() Returns source version (SVER).
int	getTermFrequency() Returns the frequency of terms (TFR).
TermType[]	getTermTypes() Returns the TermTypes.
List	getTermTypesAsList() Returns the TermTypes as a List.
String	getTermTypesAsString() Returns the term types as a comma (,) separated list of term type abbreviations (TTYL).
int	getTfr() Returns the frequency of terms (TFR).
String	getTtyl() Returns the term types as a comma (,) separated list of term type abbreviations (TTYL).
Date	getValidEndDate() Returns the date when this source is no longer valid in the Metathesaurus (MEND).
Date	getValidStartDate() Returns the date when this source becomes valid in the Metathesaurus (MSTART).
String	getVcui() Returns the concept identifier for the versioned SRC concept (VCUI).
String	getVersion() Returns source version (SVER).
String	getVersionedConceptIdentifier() Returns the concept identifier for the versioned SRC concept (VCUI).
String	getVersionedSourceAbbreviation() Returns the versioned source abbreviation (VSAB).
String	getVsab() Returns the versioned source abbreviation (VSAB).
boolean	inCurrentSubset() Indicates whether or not this source is represented in the current subset.
boolean	isCurrentVersion() Indicates whether or not this represents the current version of the source.
void	setInCurrentSubset(boolean sabin) Sets whether or not this represents the current version of the source.
void	setSabin(String sabin) Sets the "in current subset" value (SABIN).

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getVcui

public String getVcui()

Returns the concept identifier for the versioned SRC concept (VCUI). This is shorthand for getVersionedConceptIdentifier().

Returns:

the concept identifier for the versioned SRC concept

getVersionedConceptIdentifier

public String getVersionedConceptIdentifier()

Returns the concept identifier for the versioned SRC concept (VCUI).

Returns:

the concept identifier for the versioned SRC concept

getRcui

public String getRcui()

Returns the concept identifier for the root SRC concept (VCUI). This is shorthand for getRootConceptIdentifier().

Returns:

the concept identifier for the root SRC concept

getRootConceptIdentifier

public String getRootConceptIdentifier()

Returns the concept identifier for the root SRC concept (VCUI).

Returns:

the concept identifier for the root SRC concept

getVsab

public String getVsab()

Returns the versioned source abbreviation (VSAB). This is shorthand for (@ link #getVersionedSourceAbbreviation()}.

Returns:

the versioned source abbreviation

getVersionedSourceAbbreviation

public String getVersionedSourceAbbreviation()

Returns the versioned source abbreviation (VSAB).

Returns:

the versioned source abbreviation

getRsab

public String getRsab()

Returns the root source abbreviation (RSAB). This is shorthand for getRootSourceAbbreviation().

Returns:

the root source abbreviation

getRootSourceAbbreviation

public String getRootSourceAbbreviation()

Returns the root source abbreviation (RSAB).

Returns:

the root source abbreviation

getSon

public String getSon()

Returns the source official name (SON). This is shorthand for getOfficialName().

Returns:

the source official name

getOfficialName

public String getOfficialName()

Returns the source official name (SON).

Returns:

the source official name

getSsn

public String getSsn()

Returns the source short name (SSN). This is shorthand for getShortName().

Returns:

the source short name

getShortName

public String getShortName()

Returns the source short name (SSN).

Returns:

the source short name

getScit

public String getScit()

Returns the source citation (SCIT). This is shorthand for getCitation().

Returns:

the source citation

getCitation

public String getCitation()

Returns the source citation (SCIT).

Returns:

the source citation

getSf

public String getSf()

Returns the source family (SF). This is shorthand for getSourceFamily().

Returns:

the source family

getSourceFamily

public String getSourceFamily()

Returns the source family (SF).

Returns:

the source family

getSver

public String getSver()

Returns source version (SVER). This is shorthand for getVersion().

Returns:

the source version

getVersion

public String getVersion()

Returns source version (SVER).

Returns:

the source version

getMstart

public Date getMstart()

Returns the date when this source becomes valid in the Metathesaurus (MSTART). This is shorthand for getValidStartDate().

Returns:

the date when this source becomes valid in the Metathesaurus

getValidStartDate

public Date getValidStartDate()

Returns the date when this source becomes valid in the Metathesaurus (MSTART).

Returns:

the date when this source becomes valid in the Metathesaurus

getMend

public Date getMend()

Returns the date when this source is no longer valid in the Metathesaurus (MEND). This is shorthand for getValidEndDate().

Returns:

the date when this source is no longer valid in the Metathesaurus

getValidEndDate

public Date getValidEndDate()

Returns the date when this source is no longer valid in the Metathesaurus (MEND).

Returns:

the date when this source is no longer valid in the Metathesaurus

getInsertMetaVersion

public String getInsertMetaVersion()

Returns the version of the Metathesaurus in which this source first appeared (IMETA).

Returns:

the version of the Metathesaurus in which this source first appeared

getImeta

public String getImeta()

Returns the version of the Metathesaurus in which this source first appeared (IMETA). This is shorthand for getInsertMetaVersion()

Returns:

the version of the Metathesaurus in which this source first appeared

getRmeta

public String getRmeta()

Returns the first version of the Metathesaurus in which this source no longer (RMETA). This is shorthand for getRemoveMetaVersion()

Returns:

the first version of the Metathesaurus in which this source no longer

getRemoveMetaVersion

public String getRemoveMetaVersion()

Returns the first version of the Metathesaurus in which this source no longer (RMETA).

Returns:

the first version of the Metathesaurus in which this source no longer

getSlc

public String getSlc()

Returns the license contact information (SLC). This is shorthand for getLicenseContact().

Returns:

the license contact information

getLicenseContact

public String getLicenseContact()

Returns the license contact information (SLC).

Returns:

the license contact information

getContentContact

public String getContentContact()

Returns the content contact information (SCC). This is shorthand for getContentContact().

Returns:

the content contact information

getScc

public String getScc()

Returns the content contact information (SCC).

Returns:

the content contact information

getSrl

public String getSrl()

Returns the restriction level (SRL). This is shorthand for getRestrictionLevel().

Returns:

the restriction level

getRestrictionLevel

public String getRestrictionLevel()

Returns the restriction level (SRL).

Returns:

the restriction level

getTfr

public int getTfr()

Returns the frequency of terms (TFR). This is shorthand for getTermFrequency()

Returns:

the frequency of terms

getTermFrequency

public int getTermFrequency()

Returns the frequency of terms (TFR).

Returns:

the frequency of terms

getCfr

public int getCfr()

Returns the frequency of concepts (CFR). This is shorthand for getConceptFrequency()

Returns:

the frequency of concepts

getConceptFrequency

public int getConceptFrequency()

Returns the frequency of concepts (CFR).

Returns:

the frequency of concepts

getCxty

public String getCxty()

Returns the context type (CXTY). This is shorthand for getContextType().

Returns:

the context type

getContextType

public String getContextType()

Returns the context type (CXTY).

Returns:

the context type

getTermTypes

public TermType[] getTermTypes()

Returns the TermTypes.

Returns:

an array of TermTypes

getTermTypesAsList

public List getTermTypesAsList()

Returns the TermTypes as a List.

Returns:

the TermTypes as a List

getTtyl

public String getTtyl()

Returns the term types as a comma (,) separated list of term type abbreviations (TTYL). This is shorthand for getTermTypesAsString().

Returns:

the term type values

getTermTypesAsString

public String getTermTypesAsString()

Returns the term types as a comma (,) separated list of term type abbreviations (TTYL).

Returns:

the term type values

getAttributeNames

public AttributeName[] getAttributeNames()

Get the AttributeNames for this Source. Returns the AttributeNames.

Returns:

an array of AttributeNames

getAttributeNamesAsList

public List getAttributeNamesAsList()

Returns the AttributeNames as a List.

Returns:

the AttributeNames as a List

getAtnl

public String getAtnl()

Returns the attribute names as a comma (,) separated list of attribute name abbreviations (ATNL). This is shorthand for getAttributeNamesAsString().

Returns:

the attribute name values

getAttributeNamesAsString

public String getAttributeNamesAsString()

Returns the attribute names as a comma (,) separated list of attribute name abbreviations (ATNL).

Returns:

the attribute name values

getLat

public Language getLat()

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

Returns:

the Language

getLanguage

public Language getLanguage()

Returns the Language (LAT).

Returns:

the Language

getCenc

public String getCenc()

Returns the ISO character encoding (CENC). This is shorthand for getCharacterEncoding().

Returns:

the character encoding

getCharacterEncoding

public String getCharacterEncoding()

Returns the ISO character encoding (CENC).

Returns:

the character encoding

getCurver

public String getCurver()

Returns the "is current version" value (CURVER).

Returns:

the "is current version" value

isCurrentVersion

public boolean isCurrentVersion()

Indicates whether or not this represents the current version of the source.

Returns:

true if it does, false otherwise.

getSabin

public String getSabin()

Returns the "in current subset" value (SABIN).

Returns:

the "in current subset" value

inCurrentSubset

public boolean inCurrentSubset()

Indicates whether or not this source is represented in the current subset.

Returns:

true if it is, false otherwise.

setInCurrentSubset

public void setInCurrentSubset(boolean sabin)

Sets whether or not this represents the current version of the source.

Parameters:

sabin - boolean

setSabin

public void setSabin(String sabin)

Sets the "in current subset" value (SABIN).

Parameters:

sabin - "in current subset" value