gov.nih.nlm.umls.meta
Class CoocurrenceType

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

All Implemented Interfaces:

ExpandedForm, Comparable

public final class CoocurrenceType
extends AbstractExpandedForm

Represents a type of coocurrence. This class ensures that each unique coocurrence 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

CoocurrenceType()
Instantiates an empty CoocurrenceType.

Method Summary

String	getAbbreviation() Returns the abbreviation.
static CoocurrenceType	getCoocurrenceType(String cot) Returns the CoocurrenceType for the specified abbreviation.
static CoocurrenceType[]	getCoocurrenceTypes() Return an array of all CoocurrenceTypes.
static List	getCoocurrenceTypesAsList() Return an List of all CoocurrenceTypes.
String	getDescription() Returns the description
static void	initialize(List meta_dsc) Initializes the Map used to track all of the CoocurrenceTypes that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the CoocurrenceTypes 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

CoocurrenceType

public CoocurrenceType()

Instantiates an empty CoocurrenceType.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

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

Parameters:

meta_dsc - an array of MetaDescriptions

initialize

public static void initialize(List meta_dsc)

Initializes the Map used to track all of the CoocurrenceTypes 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

getCoocurrenceType

public static CoocurrenceType getCoocurrenceType(String cot)

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

cot - the coocurrence type abbreviation to look up

Returns:

the CoocurrenceType for the specified abbreviation

getCoocurrenceTypes

public static CoocurrenceType[] getCoocurrenceTypes()

Return an array of all CoocurrenceTypes.

Returns:

CoocurrenceType []

getCoocurrenceTypesAsList

public static List getCoocurrenceTypesAsList()

Return an List of all CoocurrenceTypes.

Returns:

an List of all CoocurrenceTypes

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description