gov.nih.nlm.umls.meta
Class AdditionalRelationshipLabel

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

All Implemented Interfaces:

ExpandedForm, Comparable

public final class AdditionalRelationshipLabel
extends AbstractExpandedForm

Represents an additional relationship label value. This class ensures that each unique additional relationship label 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

AdditionalRelationshipLabel()
Instantiates an empty AdditionalRelationshipLabel.

Method Summary

String	getAbbreviation() Returns the abbreviation.
static AdditionalRelationshipLabel	getAdditionalRelationshipLabel(String rela) Returns the AdditionalRelationshipLabel for the specified abbreviation.
static AdditionalRelationshipLabel[]	getAdditionalRelationshipLabels() Return all AdditionalRelationshipLabels.
static List	getAdditionalRelationshipLabelsAsList() Return all AdditionalRelationshipLabels as a List.
String	getDescription() Returns the description
static void	initialize(List meta_dsc) Initializes the Map used to track all of the AdditionalRelationshipLabels that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the AdditionalRelationshipLabels 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

AdditionalRelationshipLabel

public AdditionalRelationshipLabel()

Instantiates an empty AdditionalRelationshipLabel.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

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

Parameters:

meta_dsc - an array of MetaDescriptions

initialize

public static void initialize(List meta_dsc)

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

getAdditionalRelationshipLabel

public static AdditionalRelationshipLabel getAdditionalRelationshipLabel(String rela)

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

rela - the additional relationship label abbreviation to look up

Returns:

the AdditionalRelationshipLabel for the specified abbreviation

getAdditionalRelationshipLabels

public static AdditionalRelationshipLabel[] getAdditionalRelationshipLabels()

Return all AdditionalRelationshipLabels.

Returns:

an array of AdditionalRelationshipLabels

getAdditionalRelationshipLabelsAsList

public static List getAdditionalRelationshipLabelsAsList()

Return all AdditionalRelationshipLabels as a List.

Returns:

all AdditionalRelationshipLabels as a List

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description