gov.nih.nlm.umls.meta
Class TermType

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

All Implemented Interfaces:

ExpandedForm, Comparable

public final class TermType
extends AbstractExpandedForm

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

TermType()
Instantiates an empty TermType.

Method Summary

String	getAbbreviation() Returns the abbreviation.
String	getDescription() Returns the description
static TermType	getTermType(String tty) Returns the TermType for the specified abbreviation.
static TermType[]	getTermTypes() Return all TermTypes.
static List	getTermTypesAsList() Return all TermTypes as a List.
static void	initialize(List meta_dsc) Initializes the Map used to track all of the TermTypes that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the TermTypes 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

TermType

public TermType()

Instantiates an empty TermType.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

Initializes the Map used to track all of the TermTypes that exist at one time. You may pass all MetaDescriptions as this method only creates TermTypes 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 TermTypes that exist at one time. This is implemented as a call to initialize(MetaDescription[]).

Parameters:

meta_dsc - an array of MetaDescriptions

getTermType

public static TermType getTermType(String tty)

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

tty - the term type abbreviation to look up

Returns:

the TermType for the specified abbreviation

getTermTypes

public static TermType[] getTermTypes()

Return all TermTypes.

Returns:

an array of TermTypes

getTermTypesAsList

public static List getTermTypesAsList()

Return all TermTypes as a List.

Returns:

all TermTypes as a List

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description