gov.nih.nlm.umls.meta
Interface STYMetaDescription

All Superinterfaces:

Comparable

All Known Implementing Classes:

HierarchicalSemanticType, STYMetaDescriptionImpl

public interface STYMetaDescription

extends Comparable

Represents metadata about semantic network semantic types.

Author:

Brian Carlsen, Deborah Shapiro

Method Summary

boolean	allowsNonHumanFlag() Indicates whether or not this semantic type or its descendents allow the non human flag.
String	getDef() Returns the definition (DEF).
String	getDefinition() Returns the definition (DEF).
String	getEx() Returns a semi-colon (;) separated list of Metathesaurus strings (EX) which are examples of this semantic type.
String[]	getExamples() Returns a String array of of Metathesaurus strings (EX) which are examples of this semantic type.
List	getExamplesAsList() Returns a List array of of Metathesaurus strings (EX) which are examples of this semantic type.
String	getExamplesAsString() Returns a semi-colon (;) separated list of Metathesaurus strings (EX) which are examples of this semantic type.
String	getIdentifier() Returns the unique identifier (UI).
String	getName() Returns the name (STY).
String	getNH() Returns the non human flag value (NH).
String	getStn() Returns the tree number (STN).
String	getSty() Returns the name (STY).
String	getTreeNumber() Returns the tree number (STN).
String	getUi() Returns the unique identifier (UI).
String	getUn() Returns the usage note (UN).
String	getUsageNote() Returns the usage note (UN).

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getUi

public String getUi()

Returns the unique identifier (UI). This is shorthand for getIdentifier().

Returns:

the unique identifier

getIdentifier

public String getIdentifier()

Returns the unique identifier (UI).

Returns:

the unique identifier

getSty

public String getSty()

Returns the name (STY). This is shorthand for getName().

Returns:

the name

getName

public String getName()

Returns the name (STY).

Returns:

the name

getStn

public String getStn()

Returns the tree number (STN). This is shorthand for getTreeNumber().

Returns:

the tree number

getTreeNumber

public String getTreeNumber()

Returns the tree number (STN).

Returns:

the tree number

getDef

public String getDef()

Returns the definition (DEF). This is shorthand for getDefinition().

Returns:

the definition

getDefinition

public String getDefinition()

Returns the definition (DEF).

Returns:

the definition

getEx

public String getEx()

Returns a semi-colon (;) separated list of Metathesaurus strings (EX) which are examples of this semantic type. This is shorthand for getExamplesAsString().

Returns:

a value listing Metathesaurus examples

getExamples

public String[] getExamples()

Returns a String array of of Metathesaurus strings (EX) which are examples of this semantic type.

Returns:

an String array of Metathesaurus examples

getExamplesAsString

public String getExamplesAsString()

Returns a semi-colon (;) separated list of Metathesaurus strings (EX) which are examples of this semantic type. This is shorthand for getExamplesAsString().

Returns:

a value listing Metathesaurus examples

getExamplesAsList

public List getExamplesAsList()

Returns a List array of of Metathesaurus strings (EX) which are examples of this semantic type.

Returns:

an List of Metathesaurus examples

getUn

public String getUn()

Returns the usage note (UN). This is shorthand for getUsageNote().

Returns:

the usage note

getUsageNote

public String getUsageNote()

Returns the usage note (UN).

Returns:

the usage note

allowsNonHumanFlag

public boolean allowsNonHumanFlag()

Indicates whether or not this semantic type or its descendents allow the non human flag.

Returns:

true if allowed, false if not

getNH

public String getNH()

Returns the non human flag value (NH).

Returns:

the non human flag value