gov.nih.nlm.nls.lvg.Api

Class LvgHelp

java.lang.Object

gov.nih.nlm.nls.lvg.Api.LvgHelp

public class LvgHelp
extends java.lang.Object

This class prints out all help menu for LVG command line syntax.

This class should be modified to become file driven in the future (TBD).

History:

Version:

V-2020

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
LvgHelp()

Method Summary

Modifier and Type	Method and Description
static void	FlowHelp(java.io.BufferedWriter bw, boolean fileOutput, Out out) Print out the help menu of Lvg flow components.
static void	LvgHelp(java.io.BufferedWriter bw, boolean fileOutput, Out out) Print out Lvg system help menu.
static void	OutputFieldHelp(java.io.BufferedWriter bw, boolean fileOutput, Out out) Print out the Lvg output fields help menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

LvgHelp

public LvgHelp()

Method Detail

LvgHelp

public static void LvgHelp(java.io.BufferedWriter bw,
                           boolean fileOutput,
                           Out out)

Print out Lvg system help menu.

The option flags and command executions are defined in the classes of Flow and LvgCmdApi, respectively.

Parameters:

bw - buffer writer for Stdout or file out

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

out - out object

See Also:

Flow, LvgCmdApi, Design Document

OutputFieldHelp

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

Print out the Lvg output fields help menu. The format of Lvg outputs are: in term | out term | categories | inflections | flow history | flow number | additional mutation information |

Parameters:

bw - buffer writer for Stdout or file out

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

out - out object

FlowHelp

public static void FlowHelp(java.io.BufferedWriter bw,
                            boolean fileOutput,
                            Out out)

Print out the help menu of Lvg flow components.

Parameters:

bw - buffer writer for Stdout or file out

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

out - out object

See Also:

Design Document