gov.nih.nlm.umls.meta.impl
Class SourceMetaDescriptionImpl

java.lang.Object
  gov.nih.nlm.umls.meta.impl.SourceMetaDescriptionImpl

All Implemented Interfaces:

SourceMetaDescription, Comparable

public class SourceMetaDescriptionImpl
extends Object
implements SourceMetaDescription

Default implementation of the SourceMetaDescription interface.

Author:

Brian Carlsen, Deborah Shapiro

Constructor Summary

SourceMetaDescriptionImpl()
Instantiates an empty SourceMetaDescriptionImpl.

SourceMetaDescriptionImpl(String mrsab_row)
Instantiates the SourceMetaDescription with the fields from a MRSAB row.

Method Summary

int	compareTo(Object o) Compares this SourceMetaDescription to another one.
boolean	equals(Object o) Returns true if the specified object is equal to this object.
String	getAtnl() Shorthand for getAttributeNamesAsString().
AttributeName[]	getAttributeNames() Get the AttributeNames for this SourceMetaDescription.
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() Shorthand for getCharacterEncoding().
int	getCfr() Shorthand for getConceptFrequency()
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() Shorthand for getContextType().
String	getImeta() Shorthand for getInsertMetaVersion()
String	getInsertMetaVersion() Returns the version of the Metathesaurus in which this source first appeared (IMETA).
Language	getLanguage() Returns the Language (LAT).
Language	getLat() Shorthand for getLanguage().
String	getLicenseContact() Returns the license contact information (SLC).
Date	getMend() Shorthand for getValidEndDate().
Date	getMstart() Shorthand for getValidStartDate().
String	getOfficialName() Returns the source official name (SON).
String	getRcui() Shorthand for getRootConceptIdentifier().
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() Shorthand for getRemoveMetaVersion()
String	getRootConceptIdentifier() Returns the concept identifier for the root SRC concept (VCUI).
String	getRootSourceAbbreviation() Returns the root source abbreviation (RSAB).
String	getRsab() Shorthand for getRootSourceAbbreviation().
String	getSabin() Returns the "in current subset" value (SABIN).
String	getScc() Shorthand for getContentContact().
String	getScit() Shorthand for getCitation().
String	getSf() Shorthand for getSourceFamily().
String	getShortName() Returns the source short name (SSN).
String	getSlc() Shorthand for getLicenseContact().
String	getSon() Shorthand for getOfficialName().
String	getSourceFamily() Returns the source family (SF).
String	getSrl() Shorthand for getRestrictionLevel().
String	getSsn() Shorthand for getShortName().
String	getSver() Shorthand for getVersion().
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() Shorthand for getTermFrequency()
String	getTtyl() Shorthand for getTermTypesAsString().
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() Shorthand for getVersionedConceptIdentifier().
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() Shorthand for (@ link #getVersionedSourceAbbreviation()}.
int	hashCode() Return a hash code based on key fields.
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceMetaDescriptionImpl

public SourceMetaDescriptionImpl()

Instantiates an empty SourceMetaDescriptionImpl.

SourceMetaDescriptionImpl

public SourceMetaDescriptionImpl(String mrsab_row)

Instantiates the SourceMetaDescription with the fields from a MRSAB row.

Parameters:

mrsab_row - row from MRSAB

Method Detail

getVcui

public String getVcui()

Shorthand for getVersionedConceptIdentifier().

Specified by:

getVcui in interface SourceMetaDescription

Returns:

the concept identifier for the versioned SRC concept

getVersionedConceptIdentifier

public String getVersionedConceptIdentifier()

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

Specified by:

getVersionedConceptIdentifier in interface SourceMetaDescription

Returns:

the concept identifier for the versioned SRC concept

getRcui

public String getRcui()

Shorthand for getRootConceptIdentifier().

Specified by:

getRcui in interface SourceMetaDescription

Returns:

the concept identifier for the root SRC concept

getRootConceptIdentifier

public String getRootConceptIdentifier()

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

Specified by:

getRootConceptIdentifier in interface SourceMetaDescription

Returns:

the concept identifier for the root SRC concept

getVsab

public String getVsab()

Shorthand for (@ link #getVersionedSourceAbbreviation()}.

Specified by:

getVsab in interface SourceMetaDescription

Returns:

the versioned source abbreviation

getVersionedSourceAbbreviation

public String getVersionedSourceAbbreviation()

Returns the versioned source abbreviation (VSAB).

Specified by:

getVersionedSourceAbbreviation in interface SourceMetaDescription

Returns:

the versioned source abbreviation

getRsab

public String getRsab()

Shorthand for getRootSourceAbbreviation().

Specified by:

getRsab in interface SourceMetaDescription

Returns:

the root source abbreviation

getRootSourceAbbreviation

public String getRootSourceAbbreviation()

Returns the root source abbreviation (RSAB).

Specified by:

getRootSourceAbbreviation in interface SourceMetaDescription

Returns:

the root source abbreviation

getSon

public String getSon()

Shorthand for getOfficialName().

Specified by:

getSon in interface SourceMetaDescription

Returns:

the source official name

getOfficialName

public String getOfficialName()

Returns the source official name (SON).

Specified by:

getOfficialName in interface SourceMetaDescription

Returns:

the source official name

getSsn

public String getSsn()

Shorthand for getShortName().

Specified by:

getSsn in interface SourceMetaDescription

Returns:

the source short name

getShortName

public String getShortName()

Returns the source short name (SSN).

Specified by:

getShortName in interface SourceMetaDescription

Returns:

the source short name

getScit

public String getScit()

Shorthand for getCitation().

Specified by:

getScit in interface SourceMetaDescription

Returns:

the source citation

getCitation

public String getCitation()

Returns the source citation (SCIT).

Specified by:

getCitation in interface SourceMetaDescription

Returns:

the source citation

getSf

public String getSf()

Shorthand for getSourceFamily().

Specified by:

getSf in interface SourceMetaDescription

Returns:

the source family

getSourceFamily

public String getSourceFamily()

Returns the source family (SF).

Specified by:

getSourceFamily in interface SourceMetaDescription

Returns:

the source family

getSver

public String getSver()

Shorthand for getVersion().

Specified by:

getSver in interface SourceMetaDescription

Returns:

the source version

getVersion

public String getVersion()

Returns source version (SVER).

Specified by:

getVersion in interface SourceMetaDescription

Returns:

the source version

getMstart

public Date getMstart()

Shorthand for getValidStartDate().

Specified by:

getMstart in interface SourceMetaDescription

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

Specified by:

getValidStartDate in interface SourceMetaDescription

Returns:

the date when this source becomes valid in the Metathesaurus

getMend

public Date getMend()

Shorthand for getValidEndDate().

Specified by:

getMend in interface SourceMetaDescription

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

Specified by:

getValidEndDate in interface SourceMetaDescription

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

Specified by:

getInsertMetaVersion in interface SourceMetaDescription

Returns:

the version of the Metathesaurus in which this source first appeared

getImeta

public String getImeta()

Shorthand for getInsertMetaVersion()

Specified by:

getImeta in interface SourceMetaDescription

Returns:

the version of the Metathesaurus in which this source first appeared

getRmeta

public String getRmeta()

Shorthand for getRemoveMetaVersion()

Specified by:

getRmeta in interface SourceMetaDescription

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

Specified by:

getRemoveMetaVersion in interface SourceMetaDescription

Returns:

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

getSlc

public String getSlc()

Shorthand for getLicenseContact().

Specified by:

getSlc in interface SourceMetaDescription

Returns:

the license contact information

getLicenseContact

public String getLicenseContact()

Returns the license contact information (SLC).

Specified by:

getLicenseContact in interface SourceMetaDescription

Returns:

the license contact information

getContentContact

public String getContentContact()

Returns the content contact information (SCC).

Specified by:

getContentContact in interface SourceMetaDescription

Returns:

the content contact information

getScc

public String getScc()

Shorthand for getContentContact().

Specified by:

getScc in interface SourceMetaDescription

Returns:

the content contact information

getSrl

public String getSrl()

Shorthand for getRestrictionLevel().

Specified by:

getSrl in interface SourceMetaDescription

Returns:

the restriction level

getRestrictionLevel

public String getRestrictionLevel()

Returns the restriction level (SRL).

Specified by:

getRestrictionLevel in interface SourceMetaDescription

Returns:

the restriction level

getTfr

public int getTfr()

Shorthand for getTermFrequency()

Specified by:

getTfr in interface SourceMetaDescription

Returns:

the frequency of terms

getTermFrequency

public int getTermFrequency()

Returns the frequency of terms (TFR).

Specified by:

getTermFrequency in interface SourceMetaDescription

Returns:

the frequency of terms

getCfr

public int getCfr()

Shorthand for getConceptFrequency()

Specified by:

getCfr in interface SourceMetaDescription

Returns:

the frequency of concepts

getConceptFrequency

public int getConceptFrequency()

Returns the frequency of concepts (CFR).

Specified by:

getConceptFrequency in interface SourceMetaDescription

Returns:

the frequency of concepts

getCxty

public String getCxty()

Shorthand for getContextType().

Specified by:

getCxty in interface SourceMetaDescription

Returns:

the context type

getContextType

public String getContextType()

Returns the context type (CXTY).

Specified by:

getContextType in interface SourceMetaDescription

Returns:

the context type

getTermTypes

public TermType[] getTermTypes()

Returns the TermTypes.

Specified by:

getTermTypes in interface SourceMetaDescription

Returns:

an array of TermTypes

getTermTypesAsList

public List getTermTypesAsList()

Returns the TermTypes as a List.

Specified by:

getTermTypesAsList in interface SourceMetaDescription

Returns:

the TermTypes as a List

getTtyl

public String getTtyl()

Shorthand for getTermTypesAsString().

Specified by:

getTtyl in interface SourceMetaDescription

Returns:

the term type values

getTermTypesAsString

public String getTermTypesAsString()

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

Specified by:

getTermTypesAsString in interface SourceMetaDescription

Returns:

the term type values

getAttributeNames

public AttributeName[] getAttributeNames()

Get the AttributeNames for this SourceMetaDescription. Returns the AttributeNames.

Specified by:

getAttributeNames in interface SourceMetaDescription

Returns:

an array of AttributeNames

getAttributeNamesAsList

public List getAttributeNamesAsList()

Returns the AttributeNames as a List.

Specified by:

getAttributeNamesAsList in interface SourceMetaDescription

Returns:

the AttributeNames as a List

getAtnl

public String getAtnl()

Shorthand for getAttributeNamesAsString().

Specified by:

getAtnl in interface SourceMetaDescription

Returns:

the attribute name values

getAttributeNamesAsString

public String getAttributeNamesAsString()

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

Specified by:

getAttributeNamesAsString in interface SourceMetaDescription

Returns:

the attribute name values

getLat

public Language getLat()

Shorthand for getLanguage().

Specified by:

getLat in interface SourceMetaDescription

Returns:

the Language

getLanguage

public Language getLanguage()

Returns the Language (LAT).

Specified by:

getLanguage in interface SourceMetaDescription

Returns:

the Language

getCenc

public String getCenc()

Shorthand for getCharacterEncoding().

Specified by:

getCenc in interface SourceMetaDescription

Returns:

the character encoding

getCharacterEncoding

public String getCharacterEncoding()

Returns the ISO character encoding (CENC).

Specified by:

getCharacterEncoding in interface SourceMetaDescription

Returns:

the character encoding

getCurver

public String getCurver()

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

Specified by:

getCurver in interface SourceMetaDescription

Returns:

the "is current version" value

isCurrentVersion

public boolean isCurrentVersion()

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

Specified by:

isCurrentVersion in interface SourceMetaDescription

Returns:

true if it does, false otherwise.

getSabin

public String getSabin()

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

Specified by:

getSabin in interface SourceMetaDescription

Returns:

the "in current subset" value

inCurrentSubset

public boolean inCurrentSubset()

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

Specified by:

inCurrentSubset in interface SourceMetaDescription

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.

Specified by:

setInCurrentSubset in interface SourceMetaDescription

Parameters:

sabin - boolean

setSabin

public void setSabin(String sabin)

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

Specified by:

setSabin in interface SourceMetaDescription

Parameters:

sabin - "in current subset" value

hashCode

public int hashCode()

Return a hash code based on key fields.

Overrides:

hashCode in class Object

Returns:

a hash code based on key fields

equals

public boolean equals(Object o)

Returns true if the specified object is equal to this object. The specified object must be a SourceMetaDescription with matching key fields.

Overrides:

equals in class Object

Parameters:

o - an Object to compare against

Returns:

boolean true if Object o is equal false otherwise

compareTo

public int compareTo(Object o)

Compares this SourceMetaDescription to another one. Results are indeterminate if the specified parameter is not of the same class.

Specified by:

compareTo in interface Comparable

Parameters:

o - the Object to compare to

Returns:

int representing the relative ordering of this and the compare-to object