|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nih.nlm.umls.meta.Source
Represents a UMLS source. This class ensures that each unique source is represented by a singleton object. In order for this to work correctly, the class must be properly initialized.
Constructor Summary | |
Source()
Instantiates an empty Source . |
Method Summary | |
int |
compareTo(Object o)
Compares this Source to another one. |
boolean |
equals(Object o)
Returns true if the specified object is
equal to this object. |
String |
getAtnl()
Returns the attribute names as a comma (,) separated list of attribute name abbreviations (ATNL). |
AttributeName[] |
getAttributeNames()
Get the AttributeName s for this Source . |
List |
getAttributeNamesAsList()
Returns the AttributeName s 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 citation information (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 citation information (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). |
static Source |
getSource(String sab)
Returns the Source for the specified versioned source abbreviation. |
String |
getSourceFamily()
Returns the source family (SF). |
static Source[] |
getSources()
Returns all Source s. |
static List |
getSourcesAsList()
Returns all Source s as a List . |
static List |
getSourcesForFamily(String family)
Returns the list of Source s for a specified source family. |
static Set |
getSourcesForFamilyAsSet(String family)
Returns the set of Source s for a specified source family. |
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 TermType s. |
List |
getTermTypesAsList()
Returns the TermType s 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). |
int |
hashCode()
Return a hash code based on key fields. |
boolean |
inCurrentSubset()
Indicates whether or not this source is represented in the current subset. |
static void |
initialize(List meta_dsc)
Initializes the Map used to track all of the
Source s that exist at one time. |
static void |
initialize(SourceMetaDescription[] meta_dsc)
Initializes the Map used to track all of the
Source s that exist at one time. |
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). |
String |
toString()
Returns the versioned source abbreviation (VSAB). |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Source()
Source
.
Method Detail |
public static void initialize(SourceMetaDescription[] meta_dsc)
Map
used to track all of the
Source
s that exist at one time.
meta_dsc
- an array of SourceMetaDescription
spublic static void initialize(List meta_dsc)
Map
used to track all of the
Source
s that exist at one time. This
is implemented as a call to initialize(SourceMetaDescription[])
.
meta_dsc
- an array of SourceMetaDescription
s
IllegalStateException
- if an attempt is made to call this
method more than oncepublic static Source getSource(String sab)
Source
for the specified versioned source abbreviation.
This method will return null
if the initialize
method has not been called or if the specified abbreviation
was not one of those used during initialization.
sab
- the specified versioned or versionless source abbreviation
Source
for the specified abbreviationpublic static Source[] getSources()
Source
s.
Source
public static List getSourcesAsList()
Source
s as a List
.
Source
s as a List
public String getVcui()
getVersionedConceptIdentifier()
.
getVcui
in interface SourceMetaDescription
public String getVersionedConceptIdentifier()
getVersionedConceptIdentifier
in interface SourceMetaDescription
public String getRcui()
getRootConceptIdentifier()
.
getRcui
in interface SourceMetaDescription
public String getRootConceptIdentifier()
getRootConceptIdentifier
in interface SourceMetaDescription
public String getVsab()
getVsab
in interface SourceMetaDescription
public String getVersionedSourceAbbreviation()
getVersionedSourceAbbreviation
in interface SourceMetaDescription
public String getRsab()
getRootSourceAbbreviation()
.
getRsab
in interface SourceMetaDescription
public String getRootSourceAbbreviation()
getRootSourceAbbreviation
in interface SourceMetaDescription
public String getSon()
getOfficialName()
.
getSon
in interface SourceMetaDescription
public String getOfficialName()
getOfficialName
in interface SourceMetaDescription
public String getSsn()
getShortName()
.
getSsn
in interface SourceMetaDescription
public String getShortName()
getShortName
in interface SourceMetaDescription
public String getSf()
getSourceFamily()
.
getSf
in interface SourceMetaDescription
public String getSourceFamily()
getSourceFamily
in interface SourceMetaDescription
public String getSver()
getVersion()
.
getSver
in interface SourceMetaDescription
public String getVersion()
getVersion
in interface SourceMetaDescription
public Date getMstart()
getValidStartDate()
.
getMstart
in interface SourceMetaDescription
public Date getValidStartDate()
getValidStartDate
in interface SourceMetaDescription
public Date getMend()
getValidEndDate()
.
getMend
in interface SourceMetaDescription
public Date getValidEndDate()
getValidEndDate
in interface SourceMetaDescription
public String getImeta()
getInsertMetaVersion()
getImeta
in interface SourceMetaDescription
public String getInsertMetaVersion()
getInsertMetaVersion
in interface SourceMetaDescription
public String getRmeta()
getRemoveMetaVersion()
getRmeta
in interface SourceMetaDescription
public String getRemoveMetaVersion()
getRemoveMetaVersion
in interface SourceMetaDescription
public String getSlc()
getLicenseContact()
.
getSlc
in interface SourceMetaDescription
public String getLicenseContact()
getLicenseContact
in interface SourceMetaDescription
public String getScit()
getCitation()
.
getScit
in interface SourceMetaDescription
public String getCitation()
getCitation
in interface SourceMetaDescription
public String getContentContact()
getContentContact()
.
getContentContact
in interface SourceMetaDescription
public String getScc()
getScc
in interface SourceMetaDescription
public String getSrl()
getRestrictionLevel()
.
getSrl
in interface SourceMetaDescription
public String getRestrictionLevel()
getRestrictionLevel
in interface SourceMetaDescription
public int getTfr()
getTermFrequency()
getTfr
in interface SourceMetaDescription
public int getTermFrequency()
getTermFrequency
in interface SourceMetaDescription
public int getCfr()
getConceptFrequency()
getCfr
in interface SourceMetaDescription
public int getConceptFrequency()
getConceptFrequency
in interface SourceMetaDescription
public String getCxty()
getContextType()
.
getCxty
in interface SourceMetaDescription
public String getContextType()
getContextType
in interface SourceMetaDescription
public TermType[] getTermTypes()
TermType
s.
getTermTypes
in interface SourceMetaDescription
TermType
spublic List getTermTypesAsList()
TermType
s as a List
.
getTermTypesAsList
in interface SourceMetaDescription
TermType
s as a List
public String getTtyl()
getTermTypesAsString()
.
getTtyl
in interface SourceMetaDescription
public String getTermTypesAsString()
getTermTypesAsString
in interface SourceMetaDescription
public AttributeName[] getAttributeNames()
AttributeName
s for this Source
.
Returns the AttributeName
s.
getAttributeNames
in interface SourceMetaDescription
AttributeName
spublic List getAttributeNamesAsList()
AttributeName
s as a List
.
getAttributeNamesAsList
in interface SourceMetaDescription
AttributeName
s as a List
public String getAtnl()
getAttributeNamesAsString()
.
getAtnl
in interface SourceMetaDescription
public String getAttributeNamesAsString()
getAttributeNamesAsString
in interface SourceMetaDescription
public Language getLat()
Language
(LAT).
This is shorthand for getLanguage()
.
getLat
in interface SourceMetaDescription
Language
public Language getLanguage()
Language
(LAT).
getLanguage
in interface SourceMetaDescription
Language
public String getCenc()
getCharacterEncoding()
.
getCenc
in interface SourceMetaDescription
public String getCharacterEncoding()
getCharacterEncoding
in interface SourceMetaDescription
public String getCurver()
getCurver
in interface SourceMetaDescription
public boolean isCurrentVersion()
isCurrentVersion
in interface SourceMetaDescription
true
if it does, false
otherwise.public String getSabin()
getSabin
in interface SourceMetaDescription
public void setInCurrentSubset(boolean sabin)
setInCurrentSubset
in interface SourceMetaDescription
sabin
- boolean
public void setSabin(String sabin)
setSabin
in interface SourceMetaDescription
sabin
- "in current subset" valuepublic boolean inCurrentSubset()
inCurrentSubset
in interface SourceMetaDescription
true
if it is, false
otherwise.public int hashCode()
public boolean equals(Object o)
true
if the specified object is
equal to this object. The specified object must be an
Source
with matching key fields.
o
- an Object
to compare against
true
if Object o is equal
false
otherwisepublic int compareTo(Object o)
Source
to another one. Results
are indeterminate if the specified parameter is not of the
same class.
compareTo
in interface Comparable
o
- the Object
to compare to
int
representing the relative ordering
of this and the compare-to objectpublic static List getSourcesForFamily(String family)
Source
s for a specified source family.
family
- a source family, e.g. MSH
List
of Source
s for a specified source family.public static Set getSourcesForFamilyAsSet(String family)
Source
s for a specified source family.
family
- a source family, e.g. MSH
Set
of Source
s for a specified source family.public String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |