Package com.inet.report.chart.dataset
Class XYForAllRecordsDataset
- java.lang.Object
-
- com.inet.report.chart.dataset.AbstractDataset
-
- com.inet.report.chart.dataset.XYForAllRecordsDataset
-
- All Implemented Interfaces:
BaseDataset
,XYDataset
,java.io.Serializable
- Direct Known Subclasses:
XYForEachRecordDataset
public class XYForAllRecordsDataset extends com.inet.report.chart.dataset.AbstractDataset implements XYDataset
This is a dataset used by xy charts. This evaluates data 'for all records' for three data fields (x, y and size).- Since:
- 8.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static int
FIELDS_COUNT
The count of data fields by this kind of dataset.-
Fields inherited from interface com.inet.report.chart.dataset.BaseDataset
TOKEN_DATASET
-
-
Constructor Summary
Constructors Constructor Description XYForAllRecordsDataset(Chart2 chart)
Creates a new empty dataset.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Group
getCategoryGroup()
Returns the category group.Chart2
getChart()
Returns the parent chart of this dataset.protected SummaryField
getDataField(int index)
Returns the summary field at the specified position in the list.SummaryField
getDataField(java.lang.String name)
Returns the summary field with the specified name ornull
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 labelsprotected java.lang.String
getName()
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.void
updateReferences()
FOR INTERNAL USE ONLYjava.lang.String
verify(ChartStyle style)
Verifies the group and sum properties of current dataset.-
Methods inherited from class com.inet.report.chart.dataset.AbstractDataset
getReferencedObject, saveGroups, saveProperties, saveSummaryFields
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inet.report.chart.dataset.BaseDataset
getReferencedObject
-
-
-
-
Field Detail
-
FIELDS_COUNT
protected static final int FIELDS_COUNT
The count of data fields by this kind of dataset.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
XYForAllRecordsDataset
public XYForAllRecordsDataset(Chart2 chart)
Creates a new empty dataset.- Parameters:
chart
- the chart (null
not permitted)- Since:
- 8.0
-
-
Method Detail
-
getChart
public Chart2 getChart()
Returns the parent chart of this dataset.- Specified by:
getChart
in interfaceBaseDataset
- Returns:
- the chart.
-
getDataField
public SummaryField getDataField(java.lang.String name)
Returns the summary field with the specified name ornull
if the summary field with this name not found in the list. Testing for equality using the case sensitiveequals
method.- Specified by:
getDataField
in interfaceBaseDataset
- Parameters:
name
- the searched name of summary field (null
not permitted)- Returns:
- the summary field with the specified name or
null
. - See Also:
BaseDataset.getDataFields()
-
getDataFields
public java.util.List getDataFields()
Returns the data fields of this dataset as list.- Specified by:
getDataFields
in interfaceBaseDataset
- Returns:
- the list of data fields
- See Also:
BaseDataset.getDataField(String)
-
getCategoryGroup
protected Group getCategoryGroup()
Returns the category group. The category group is the first group of chart.- Returns:
- the group.
- Since:
- 8.0
-
getSizeField
public SummaryField getSizeField()
Returns the data field which provides the size of the bubble. This property is for chart styleXYStyle.BUBBLE
only.- Specified by:
getSizeField
in interfaceXYDataset
- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - See Also:
XYDataset.setSizeField(int, Field, Field, int)
-
setSizeField
public 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 styleXYStyle.BUBBLE
only. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and on using parameters 'field2nd' and 'nth' seeSummaryField
.- Specified by:
setSizeField
in interfaceXYDataset
- Parameters:
summaryOperation
- the summary operation. This only supports operations with number resultsfield
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used e.g. by summary operationSummaryField.NTH_LARGEST
- See Also:
XYDataset.getSizeField()
,SummaryField.setSummaryOperation(int)
,SummaryField.setField(Field)
,SummaryField.setField2nd(Field)
,SummaryField.setSummaryNth(int)
-
getXField
public SummaryField getXField()
Returns the data field which provides the x coordinates of the item label.- Specified by:
getXField
in interfaceXYDataset
- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - See Also:
XYDataset.setXField(int, Field, Field, int)
-
setXField
public void setXField(int summaryOperation, Field field, Field field2nd, int nth)
Sets the data field which provides the x coordinate of item. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and on using parameters 'field2nd' and 'nth' seeSummaryField
.- Specified by:
setXField
in interfaceXYDataset
- Parameters:
summaryOperation
- the summary operation. This only supports operations with number resultsfield
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used e.g. by summary operationSummaryField.NTH_LARGEST
- See Also:
XYDataset.getSizeField()
,SummaryField.setSummaryOperation(int)
,SummaryField.setField(Field)
,SummaryField.setField2nd(Field)
,SummaryField.setSummaryNth(int)
-
getYField
public SummaryField getYField()
Returns the data field which provides the y coordinates of the item label.- Specified by:
getYField
in interfaceXYDataset
- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - See Also:
XYDataset.setYField(int, Field, Field, int)
-
setYField
public void setYField(int summaryOperation, Field field, Field field2nd, int nth)
Sets the data field which provides the y coordinate of item. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and on using parameters 'field2nd' and 'nth' seeSummaryField
.- Specified by:
setYField
in interfaceXYDataset
- Parameters:
summaryOperation
- the summary operation. This only supports operations with number resultsfield
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used e.g. by summary operationSummaryField.NTH_LARGEST
- See Also:
XYDataset.getSizeField()
,SummaryField.setSummaryOperation(int)
,SummaryField.setField(Field)
,SummaryField.setField2nd(Field)
,SummaryField.setSummaryNth(int)
-
getDataField
protected SummaryField getDataField(int index)
Returns the summary field at the specified position in the list.- Parameters:
index
- index of summary field to return- Returns:
- the summary field at the specified position in the list.
- Throws:
java.lang.IndexOutOfBoundsException
- if index is out of range.- Since:
- 8.0
-
verify
public java.lang.String verify(ChartStyle style)
Verifies the group and sum properties of current dataset.- Specified by:
verify
in interfaceBaseDataset
- Parameters:
style
- the chart style- Returns:
- the error message or empty string if all properties are correct.
-
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 interfaceBaseDataset
- Returns:
- the LabelProvider responsible for providing the title, footnote, and axis labels
-
updateReferences
public void updateReferences()
FOR INTERNAL USE ONLY- Specified by:
updateReferences
in interfaceBaseDataset
-
getName
protected java.lang.String getName()
-
-