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.

Version:

$Id: ChartGenerator.java,v 1.15 2009/09/30 20:16:04 cvsimp Exp $

Author:

Ilkka Priha

Nested Class Summary

static class	ChartGenerator.ModelOrder The model order.
static class	ChartGenerator.Orientation The orientation.

Method Summary

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

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

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

Method Detail

generate

ChartLayout generate(ChartModel data,
                     ChartLayout.ChartType type,
                     ChartGenerator.Orientation 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,
                     ChartLayout.ChartType type,
                     ChartGenerator.Orientation 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,
                     ChartLayout.ChartType type,
                     ChartGenerator.Orientation orientation,
                     ChartGenerator.ModelOrder 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,
                     ChartLayout.ChartType type,
                     ChartGenerator.Orientation orientation,
                     ChartGenerator.ModelOrder 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 type)

Gets the class name of the specified encoder.

Parameters:

type - the content type.

Returns:

the class name of the encoder or null.

setEncoderClassName

void setEncoderClassName(String type,
                         String className)

Sets the class name of the specified encoder.

Parameters:

type - the content type.

className - the class name of the encoder.

removeEncoderClassName

void removeEncoderClassName(String type)

Removes the class name of the specified encoder.

Parameters:

type - the content type.

createEncoder

Encoder createEncoder(String type)
                      throws LogException

Creates a new empty encoder.

Parameters:

type - the content type.

Returns:

the encoder instance.

Throws:

LogException - on errors.