gov.nih.nlm.nls.tc.Jdi
Class Subheadings

java.lang.Object
  gov.nih.nlm.nls.tc.Jdi.Subheadings

public class Subheadings
extends java.lang.Object

This class is to load MeSH Subheadings from a flat file.

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

See Also:

Design Document

Constructor Summary

Subheadings(java.lang.String inFile)
Create the MeSH Subheadings List object by specifying the input file.

Subheadings(java.lang.String inFile, boolean verbose)
Create the MeSH Subheadings List object by specifying the input file and flag of verbose.

Method Summary

java.lang.String	GetAbbreviation(java.lang.String name) Get MeSH subheading abbreviation by specifying full name or short name.
java.lang.String	GetAbbreviationByFullName(java.lang.String fullName) Get MeSH subheading abbreviation by specifying full name.
java.lang.String	GetAbbreviationByShortName(java.lang.String shortName) Get MeSH subheading abbreviation by specifying short name.
Subheading	GetSubheadingByFullName(java.lang.String fullName) Get MeSH subheading Java object by specifying full name.
Subheading	GetSubheadingByShortName(java.lang.String shortName) Get MeSH subheading Java object by specifying short name.
java.util.Hashtable<java.lang.String,Subheading>	GetSubheadingsByAbbr() Get the collection object (in hashtable) of all MeSH subheadings with key in abbreviation.
java.util.Hashtable<java.lang.String,Subheading>	GetSubheadingsByFullName() Get the collection object (in hashtable) of all MeSH subheadings with key in full name.
java.util.Hashtable<java.lang.String,Subheading>	GetSubheadingsByShortName() Get the collection object (in hashtable) of all MeSH subheadings with key in short name.
boolean	IsAbbreviation(java.lang.String shAbbr) Check if a string is a abbreviation of MeSH subheading
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

Subheadings

public Subheadings(java.lang.String inFile)

Create the MeSH Subheadings List object by specifying the input file.

Parameters:

inFile - file name of MeSH subheadings (shs.txt)

Subheadings

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

Create the MeSH Subheadings List object by specifying the input file and flag of verbose.

Parameters:

inFile - file name of MeSH subheadings (shs.txt)

verbose - flag of verbose on reading input file

Method Detail

GetSubheadingByShortName

public Subheading GetSubheadingByShortName(java.lang.String shortName)

Get MeSH subheading Java object by specifying short name.

Parameters:

shortName - short name of MeSH subheading

Returns:

MeSH subheading Java object

GetSubheadingByFullName

public Subheading GetSubheadingByFullName(java.lang.String fullName)

Get MeSH subheading Java object by specifying full name.

Parameters:

fullName - full name of MeSH subheading

Returns:

MeSH subheading Java object

GetAbbreviationByShortName

public java.lang.String GetAbbreviationByShortName(java.lang.String shortName)

Get MeSH subheading abbreviation by specifying short name.

Parameters:

shortName - short name of MeSH subheading

Returns:

abbreviation of MeSH subheading

GetAbbreviationByFullName

public java.lang.String GetAbbreviationByFullName(java.lang.String fullName)

Get MeSH subheading abbreviation by specifying full name.

Parameters:

fullName - full name of MeSH subheading

Returns:

abbreviation of MeSH subheading

GetAbbreviation

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

Get MeSH subheading abbreviation by specifying full name or short name.

Parameters:

name - full name or short name of MeSH subheading

Returns:

abbreviation of MeSH subheading

GetSubheadingsByAbbr

public java.util.Hashtable<java.lang.String,Subheading> GetSubheadingsByAbbr()

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

Returns:

a hashtable of all MeSH subheadings with key in abbreviation.

GetSubheadingsByShortName

public java.util.Hashtable<java.lang.String,Subheading> GetSubheadingsByShortName()

Get the collection object (in hashtable) of all MeSH subheadings with key in short name.

Returns:

a hashtable of all MeSH subheadings with key in short name.

GetSubheadingsByFullName

public java.util.Hashtable<java.lang.String,Subheading> GetSubheadingsByFullName()

Get the collection object (in hashtable) of all MeSH subheadings with key in full name.

Returns:

a hashtable of all MeSH subheadings with key in full name.

IsAbbreviation

public boolean IsAbbreviation(java.lang.String shAbbr)

Check if a string is a abbreviation of MeSH subheading

Parameters:

shAbbr - string to be checked

Returns:

true if an abbreviation of MeSH subheading; false if not an abbreviation of MeSH subheading;

main

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