gov.nih.nlm.umls.meta
Class RelationshipLabel

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

All Implemented Interfaces:

ExpandedForm, Comparable

public final class RelationshipLabel
extends AbstractExpandedForm

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

RelationshipLabel()
Instantiates an empty RelationshipLabel.

Method Summary

String	getAbbreviation() Returns the abbreviation.
String	getDescription() Returns the description
static RelationshipLabel	getRelationshipLabel(String rel) Returns the RelationshipLabel for the specified abbreviation.
static RelationshipLabel[]	getRelationshipLabels() Return all RelationshipLabels.
static List	getRelationshipLabelsAsList() Return all RelationshipLabels as a List.
static void	initialize(List meta_dsc) Initializes the Map used to track all of the RelationshipLabels that exist at one time.
static void	initialize(MetaDescription[] meta_dsc) Initializes the Map used to track all of the RelationshipLabels 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

RelationshipLabel

public RelationshipLabel()

Instantiates an empty RelationshipLabel.

Method Detail

initialize

public static void initialize(MetaDescription[] meta_dsc)

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

Parameters:

meta_dsc - an array of MetaDescriptions

initialize

public static void initialize(List meta_dsc)

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

getRelationshipLabel

public static RelationshipLabel getRelationshipLabel(String rel)

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

rel - the relationship label abbreviation to look up

Returns:

the RelationshipLabel for the specified abbreviation

getRelationshipLabels

public static RelationshipLabel[] getRelationshipLabels()

Return all RelationshipLabels.

Returns:

an array of RelationshipLabels

getRelationshipLabelsAsList

public static List getRelationshipLabelsAsList()

Return all RelationshipLabels as a List.

Returns:

all RelationshipLabels as a List

getAbbreviation

public String getAbbreviation()

Returns the abbreviation.

Returns:

the abbreviation

getDescription

public String getDescription()

Returns the description

Returns:

the description