com.softwarefx.chartfx.server.dataproviders
Class CrosstabDataProvider

java.lang.Object
  com.softwarefx.chartfx.server.dataproviders.CrosstabDataProvider

All Implemented Interfaces:

IDataSource

public class CrosstabDataProvider
extends Object
implements IDataSource

Provides access to the CrosstabDataProvider object.

Chart FX supports data organized in columnar format. In many cases, however, data is actually stored in tabular format, which previously required manual translation into columnar format prior to passing the data to Chart FX. This often-complicated translation of data format is costly in terms of development time. The Crosstab Data Provider is a tool that automatically converts data from tabular to columnar format.

The CrosstabDataProvider Class members allow you to create and configure the Crosstab data provider to accept your data.

Constructor Summary

CrosstabDataProvider()

CrosstabDataProvider(IDataSource dataSource)

Method Summary

Locale	getCulture() Gets the Culture.
IDataSource	getDataSource() Gets the DataSource.
String	getDateFormat() Gets the DateFormat.
String	getNullColumnHeading() Gets the NullColumnHeading.
RowHeadingSettings	getRowHeadingSettings() Gets the RowHeadingSettings.
String	getSeparator() Gets the Separator.
void	setCulture(Locale value) Allows you to localize the Crosstab provider for language and region specific data.
void	setDataSource(IDataSource value) Used to instruct the Crosstab provider to retrieve the information from an external data provider.
void	setDateFormat(String value) Instructs Chart FX how to format the dates when a column specified as a Row Heading is a date.
void	setNullColumnHeading(String value) Instructs Chart FX to use the configured string value when a null column heading is encountered.
void	setRowHeadingSettings(RowHeadingSettings value) Sets a value indicating how to use RowHeading column as.
void	setSeparator(String value) Sets the separator between two or more fields that form the x-axis label, when more than one Row Heading is present.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrosstabDataProvider

public CrosstabDataProvider()

CrosstabDataProvider

public CrosstabDataProvider(IDataSource dataSource)

Method Detail

getCulture

public Locale getCulture()

Gets the Culture. For more detail see setCulture(java.util.Locale).

getDataSource

public IDataSource getDataSource()

Gets the DataSource. For more detail see setDataSource(com.softwarefx.chartfx.server.dataproviders.IDataSource).

getDateFormat

public String getDateFormat()

Gets the DateFormat. For more detail see setDateFormat(java.lang.String).

getNullColumnHeading

public String getNullColumnHeading()

Gets the NullColumnHeading. For more detail see setNullColumnHeading(java.lang.String).

getRowHeadingSettings

public RowHeadingSettings getRowHeadingSettings()

Gets the RowHeadingSettings. For more detail see setRowHeadingSettings(com.softwarefx.chartfx.server.dataproviders.RowHeadingSettings).

getSeparator

public String getSeparator()

Gets the Separator. For more detail see setSeparator(java.lang.String).

setCulture

public void setCulture(Locale value)

Allows you to localize the Crosstab provider for language and region specific data.

Remarks:

If no attributes are set using this property or the Chart class Chart.setCulture(java.util.Locale) property, then Chart FX inherits the system Locale.

When setting this property, you may need the Language Code and/or Country Code constants for the desired culture. For more information, please refer to the Locale documentation.

See Also:

setDateFormat(java.lang.String), Chart.setCulture(java.util.Locale), Chart

setDataSource

public void setDataSource(IDataSource value)

Used to instruct the Crosstab provider to retrieve the information from an external data provider.

Remarks:

The DataSource property of the CrosstabDataProvider Class must be configured to a valid data provider such as a TextProvider, XMLDataProvider, ListProvider, etc. In other words, the CrosstabDataProvider can only read from another data provider.

Once the DataSource property has been set, you may set the DataSourceSettings Class DataSourceSettings.setDataSource(com.softwarefx.chartfx.server.dataproviders.IDataSource) property of the chart object to the CrosstabDataProvider object. At this point the chart will be populated with the data.

See Also:

DataSourceSettings.setDataSource(com.softwarefx.chartfx.server.dataproviders.IDataSource), DataSourceSettings

setDateFormat

public void setDateFormat(String value)

Instructs Chart FX how to format the dates when a column specified as a Row Heading is a date.

Remarks:

This property allows you to format date information that has been passed to the chart.

If no DateFormat is specified, the format will be set from the setCulture(java.util.Locale) property. By default, the Culture property is set to en-US.

See Also:

setCulture(java.util.Locale), Chart

setNullColumnHeading

public void setNullColumnHeading(String value)

Instructs Chart FX to use the configured string value when a null column heading is encountered.

Remarks:

Null values are accepted as column headings. When a null column heading is passed, Chart FX will replace the null value with the configured NullColumnHeading string. By default this string is set to "Other".

Null data values are also accepted by the Chart FX CrosstabDataProvider. These values are handled as hidden points (Chart.Hidden).

Row Headings cannot be null. If so, an exception will be thrown.

See Also:

setDataSource(com.softwarefx.chartfx.server.dataproviders.IDataSource)

setRowHeadingSettings

public void setRowHeadingSettings(RowHeadingSettings value)

Sets a value indicating how to use RowHeading column as.

Remarks:

When using the CrossTab provider, you will normally configure fields to be used as a ColumnHeading, RowHeading or Value:

ColumnHeadings are translated into Series in the CrossTab provider.

RowHeadings are translated into Points in the CrossTab provider.

Values are used as Y values for the new transposed values.

When this property is set to the enum value as XValues, configured RowHeadings will be realized as true X values in the chart.

See Also:

DataSourceSettings

setSeparator

public void setSeparator(String value)

Sets the separator between two or more fields that form the x-axis label, when more than one Row Heading is present.

Remarks:

When more than one column is specified to be used as a Row Heading, the x-axis label of each point is made by concatenating the different columns. The configured separator is concatenated to the end of each column, except for the last column.

If the separator is not specified, the default value is null.

See Also:

setCulture(java.util.Locale), setDataSource(com.softwarefx.chartfx.server.dataproviders.IDataSource), setDateFormat(java.lang.String), setNullColumnHeading(java.lang.String), Chart