i-net Clear Reports

com.inet.report.chart.dataset
Interface BaseDataset

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
GanttDataset, PieDataset, StandardDataset, StockDataset, XYDataset
All Known Implementing Classes:
ForAllRecordsDataset, ForEachRecordDataset, GanttForEachRecordDataset, GanttOneGroupDataset, GanttTwoGroupsDataset, OneGroupDataset, StockForAllRecordsDataset, StockForEachRecordDataset, StockOneGroupDataset, TwoGroupsDataset, XYForAllRecordsDataset, XYForEachRecordDataset, XYOneGroupDataset

public interface BaseDataset
extends java.io.Serializable

An interface that implemented by all datasets. A Data Set provides methods to get the data field(s) used by the chart.

Since:
8.0

Field Summary
static java.lang.String TOKEN_DATASET
          XML token for a dataset element.
 
Method Summary
 Chart2 getChart()
          Returns the parent chart of this dataset.
 SummaryField getDataField(java.lang.String name)
          Returns the summary field with the specified name or null if the summary field with this name not found in the list.
 java.util.List getDataFields()
          Returns the data fields of this dataset as list.
 com.inet.report.chart.dataset.LabelProvider getLabelProvider()
          Returns the LabelProvider responsible for providing the title, footnote, and axis labels
 java.lang.String verify(ChartStyle style)
          Verifies the group and sum properties of current dataset.
 

Field Detail

TOKEN_DATASET

static final java.lang.String TOKEN_DATASET
XML token for a dataset element.

See Also:
Constant Field Values
Method Detail

getLabelProvider

com.inet.report.chart.dataset.LabelProvider getLabelProvider()
Returns the LabelProvider responsible for providing the title, footnote, and axis labels

Returns:
the LabelProvider responsible for providing the title, footnote, and axis labels
Since:
8.0

getDataField

SummaryField getDataField(java.lang.String name)
Returns the summary field with the specified name or null if the summary field with this name not found in the list. Testing for equality using the case sensitive equals method.

Parameters:
name - the searched name of summary field (null not permitted)
Returns:
the summary field with the specified name or null.
Throws:
java.lang.IllegalArgumentException - if name is null.
Since:
8.0
See Also:
getDataFields()

getDataFields

java.util.List getDataFields()
Returns the data fields of this dataset as list.

Returns:
the list of data fields
Since:
8.0
See Also:
getDataField(String)

getChart

Chart2 getChart()
Returns the parent chart of this dataset.

Returns:
the chart.
Since:
8.0

verify

java.lang.String verify(ChartStyle style)
Verifies the group and sum properties of current dataset.

Parameters:
style - the chart style
Returns:
the error message or empty string if all properties are correct.
Since:
8.0

i-net Clear Reports

Copyright © 1999-2011 by i-net software GmbH