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

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

public class JdiHelp
extends java.lang.Object

This class is to print out JD index help menu.

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

Constructor Summary

JdiHelp()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JdiHelp

public JdiHelp()

Method Detail

JdiHelp

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

Print out jdi system help menu.

Parameters:

bw - buffer writer for Stdout or file out

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

InputFilterHelp

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

Print out input filter of Jdi 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 Jdi 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 Jdi output fields help menu. The format of Jdi outputs are: Rank | JD Scores | JD id | JD Name

LegalWordsFilterHelp

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

Print out Legal words filter of Jdi 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 is to run