gov.nih.nlm.umls.meta
Class Suppressible

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

All Implemented Interfaces:

ExpandedForm, Comparable

public final class Suppressible
extends AbstractExpandedForm

Represents a suppressible value. This class ensures that each unique suppressible value 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

Suppressible()
Instantiates an empty Suppressible.

Method Summary

String	getAbbreviation() Returns the abbreviation.
String	getDescription() Returns the description
static Suppressible	getSuppressible(String sup_abrev) Returns the Suppressible for the specified abbreviation.
static Suppressible[]	getSuppressibles() Return all Suppressibles.
static List	getSuppressiblesAsList() Return all Suppressibles as a List.
static void	initialize(List meta_dsc) Initializes the Map used to track all of the Suppressibles that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the Suppressibles 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

Suppressible

public Suppressible()

Instantiates an empty Suppressible.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

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

Parameters:

meta_dsc - an array of MetaDescriptions

initialize

public static void initialize(List meta_dsc)

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

getSuppressible

public static Suppressible getSuppressible(String sup_abrev)

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

sup_abrev - the suppressible abbreviation to look up

Returns:

the Suppressible for the specified abbreviation

getSuppressibles

public static Suppressible[] getSuppressibles()

Return all Suppressibles.

Returns:

an array of Suppressibles

getSuppressiblesAsList

public static List getSuppressiblesAsList()

Return all Suppressibles as a List.

Returns:

all Suppressibles as a List

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description