i-net Clear Reports

com.inet.report.chart.dataset
Class StockForAllRecordsDataset

java.lang.Object
  extended by com.inet.report.chart.dataset.AbstractDataset
      extended by com.inet.report.chart.dataset.StockForAllRecordsDataset
All Implemented Interfaces:
BaseDataset, StockDataset, java.io.Serializable
Direct Known Subclasses:
StockForEachRecordDataset

public class StockForAllRecordsDataset
extends com.inet.report.chart.dataset.AbstractDataset
implements StockDataset

This is a dataset used by stock charts. This evaluates data 'for all records' for four data fields (open, close, high, low).

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
StockForAllRecordsDataset(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 getCloseField()
          Returns the data field which provides the close value.
 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.
 SummaryField getHighField()
          Returns the data field which provides the high value.
 com.inet.report.chart.dataset.LabelProvider getLabelProvider()
          Returns the LabelProvider responsible for providing the title, footnote, and axis labels
 SummaryField getLowField()
          Returns the data field which provides the low value.
 SummaryField getOpenField()
          Returns the data field which provides the open value.
 void setCloseField(int summaryOperation, Field field, Field field2nd, int nth)
          Sets the data field which provides the close value.
 void setHighField(int summaryOperation, Field field, Field field2nd, int nth)
          Sets the data field which provides the high value.
 void setLowField(int summaryOperation, Field field, Field field2nd, int nth)
          Sets the data field which provides the low value.
 void setOpenField(int summaryOperation, Field field, Field field2nd, int nth)
          Sets the data field which provides the open value.
 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

StockForAllRecordsDataset

public StockForAllRecordsDataset(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

getLowField

public SummaryField getLowField()
Returns the data field which provides the low value.

Specified by:
getLowField in interface StockDataset
Returns:
the data field of type SummaryField or null if this field was not initialized.
See Also:
StockDataset.setLowField(int, Field, Field, int)

setLowField

public void setLowField(int summaryOperation,
                        Field field,
                        Field field2nd,
                        int nth)
Sets the data field which provides the low value. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' see SummaryField.

Specified by:
setLowField in interface StockDataset
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 for example by summary operation SummaryField.NTH_LARGEST
See Also:
StockDataset.getCloseField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

getHighField

public SummaryField getHighField()
Returns the data field which provides the high value.

Specified by:
getHighField in interface StockDataset
Returns:
the data field of type SummaryField or null if this field was not initialized.
See Also:
StockDataset.setHighField(int, Field, Field, int)

setHighField

public void setHighField(int summaryOperation,
                         Field field,
                         Field field2nd,
                         int nth)
Sets the data field which provides the high value. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' see SummaryField.

Specified by:
setHighField in interface StockDataset
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 for example by summary operation SummaryField.NTH_LARGEST
See Also:
StockDataset.getCloseField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

getOpenField

public SummaryField getOpenField()
Returns the data field which provides the open value. This property is for chart style StockStyle.STOCK_HIGH_LOW_OPEN_CLOSE only.

Specified by:
getOpenField in interface StockDataset
Returns:
the data field of type SummaryField or null if this field was not initialized.
See Also:
StockDataset.setOpenField(int, Field, Field, int)

setOpenField

public void setOpenField(int summaryOperation,
                         Field field,
                         Field field2nd,
                         int nth)
Sets the data field which provides the open value. This property is for chart style StockStyle.STOCK_HIGH_LOW_OPEN_CLOSE only. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' see SummaryField.

Specified by:
setOpenField in interface StockDataset
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 for example by summary operation SummaryField.NTH_LARGEST
See Also:
StockDataset.getCloseField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

getCloseField

public SummaryField getCloseField()
Returns the data field which provides the close value. This property is for chart style StockStyle.STOCK_HIGH_LOW_OPEN_CLOSE only.

Specified by:
getCloseField in interface StockDataset
Returns:
the data field of type SummaryField or null if this field was not initialized.
See Also:
StockDataset.setCloseField(int, Field, Field, int)

setCloseField

public void setCloseField(int summaryOperation,
                          Field field,
                          Field field2nd,
                          int nth)
Sets the data field which provides the close value. This property is for chart style StockStyle.STOCK_HIGH_LOW_OPEN_CLOSE only. Creates a new SummaryField with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' see SummaryField.

Specified by:
setCloseField in interface StockDataset
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 for example by summary operation SummaryField.NTH_LARGEST
See Also:
StockDataset.getCloseField(), 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

i-net Clear Reports

Copyright © 1999-2015 by i-net software GmbH