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

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

String getVersionedConceptIdentifier()

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

Returns:

the concept identifier for the versioned SRC concept

getRcui

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

String getRootConceptIdentifier()

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

Returns:

the concept identifier for the root SRC concept

getVsab

String getVsab()

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

Returns:

the versioned source abbreviation

getVersionedSourceAbbreviation

String getVersionedSourceAbbreviation()

Returns the versioned source abbreviation (VSAB).

Returns:

the versioned source abbreviation

getRsab

String getRsab()

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

Returns:

the root source abbreviation

getRootSourceAbbreviation

String getRootSourceAbbreviation()

Returns the root source abbreviation (RSAB).

Returns:

the root source abbreviation

getSon

String getSon()

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

Returns:

the source official name

getOfficialName

String getOfficialName()

Returns the source official name (SON).

Returns:

the source official name

getSsn

String getSsn()

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

Returns:

the source short name

getShortName

String getShortName()

Returns the source short name (SSN).

Returns:

the source short name

getScit

String getScit()

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

Returns:

the source citation

getCitation

String getCitation()

Returns the source citation (SCIT).

Returns:

the source citation

getSf

String getSf()

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

Returns:

the source family

getSourceFamily

String getSourceFamily()

Returns the source family (SF).

Returns:

the source family

getSver

String getSver()

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

Returns:

the source version

getVersion

String getVersion()

Returns source version (SVER).

Returns:

the source version

getMstart

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

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

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

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

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

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

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

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

String getSlc()

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

Returns:

the license contact information

getLicenseContact

String getLicenseContact()

Returns the license contact information (SLC).

Returns:

the license contact information

getContentContact

String getContentContact()

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

Returns:

the content contact information

getScc

String getScc()

Returns the content contact information (SCC).

Returns:

the content contact information

getSrl

String getSrl()

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

Returns:

the restriction level

getRestrictionLevel

String getRestrictionLevel()

Returns the restriction level (SRL).

Returns:

the restriction level

getTfr

int getTfr()

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

Returns:

the frequency of terms

getTermFrequency

int getTermFrequency()

Returns the frequency of terms (TFR).

Returns:

the frequency of terms

getCfr

int getCfr()

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

Returns:

the frequency of concepts

getConceptFrequency

int getConceptFrequency()

Returns the frequency of concepts (CFR).

Returns:

the frequency of concepts

getCxty

String getCxty()

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

Returns:

the context type

getContextType

String getContextType()

Returns the context type (CXTY).

Returns:

the context type

getTermTypes

TermType[] getTermTypes()

Returns the TermTypes.

Returns:

an array of TermTypes

getTermTypesAsList

List getTermTypesAsList()

Returns the TermTypes as a List.

Returns:

the TermTypes as a List

getTtyl

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

String getTermTypesAsString()

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

Returns:

the term type values

getAttributeNames

AttributeName[] getAttributeNames()

Get the AttributeNames for this Source. Returns the AttributeNames.

Returns:

an array of AttributeNames

getAttributeNamesAsList

List getAttributeNamesAsList()

Returns the AttributeNames as a List.

Returns:

the AttributeNames as a List

getAtnl

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

String getAttributeNamesAsString()

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

Returns:

the attribute name values

getLat

Language getLat()

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

Returns:

the Language

getLanguage

Language getLanguage()

Returns the Language (LAT).

Returns:

the Language

getCenc

String getCenc()

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

Returns:

the character encoding

getCharacterEncoding

String getCharacterEncoding()

Returns the ISO character encoding (CENC).

Returns:

the character encoding

getCurver

String getCurver()

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

Returns:

the "is current version" value

isCurrentVersion

boolean isCurrentVersion()

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

Returns:

true if it does, false otherwise.

getSabin

String getSabin()

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

Returns:

the "in current subset" value

inCurrentSubset

boolean inCurrentSubset()

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

Returns:

true if it is, false otherwise.

setInCurrentSubset

void setInCurrentSubset(boolean sabin)

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

Parameters:

sabin - boolean

setSabin

void setSabin(String sabin)

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

Parameters:

sabin - "in current subset" value