gov.nih.nlm.nls.tc.Sti
Class SemanticTypes

java.lang.Object
  gov.nih.nlm.nls.tc.Sti.SemanticTypes

public class SemanticTypes
extends java.lang.Object

This class is to load Semantic Types from a flat file.

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

See Also:

Design Document

Field Summary

static int	BY_DOCUMENT
static int	BY_WORD

Constructor Summary

SemanticTypes(java.lang.String inFile)
Create the Semantic Types list object by specifying the input file.

SemanticTypes(java.lang.String inFile, boolean verbose)
Create the Semantic Types list object by specifying the input file and flag of verbose.

Method Summary

java.lang.String	GetAbbrByIndex(int index) Get ST abbreviation by specifying ST index.
java.lang.String	GetAbbrByName(java.lang.String name) Get ST abbreviation by specifying ST name.
java.lang.String	GetAbbrByTui(java.lang.String tui) Get ST abbreviation by specifying TUI.
int	GetIndexByAbbr(java.lang.String abbr) Get ST index by specifying ST abbreviation.
int	GetIndexByName(java.lang.String name) Get ST index by specifying ST name.
int	GetIndexByTui(java.lang.String tui) Get ST index by specifying TUI.
java.lang.String	GetNameByAbbr(java.lang.String abbr) Get ST name by specifying ST abbreviation.
java.lang.String	GetNameByIndex(int index) Get ST name by specifying ST index.
java.lang.String	GetNameByTui(java.lang.String tui) Get ST name by specifying TUI.
java.util.Hashtable<java.lang.String,SemanticType>	GetSemanticTypesByAbbr() Get the collection object (in hashtable) of all STs with key in abbreviation.
java.util.Hashtable<java.lang.Integer,SemanticType>	GetSemanticTypesByIndex() Get the collection object (in hashtable) of all STs with key in index.
java.util.Hashtable<java.lang.String,SemanticType>	GetSemanticTypesByName() Get the collection object (in hashtable) of all STs with key in name.
java.util.Hashtable<java.lang.String,SemanticType>	GetSemanticTypesByTui() Get the collection object (in hashtable) of all STs with key in TUI.
int	GetSize() Get the total number of semantic type from the ST list.
SemanticType	GetStByAbbr(java.lang.String abbr) Get ST object by specifying ST abbreviation.
SemanticType	GetStByIndex(int index) Get ST object by specifying ST index.
SemanticType	GetStByName(java.lang.String name) Get ST object by specifying ST name.
SemanticType	GetStByTui(java.lang.String tui) Get ST object by specifying TUI.
java.lang.String	GetTuiByAbbr(java.lang.String abbr) Get TUI by specifying ST abbreviation.
java.lang.String	GetTuiByIndex(int index) Get TUI by specifying ST index.
boolean	IsLegalStAbbr(java.lang.String abbr) Check if legal ST abbreviation
boolean	IsLegalStName(java.lang.String name) Check if legal ST name
static void	main(java.lang.String[] args)
void	ShowSts(java.io.BufferedWriter outWriter, boolean fileOutput) Show index, abbreviation, and full name of all Semantic Types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BY_WORD

public static final int BY_WORD

See Also:

Constant Field Values

BY_DOCUMENT

public static final int BY_DOCUMENT

See Also:

Constant Field Values

Constructor Detail

SemanticTypes

public SemanticTypes(java.lang.String inFile)

Create the Semantic Types list object by specifying the input file.

Parameters:

inFile - file name of Semantic Types (sts.txt)

SemanticTypes

public SemanticTypes(java.lang.String inFile,
                     boolean verbose)

Create the Semantic Types list object by specifying the input file and flag of verbose.

Parameters:

inFile - file name of Semantic Types (sts.txt)

verbose - flag of verbose on reading input file

Method Detail

GetSize

public int GetSize()

Get the total number of semantic type from the ST list.

Returns:

total number of Semantic Type from the ST list

GetStByIndex

public SemanticType GetStByIndex(int index)

Get ST object by specifying ST index.

Parameters:

index - ST index

Returns:

ST Java object

GetStByTui

public SemanticType GetStByTui(java.lang.String tui)

Get ST object by specifying TUI.

Parameters:

tui - TUI

Returns:

ST Java object

GetStByAbbr

public SemanticType GetStByAbbr(java.lang.String abbr)

Get ST object by specifying ST abbreviation.

Parameters:

abbr - ST abbreviation

Returns:

ST Java object

GetStByName

public SemanticType GetStByName(java.lang.String name)

Get ST object by specifying ST name.

Parameters:

name - ST name

Returns:

ST Java object

GetAbbrByIndex

public java.lang.String GetAbbrByIndex(int index)

Get ST abbreviation by specifying ST index.

Parameters:

index - ST index

Returns:

ST abbreviation

GetAbbrByTui

public java.lang.String GetAbbrByTui(java.lang.String tui)

Get ST abbreviation by specifying TUI.

Parameters:

tui - TUI

Returns:

ST abbreviation

GetNameByIndex

public java.lang.String GetNameByIndex(int index)

Get ST name by specifying ST index.

Parameters:

index - ST index

Returns:

ST name

GetNameByTui

public java.lang.String GetNameByTui(java.lang.String tui)

Get ST name by specifying TUI.

Parameters:

tui - TUI

Returns:

ST name

GetNameByAbbr

public java.lang.String GetNameByAbbr(java.lang.String abbr)

Get ST name by specifying ST abbreviation.

Parameters:

abbr - ST abbreviation

Returns:

ST name

GetIndexByAbbr

public int GetIndexByAbbr(java.lang.String abbr)

Get ST index by specifying ST abbreviation.

Parameters:

abbr - ST abbreviation

Returns:

ST index

GetIndexByTui

public int GetIndexByTui(java.lang.String tui)

Get ST index by specifying TUI.

Parameters:

tui - TUI

Returns:

ST index

GetTuiByAbbr

public java.lang.String GetTuiByAbbr(java.lang.String abbr)

Get TUI by specifying ST abbreviation.

Parameters:

abbr - ST abbreviation

Returns:

TUI

GetTuiByIndex

public java.lang.String GetTuiByIndex(int index)

Get TUI by specifying ST index.

Parameters:

index - ST index

Returns:

TUI

GetAbbrByName

public java.lang.String GetAbbrByName(java.lang.String name)

Get ST abbreviation by specifying ST name.

Parameters:

name - ST name

Returns:

ST abbreviation

GetIndexByName

public int GetIndexByName(java.lang.String name)

Get ST index by specifying ST name.

Parameters:

name - ST name

Returns:

ST index

GetSemanticTypesByIndex

public java.util.Hashtable<java.lang.Integer,SemanticType> GetSemanticTypesByIndex()

Get the collection object (in hashtable) of all STs with key in index.

Returns:

a hashtable of all STs with key in index

GetSemanticTypesByTui

public java.util.Hashtable<java.lang.String,SemanticType> GetSemanticTypesByTui()

Get the collection object (in hashtable) of all STs with key in TUI.

Returns:

a hashtable of all STs with key in TUI

GetSemanticTypesByAbbr

public java.util.Hashtable<java.lang.String,SemanticType> GetSemanticTypesByAbbr()

Get the collection object (in hashtable) of all STs with key in abbreviation.

Returns:

a hashtable of all STs with key in abbreviation

GetSemanticTypesByName

public java.util.Hashtable<java.lang.String,SemanticType> GetSemanticTypesByName()

Get the collection object (in hashtable) of all STs with key in name.

Returns:

a hashtable of all STs with key in name

IsLegalStAbbr

public boolean IsLegalStAbbr(java.lang.String abbr)

Check if legal ST abbreviation

Parameters:

abbr - ST abbreviation

Returns:

true for legal and false for illegal ST abbreviation

IsLegalStName

public boolean IsLegalStName(java.lang.String name)

Check if legal ST name

Parameters:

name - ST name

Returns:

true for legal and false for illegal ST name

ShowSts

public void ShowSts(java.io.BufferedWriter outWriter,
                    boolean fileOutput)

Show index, abbreviation, and full name of all Semantic Types.

Parameters:

outWriter - outfile buffer

fileOutput - boolean flag for file output

main

public static void main(java.lang.String[] args)