gov.nih.nlm.umls.meta
Class SourceIdentifierType

java.lang.Object
  gov.nih.nlm.umls.meta.AbstractExpandedForm
      gov.nih.nlm.umls.meta.SourceIdentifierType

All Implemented Interfaces:

ExpandedForm, Comparable

public final class SourceIdentifierType
extends AbstractExpandedForm

Represents information about a the type of a MapObject's expression. This class ensures that each unique expression type is represented by a singleton object. In order for this to work correctly, the class must be properly initialized.

Author:

Brian Carlsen, Deborah Shapiro

Constructor Summary

SourceIdentifierType()
Instantiates an empty SourceIdentifierType.

Method Summary

String	getAbbreviation() Returns the abbreviation.
String	getDescription() Returns the description
static SourceIdentifierType	getSourceIdentifierType(String met) Returns the SourceIdentifierType for the specified abbreviation.
static SourceIdentifierType[]	getSourceIdentifierTypes() Return all SourceIdentifierTypes.
static List	getSourceIdentifierTypesAsList() Return all SourceIdentifierTypes as a List.
static void	initialize(List meta_dsc) Initializes the Map used to track all of the SourceIdentifierTypes that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the SourceIdentifierTypes that exist at one time.

Methods inherited from class gov.nih.nlm.umls.meta.AbstractExpandedForm

compareTo, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceIdentifierType

public SourceIdentifierType()

Instantiates an empty SourceIdentifierType.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

Initializes the Map used to track all of the SourceIdentifierTypes that exist at one time. You may pass all MetaDescriptions as this method only creates SourceIdentifierTypes for those with a type of "TTY".

Parameters:

meta_dsc - an array of MetaDescriptions

Throws:

IllegalStateException - if an attempt is made to call this method more than once

initialize

public static void initialize(List meta_dsc)

Initializes the Map used to track all of the SourceIdentifierTypes that exist at one time. This is implemented as a call to initialize(MetaDescription[]).

Parameters:

meta_dsc - an array of MetaDescriptions

getSourceIdentifierType

public static SourceIdentifierType getSourceIdentifierType(String met)

Returns the SourceIdentifierType for the specified 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.

Parameters:

met - the term type abbreviation to look up

Returns:

the SourceIdentifierType for the specified abbreviation

getSourceIdentifierTypes

public static SourceIdentifierType[] getSourceIdentifierTypes()

Return all SourceIdentifierTypes.

Returns:

an array of SourceIdentifierTypes

getSourceIdentifierTypesAsList

public static List getSourceIdentifierTypesAsList()

Return all SourceIdentifierTypes as a List.

Returns:

all SourceIdentifierTypes as a List

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description