gov.nih.nlm.nls.tc.Tools
Class StiHelp

java.lang.Object
  gov.nih.nlm.nls.tc.Tools.StiHelp

public class StiHelp
extends java.lang.Object

This class is to print out ST index help menu.

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

Constructor Summary

StiHelp()

Method Summary

static void	InputFilterHelp(java.io.BufferedWriter bw, boolean fileOutput) Print out input filter of Sti system help menu.
static void	LegalWordsFilterHelp(java.io.BufferedWriter bw, boolean fileOutput, java.lang.String version) Print out Legal words filter of Sti system help menu.
static void	OutputFieldHelp(java.io.BufferedWriter bw, boolean fileOutput) Print out the Sti output fields help menu.
static void	OutputFilterHelp(java.io.BufferedWriter bw, boolean fileOutput) Print out output filter of Sti system help menu.
static void	StiHelp(java.io.BufferedWriter bw, boolean fileOutput) Print out Sti system help menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

StiHelp

public StiHelp()

Method Detail

StiHelp

public static void StiHelp(java.io.BufferedWriter bw,
                           boolean fileOutput)

Print out Sti system help menu.

Parameters:

bw - buffer writer for Stdout or file out

fileOutput - a flag to indicate if the bw is a file output

OutputFieldHelp

public static void OutputFieldHelp(java.io.BufferedWriter bw,
                                   boolean fileOutput)

Print out the Sti output fields help menu. The format of Sti outputs are: Rank | ST Scores | ST Abbreviation | TUI | ST Name

InputFilterHelp

public static void InputFilterHelp(java.io.BufferedWriter bw,
                                   boolean fileOutput)

Print out input filter of Sti system help menu.

Parameters:

bw - buffer writer for Stdout or file out

fileOutput - a flag to indicate if the bw is a file output

OutputFilterHelp

public static void OutputFilterHelp(java.io.BufferedWriter bw,
                                    boolean fileOutput)

Print out output filter of Sti system help menu.

Parameters:

bw - buffer writer for Stdout or file out

fileOutput - a flag to indicate if the bw is a file output

LegalWordsFilterHelp

public static void LegalWordsFilterHelp(java.io.BufferedWriter bw,
                                        boolean fileOutput,
                                        java.lang.String version)

Print out Legal words filter of Sti system help menu.

Parameters:

bw - buffer writer for Stdout or file out

fileOutput - a flag to indicate if the bw is a file output

version - the specified version to run