com.inet.report.chart.dataset
Class ForEachRecordDataset

java.lang.Object
  com.inet.report.chart.dataset.AbstractDataset
      com.inet.report.chart.dataset.ForAllRecordsDataset
          com.inet.report.chart.dataset.ForEachRecordDataset

All Implemented Interfaces:

BaseDataset, PieDataset, StandardDataset, java.io.Serializable

public class ForEachRecordDataset
extends ForAllRecordsDataset
implements StandardDataset, PieDataset

This is a dataset used by standard (bar, line, area) and pie charts. This evaluates data 'for each record' for several data fields.

Since:

8.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.inet.report.chart.dataset.BaseDataset

TOKEN_DATASET

Constructor Summary

ForEachRecordDataset(Chart2 chart)
Creates a new empty dataset.

Method Summary

Field	getLabelField() Returns the label field which is used to label the row on the group axis.
com.inet.report.chart.dataset.LabelProvider	getLabelProvider() Returns the LabelProvider responsible for providing the title, footnote, and axis labels
protected java.lang.String	getName() FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.
java.util.List	getReferencedObject() FOR INTERNAL USE ONLY
protected void	saveProperties(java.io.PrintWriter out, int depth) Writes the properties of this chart dataset to PrintWriter.
void	setLabelField(Field labelField) Sets the label field.

Methods inherited from class com.inet.report.chart.dataset.ForAllRecordsDataset

addDataField, getCategoryGroup, getChart, getDataField, getDataField, getDataFields, getDataFieldsCount, removeAllDataFields, removeDataField, verify

Methods inherited from interface com.inet.report.chart.dataset.BaseDataset

getChart, getDataField, getDataFields, verify

Constructor Detail

ForEachRecordDataset

public ForEachRecordDataset(Chart2 chart)

Creates a new empty dataset.

Parameters:

chart - the chart (null not permitted)

Since:

8.0

Method Detail

getLabelField

public Field getLabelField()

Returns the label field which is used to label the row on the group axis.

Returns:

the field.

Since:

8.0

See Also:

setLabelField(Field)

setLabelField

public void setLabelField(Field labelField)

Sets the label field. The label field is used to label the group axis. If this field was not set, the chart indicates each item with its row number. Otherwise the chart displays the value of the label field from the current row on the group axis.

Parameters:

labelField - the field (null permitted)

Since:

8.0

See Also:

getLabelField()

getReferencedObject

public java.util.List getReferencedObject()

FOR INTERNAL USE ONLY

Overrides:

getReferencedObject in class com.inet.report.chart.dataset.AbstractDataset

Returns:

FOR INTERNAL USE ONLY

saveProperties

protected void saveProperties(java.io.PrintWriter out,
                              int depth)

Writes the properties of this chart dataset to PrintWriter.

Overrides:

saveProperties in class com.inet.report.chart.dataset.AbstractDataset

Parameters:

out - the output

depth - the depth of XML indent

getName

protected java.lang.String getName()

FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.

Returns:

name of the XML attribute for this dataset

getLabelProvider

public com.inet.report.chart.dataset.LabelProvider getLabelProvider()

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

Specified by:

getLabelProvider in interface BaseDataset

Overrides:

getLabelProvider in class ForAllRecordsDataset

Returns:

the LabelProvider responsible for providing the title, footnote, and axis labels