com.inet.report.chart.dataset
Interface XYDataset

All Superinterfaces:

BaseDataset, java.io.Serializable

All Known Implementing Classes:

XYForAllRecordsDataset, XYForEachRecordDataset, XYOneGroupDataset

public interface XYDataset
extends BaseDataset

An interface that is implemented by data sets that have x, y and size fields. For more information see the implementors of this interface.

Since:

8.0

See Also:

XYForAllRecordsDataset, XYForEachRecordDataset, XYOneGroupDataset

Field Summary

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

TOKEN_DATASET

Method Summary

SummaryField	getSizeField() Returns the data field which provides the size of the bubble.
SummaryField	getXField() Returns the data field which provides the x coordinates of the item label.
SummaryField	getYField() Returns the data field which provides the y coordinates of the item label.
void	setSizeField(int summaryOperation, Field field, Field field2nd, int nth) Sets the data field which provides the size of the bubble.
void	setXField(int summaryOperation, Field field, Field field2nd, int nth) Sets the data field which provides the x coordinate of item.
void	setYField(int summaryOperation, Field field, Field field2nd, int nth) Sets the data field which provides the y coordinate of item.

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

getChart, getDataField, getDataFields, getLabelProvider, verify

Method Detail

getSizeField

SummaryField getSizeField()

Returns the data field which provides the size of the bubble. This property is for chart style XYStyle.BUBBLE only.

Returns:

the data field of type SummaryField or null if this field was not initialized.

Since:

8.0

See Also:

setSizeField(int, Field, Field, int)

getXField

SummaryField getXField()

Returns the data field which provides the x coordinates of the item label.

Returns:

the data field of type SummaryField or null if this field was not initialized.

Since:

8.0

See Also:

setXField(int, Field, Field, int)

getYField

SummaryField getYField()

Returns the data field which provides the y coordinates of the item label.

Returns:

the data field of type SummaryField or null if this field was not initialized.

Since:

8.0

See Also:

setYField(int, Field, Field, int)

setSizeField

void setSizeField(int summaryOperation,
                  Field field,
                  Field field2nd,
                  int nth)

Sets the data field which provides the size of the bubble. This property is for chart style XYStyle.BUBBLE only. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and on using parameters 'field2nd' and 'nth' see SummaryField.

Parameters:

summaryOperation - the summary operation. This only supports operations with number results

field - the data field

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

nth - the nth parameter, used e.g. by summary operation SummaryField.NTH_LARGEST

Throws:

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

java.lang.IllegalArgumentException - if nth is less than zero.

Since:

8.0

See Also:

getSizeField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

setXField

void setXField(int summaryOperation,
               Field field,
               Field field2nd,
               int nth)

Sets the data field which provides the x coordinate of item. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and on using parameters 'field2nd' and 'nth' see SummaryField.

Parameters:

summaryOperation - the summary operation. This only supports operations with number results

field - the data field

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

nth - the nth parameter, used e.g. by summary operation SummaryField.NTH_LARGEST

Throws:

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

java.lang.IllegalArgumentException - if nth is less than zero.

Since:

8.0

See Also:

getSizeField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

setYField

void setYField(int summaryOperation,
               Field field,
               Field field2nd,
               int nth)

Sets the data field which provides the y coordinate of item. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and on using parameters 'field2nd' and 'nth' see SummaryField.

Parameters:

summaryOperation - the summary operation. This only supports operations with number results

field - the data field

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

nth - the nth parameter, used e.g. by summary operation SummaryField.NTH_LARGEST

Throws:

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

java.lang.IllegalArgumentException - if nth is less than zero.

Since:

8.0

See Also:

getSizeField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)