CliOptions

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.clichart.main
Class CliOptions

java.lang.Object
  net.sf.clichart.main.CliOptions

All Implemented Interfaces:: Options

public class CliOptions
extends java.lang.Object
implements Options
extends java.lang.Object
implements Options

Options implementation for options provided on the command-line, and parsed using commons CLI

Author:: johnd

Field Summary

Fields inherited from interface net.sf.clichart.chart.Options
`DATA_SEP_CSV, DATA_SEP_WHITE_SPACE, DEFAULT_COLUMN_INDEXES, DEFAULT_DATA_SEP, DEFAULT_DATE_FORMAT, DEFAULT_HEIGHT, DEFAULT_WIDTH, DEFAULT_X_TYPE, X_TYPE_DATE_TIME, X_TYPE_NONE, X_TYPE_VALUE`

Constructor Summary
`CliOptions(org.apache.commons.cli.CommandLine commandLine)`

Method Summary
`boolean`	`forceSecondAxisYRange()` If set, force use of the minimum and maximum Y values provided for the second axis
`boolean`	`forceYRange()` If set, force use of the minimum and maximum Y values provided
`int`	`getChartHeight()` Return the height of the chart in pixels
`java.lang.String`	`getChartTitle()` Return the title for the graph, or null if not set
`int`	`getChartWidth()` Return the width of the chart in pixels
`java.lang.String`	`getChartXAxisTitle()` Return the title for the X axis, or null if not set
`int`	`getChartXType()` Return the type of X axis - date/time, value or none
`java.lang.String`	`getChartYAxisTitle()` Return the title for the y axis, or null if not set
`java.util.List<ColourOverride>`	`getColourOverrides()` Return any colour overrides set for columns (may be null)
`int[]`	`getColumnIndexes()` Return the list of column indexes required from the data provided
`int`	`getDataSeparatorType()` Returns the data separator (CSV)
`java.lang.String`	`getDateFormat()` Returns the date format string for parsing date/times
`java.lang.String`	`getFileOutputPath()` Path to which chart should be saved - null if should show in UI
`java.lang.String`	`getInputPath()` Return the input path to read data from, or null if should read from stdin
`int`	`getLineWeight()` Return required line weight for first axis, on a scale of 1 - 5
`int`	`getListenPort()` Return the port number on which the CLI server should listen.
`java.lang.Integer`	`getMaxYValue()` Return the max Y value for the chart, or null if not set
`java.lang.Integer`	`getMinYValue()` Return the min Y value for the chart, or null if not set
`java.lang.String`	`getSecondAxisChartYAxisTitle()` Return the title for the second y axis, or null if not set
`int[]`	`getSecondAxisColumnIndexes()` Return the list of column indexes required for the second axis (if any) from the data provided, or null if none
`int`	`getSecondAxisLineWeight()` Return required line weight for second axis, on a scale of 1 - 5
`java.lang.Integer`	`getSecondAxisMaxYValue()` Return the max Y value for the second axis for the chart, or null if not set
`java.lang.Integer`	`getSecondAxisMinYValue()` Return the min Y value for the second axis for the chart, or null if not set
`java.lang.String[]`	`getSecondAxisSeriesTitles()` Return the titles for each of the second Y axis data series, or null if not set
`java.lang.String[]`	`getSeriesTitles()` Return the titles for each of the first Y axis data series, or null if not set
`boolean`	`hasDataPoints()` Return true if line shapes should be rendered for the first axis
`boolean`	`hasHeaderRow()` Return true if the first row of the data is a header (this will be used for column titles)
`boolean`	`hasSecondAxisDataPoints()` Return true if line shapes should be rendered for the second axis
`boolean`	`ignoreDuplicateValues()` Return true if exceptions for adding duplicate X axis values should be swallowed (with an appropriate message)
`boolean`	`ignoreEmptyColumns()` Return true if empty column values in the data should be ignored (with an appropriate message)
`boolean`	`ignoreMissingColumns()` Return true if missing columns in the data should be ignored (with an appropriate message)
`boolean`	`isBarChart()` Return true if the main axis should be a bar chart, rather than X-Y
`boolean`	`isCliServer()` Return true if clichart should act as a CLI server, to be driven by a script
`boolean`	`isSecondAxisBarChart()` Return true if the second axis should be a bar chart, rather than X-Y

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CliOptions

public CliOptions(org.apache.commons.cli.CommandLine commandLine)
           throws InvalidOptionsException,
                  ShowUsageException

Throws:: InvalidOptionsException; ShowUsageException

Method Detail