Klasse ForAllRecordsDataset

java.lang.Object

com.inet.report.chart.dataset.AbstractDataset

com.inet.report.chart.dataset.ForAllRecordsDataset

Alle implementierten Schnittstellen:

BaseDataset, PieDataset, StandardDataset, Serializable

Bekannte direkte Unterklassen:

ForEachRecordDataset, OneGroupDataset

public class ForAllRecordsDataset
extends com.inet.report.chart.dataset.AbstractDataset
implements StandardDataset, PieDataset

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

Seit:

8.0

Siehe auch:

• Serialisierte Form

Feldübersicht

Von Schnittstelle geerbte Felder BaseDataset

TOKEN_DATASET

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ForAllRecordsDataset(Chart2 chart)	Creates a new empty dataset.

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
@Nonnull SummaryField	addDataField(int summaryOperation, Field field, Field field2nd, int nth)	Adds a data field to the list of fields whose values will be calculated by the summary operation and shown in the chart as bar length for example.
protected Group	getCategoryGroup()	Returns the category group.
Chart2	getChart()	Returns the parent chart of this dataset.
SummaryField	getDataField(int index)	Returns the summary field at the specified position in the list.
SummaryField	getDataField(String name)	Returns the summary field with the specified name or null if the summary field with this name not found in the list.
List	getDataFields()	Returns the data fields of this dataset as list.
int	getDataFieldsCount()	Returns the count of data fields in this dataset.
com.inet.report.chart.dataset.LabelProvider	getLabelProvider()	Returns the LabelProvider responsible for providing the title, footnote, and axis labels
protected String	getName()	FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.
void	removeAllDataFields()	Removes all data fields from this dataset.
void	removeDataField(int index)	Removes a data field at the specified position in the list.
void	updateReferences()	FOR INTERNAL USE ONLY.
String	verify(ChartStyle style)	Verifies the group and sum properties of current dataset.

Von Klasse geerbte Methoden com.inet.report.chart.dataset.AbstractDataset

getReferencedObject, saveGroups, saveProperties, saveSummaryFields

Von Klasse geerbte Methoden Object

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

Von Schnittstelle geerbte Methoden BaseDataset

getReferencedObject

Konstruktordetails

ForAllRecordsDataset

public ForAllRecordsDataset(Chart2 chart)

Creates a new empty dataset.

Parameter:

chart - the chart (null not permitted)

Seit:

8.0

Methodendetails

getChart

public Chart2 getChart()

Returns the parent chart of this dataset.

Angegeben von:

getChart in Schnittstelle BaseDataset

Gibt zurück:

the chart.

addDataField

public @Nonnull SummaryField addDataField(int summaryOperation,
 Field field,
 Field field2nd,
 int nth)

Adds a data field to the list of fields whose values will be calculated by the summary operation and shown in the chart as bar length for example. This will creates a new SummaryField with the given parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' see SummaryField.

Parameter:

summaryOperation - the summary operation

field - the data field

field2nd - the second data field, user for example for weights in weighted average SummaryField.WEIGHTED_AVERAGE.

nth - the nth parameter, used for example by the summary operation SummaryField.NTH_LARGEST

Gibt zurück:

the created summary field.

Löst aus:

IllegalArgumentException - if the required second field or the field are null or have an unsupported value type.

IllegalArgumentException - if parameter nth is less than zero.

Seit:

8.0

Siehe auch:

• getDataField(int)
• getDataFieldsCount()
• removeAllDataFields()
• removeDataField(int)
• SummaryField.setSummaryOperation(int)
• SummaryField.setField(Field)
• SummaryField.setField2nd(Field)
• SummaryField.setSummaryNth(int)

getDataField

public SummaryField getDataField(int index)

Returns the summary field at the specified position in the list.

Parameter:

index - index of summary field to return

Gibt zurück:

the summary field at the specified position in the list.

Löst aus:

IndexOutOfBoundsException - if index is out of range.

Seit:

8.0

getDataField

public SummaryField getDataField(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.

Angegeben von:

getDataField in Schnittstelle BaseDataset

Parameter:

name - the searched name of summary field (null not permitted)

Gibt zurück:

the summary field with the specified name or null.

Siehe auch:

• BaseDataset.getDataFields()

getDataFields

public List getDataFields()

Returns the data fields of this dataset as list.

Angegeben von:

getDataFields in Schnittstelle BaseDataset

Gibt zurück:

the list of data fields

Siehe auch:

• BaseDataset.getDataField(String)

removeDataField

public void removeDataField(int index)

Removes a data field at the specified position in the list. Note: this dataset is incomplete without any data fields and cannot be used by chart.

Parameter:

index - the specified position

Löst aus:

IndexOutOfBoundsException - if index out of range.

Seit:

8.0

Siehe auch:

• addDataField(int, Field, Field, int)
• getDataField(int)
• getDataFieldsCount()
• removeAllDataFields()

removeAllDataFields

public void removeAllDataFields()

Removes all data fields from this dataset.

Seit:

8.0

Siehe auch:

• addDataField(int, Field, Field, int)
• getDataField(int)
• getDataFieldsCount()
• removeDataField(int)

getDataFieldsCount

public int getDataFieldsCount()

Returns the count of data fields in this dataset.

Gibt zurück:

the count

Seit:

8.0

Siehe auch:

• addDataField(int, Field, Field, int)
• getDataField(int)
• removeAllDataFields()
• removeDataField(int)

getCategoryGroup

protected Group getCategoryGroup()

Returns the category group. The category group is the first group of chart.

Gibt zurück:

the group

Seit:

8.0

verify

public String verify(ChartStyle style)

Verifies the group and sum properties of current dataset.

Angegeben von:

verify in Schnittstelle BaseDataset

Parameter:

style - the chart style

Gibt zurück:

the error message or empty string if all properties are correct.

updateReferences

public void updateReferences()

FOR INTERNAL USE ONLY. Updates the references of this dataset.

Angegeben von:

updateReferences in Schnittstelle BaseDataset

getName

protected String getName()

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

Gibt zurück:

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

Angegeben von:

getLabelProvider in Schnittstelle BaseDataset

Gibt zurück:

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