i-net Clear Reports

com.inet.report.chart.dataset
Class XYForAllRecordsDataset

java.lang.Object
  extended by com.inet.report.chart.dataset.AbstractDataset
      extended by 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
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
XYForAllRecordsDataset(Chart2 chart)
          Creates a new empty dataset.
 
Method Summary
protected  Group getCategoryGroup()
          Returns the category group.
 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.
protected  SummaryField getDataField(int index)
          Returns the summary field at the specified position 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
protected  java.lang.String getName()
          FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.
 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.
 java.lang.String verify(ChartStyle style)
          Verifies the group and sum properties of current dataset.
 

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 interface BaseDataset
Returns:
the chart.

getDataField

public 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.

Specified by:
getDataField in interface BaseDataset
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 interface BaseDataset
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 style XYStyle.BUBBLE only.

Specified by:
getSizeField in interface XYDataset
Returns:
the data field of type SummaryField or null 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 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.

Specified by:
setSizeField in interface XYDataset
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
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 interface XYDataset
Returns:
the data field of type SummaryField or null 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 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.

Specified by:
setXField in interface XYDataset
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
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 interface XYDataset
Returns:
the data field of type SummaryField or null 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 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.

Specified by:
setYField in interface XYDataset
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
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 interface BaseDataset
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 interface BaseDataset
Returns:
the LabelProvider responsible for providing the title, footnote, and axis labels

getName

protected java.lang.String getName()
FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.

Specified by:
getName in class com.inet.report.chart.dataset.AbstractDataset
Returns:
the name.

i-net Clear Reports

Copyright © 1999-2015 by i-net software GmbH