org.norther.tammi.sprig.chart
Interface ChartGenerator

All Superinterfaces:

Configurable

All Known Subinterfaces:

JFreeCharts

All Known Implementing Classes:

AbstractChartGenerator, DefaultJFreeCharts

public interface ChartGenerator
extends Configurable

An interface to chart generators.

Author:

Ilkka Priha

Field Summary

static int	BY_COLUMN The column based model order.
static int	BY_ROW The row based model order.

Method Summary

Encoder	createEncoder(String extension) Creates a new empty encoder.
ChartLayout	generate(ChartModel[] data, int type, int orientation) Generates a layout from the specified models.
ChartLayout	generate(ChartModel[] data, int type, int orientation, int order, int index) Generates an ordered layout from the specified models.
ChartLayout	generate(ChartModel data, int type, int orientation) Generates a layout from the specified model.
ChartLayout	generate(ChartModel data, int type, int orientation, int order, int index) Generates an ordered layout from the specified model.
String	getEncoderClassName(String extension) Gets the class name of the specified encoder.
void	removeEncoderClassName(String extension) Removes the class name of the specified encoder.
void	setEncoderClassName(String extension, String className) Sets the class name of the specified encoder.

Methods inherited from interface org.norther.tammi.core.config.Configurable

addProperty, addProperty, clearProperties, containsProperty, getConfigKey, getProperties, getProperty, getPropertyFilePath, indexOfProperty, propertyMap, propertyMap, removeProperty, removeProperty, setConfigKey, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, storeProperties

Field Detail

BY_COLUMN

static final int BY_COLUMN

The column based model order.

See Also:

Constant Field Values

BY_ROW

static final int BY_ROW

The row based model order.

See Also:

Constant Field Values

Method Detail

generate

ChartLayout generate(ChartModel data,
                     int type,
                     int orientation)
                     throws LogException

Generates a layout from the specified model.

Parameters:

data - the data model.

type - the chart type.

orientation - the orientation.

Returns:

the generated layout.

Throws:

LogException - on errors.

generate

ChartLayout generate(ChartModel[] data,
                     int type,
                     int orientation)
                     throws LogException

Generates a layout from the specified models.

Parameters:

data - the data models.

type - the chart type.

orientation - the orientation.

Returns:

the generated layout.

Throws:

LogException - on errors.

generate

ChartLayout generate(ChartModel data,
                     int type,
                     int orientation,
                     int order,
                     int index)
                     throws LogException

Generates an ordered layout from the specified model.

Parameters:

data - the data model.

type - the chart type.

orientation - the orientation.

order - the model order.

index - the model index.

Returns:

the generated layout.

Throws:

LogException - on errors.

generate

ChartLayout generate(ChartModel[] data,
                     int type,
                     int orientation,
                     int order,
                     int index)
                     throws LogException

Generates an ordered layout from the specified models.

Parameters:

data - the data models.

type - the chart type.

orientation - the orientation.

order - the model order.

index - the model index.

Returns:

the generated layout.

Throws:

LogException - on errors.

getEncoderClassName

String getEncoderClassName(String extension)

Gets the class name of the specified encoder.

Parameters:

extension - the file name or extension.

Returns:

the class name of the encoder or null.

setEncoderClassName

void setEncoderClassName(String extension,
                         String className)

Sets the class name of the specified encoder.

Parameters:

extension - the file name or extension.

className - the class name of the encoder.

removeEncoderClassName

void removeEncoderClassName(String extension)

Removes the class name of the specified encoder.

Parameters:

extension - the file name or extension.

createEncoder

Encoder createEncoder(String extension)
                      throws LogException

Creates a new empty encoder.

Parameters:

extension - the file name or extension.

Returns:

the encoder instance.

Throws:

LogException - on errors.