gov.nih.nlm.umls.meta
Class TermStatus

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

All Implemented Interfaces:

ExpandedForm, Comparable

public final class TermStatus
extends AbstractExpandedForm

Represents an term status. This class ensures that each unique string 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

TermStatus()
Instantiates an empty TermStatus.

Method Summary

String	getAbbreviation() Returns the abbreviation.
String	getDescription() Returns the description
static TermStatus	getTermStatus(String ts) Returns the TermStatus for the specified abbreviation.
static List	getTermStatusAsList() Return all TermStatus values.
static TermStatus[]	getTermStatuses() Return all TermStatus values.
static void	initialize(List meta_dsc) Initializes the Map used to track all of the TermStatuses that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the TermStatuses 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

TermStatus

public TermStatus()

Instantiates an empty TermStatus.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

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

Parameters:

meta_dsc - an array of MetaDescriptions

initialize

public static void initialize(List meta_dsc)

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

Parameters:

meta_dsc - an array of MetaDescriptions

Throws:

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

getTermStatus

public static TermStatus getTermStatus(String ts)

Returns the TermStatus 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:

ts - the term status abbreviation to look up

Returns:

the TermStatus for the specified abbreviation

getTermStatuses

public static TermStatus[] getTermStatuses()

Return all TermStatus values.

Returns:

an array of TermStatus

getTermStatusAsList

public static List getTermStatusAsList()

Return all TermStatus values.

Returns:

all TermStatus values

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description