DBVIEW
Public Member Functions | Static Public Attributes | Private Attributes
org.dbview.addons.output.table.utils.dot.CliOptions Class Reference

List of all members.

Public Member Functions

int getLayout () throws Exception
String getPath ()

Static Public Attributes

static final int LAYOUT_HORIZONTAL = 1
static final int LAYOUT_VERTICAL = 2
static final String LAYOUT = "-layout"
static final String PATH = "-path"

Private Attributes

String __layout = null
String __path = null

Detailed Description

This class defines command line options container for all DOT add-ons.

Remarks:
See Args4j. The command line options are declared in a class. We call this class the command line options container
Author:
Denis Beurive

Definition at line 35 of file CliOptions.java.

Member Function Documentation

int org.dbview.addons.output.table.utils.dot.CliOptions.getLayout ( ) throws Exception

This method returns the layout requested by the user.

Returns:
The method returns the layout requested by the user. The returned value may be:
Exceptions:
Exception

Definition at line 87 of file CliOptions.java.

String org.dbview.addons.output.table.utils.dot.CliOptions.getPath ( )

This method returns the path to the output file.

Returns:
This method returns the path to the output file.

Definition at line 101 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.dotFull.Cli._getConf_(), org.dbview.addons.output.table.dotMedium.Cli._getConf_(), and org.dbview.addons.output.table.dotLight.Cli._getConf_().

Member Data Documentation

String org.dbview.addons.output.table.utils.dot.CliOptions.__layout = null [private]

Layout. Possible values are:

  • "horizontal" (or "h")
  • "vertical" (or "v")

Definition at line 70 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.utils.dot.CliOptions.getLayout().

String org.dbview.addons.output.table.utils.dot.CliOptions.__path = null [private]

This option represents the path to the output file.

Definition at line 76 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.utils.dot.CliOptions.getPath().

final String org.dbview.addons.output.table.utils.dot.CliOptions.LAYOUT = "-layout" [static]

Command line parameter used to specify the layout. Possible values are:

  • "horizontal" (or "h")
  • "vertical" (or "v")

Definition at line 54 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.dotFull.Cli.getOptions(), org.dbview.addons.output.table.dotMedium.Cli.getOptions(), and org.dbview.addons.output.table.dotLight.Cli.getOptions().

final int org.dbview.addons.output.table.utils.dot.CliOptions.LAYOUT_HORIZONTAL = 1 [static]

This constant means that the users requests the horizontal layout.

Definition at line 40 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.utils.dot.CliOptions.getLayout().

final int org.dbview.addons.output.table.utils.dot.CliOptions.LAYOUT_VERTICAL = 2 [static]

This constant means that the users requests the vertical layout.

Definition at line 45 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.utils.dot.CliOptions.getLayout().

final String org.dbview.addons.output.table.utils.dot.CliOptions.PATH = "-path" [static]

This is a command line option. It represents the path of the output file.

Definition at line 60 of file CliOptions.java.

Referenced by org.dbview.addons.output.table.dotFull.Cli.getOptions(), org.dbview.addons.output.table.dotMedium.Cli.getOptions(), and org.dbview.addons.output.table.dotLight.Cli.getOptions().

The documentation for this class was generated from the following file: