Package com.inet.report.chart.dataset
Interface StockDataset
- All Superinterfaces:
BaseDataset
,Serializable
- All Known Implementing Classes:
StockForAllRecordsDataset
,StockForEachRecordDataset
,StockOneGroupDataset
An interface that is implemented by data set that have open, close, high, and low fields.
For more information see the implementors of this interface.
- Since:
- 8.0
- See Also:
-
Field Summary
Fields inherited from interface com.inet.report.chart.dataset.BaseDataset
TOKEN_DATASET
-
Method Summary
Modifier and TypeMethodDescriptionReturns the data field which provides the close value.Returns the data field which provides the high value.Returns the data field which provides the low value.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.Methods inherited from interface com.inet.report.chart.dataset.BaseDataset
getChart, getDataField, getDataFields, getLabelProvider, getReferencedObject, updateReferences, verify
-
Method Details
-
getCloseField
SummaryField getCloseField()Returns the data field which provides the close value. This property is for chart styleStockStyle.STOCK_HIGH_LOW_OPEN_CLOSE
only.- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - Since:
- 8.0
- See Also:
-
getHighField
SummaryField getHighField()Returns the data field which provides the high value.- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - Since:
- 8.0
- See Also:
-
getOpenField
SummaryField getOpenField()Returns the data field which provides the open value. This property is for chart styleStockStyle.STOCK_HIGH_LOW_OPEN_CLOSE
only.- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - Since:
- 8.0
- See Also:
-
getLowField
SummaryField getLowField()Returns the data field which provides the low value.- Returns:
- the data field of type
SummaryField
ornull
if this field was not initialized. - Since:
- 8.0
- See Also:
-
setCloseField
Sets the data field which provides the close value. This property is for chart styleStockStyle.STOCK_HIGH_LOW_OPEN_CLOSE
only. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' seeSummaryField
.- Parameters:
summaryOperation
- the summary operation. This only supports operations with number results.field
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST
- Throws:
IllegalArgumentException
- if the required first or second field arenull
or have an unsupported value type.IllegalArgumentException
- if nth is less than zero.- Since:
- 8.0
- See Also:
-
setHighField
Sets the data field which provides the high value. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' seeSummaryField
.- Parameters:
summaryOperation
- the summary operation. This only supports operations with number results.field
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST
- Throws:
IllegalArgumentException
- if the required first or second field arenull
or have an unsupported value type.IllegalArgumentException
- if nth is less than zero.- Since:
- 8.0
- See Also:
-
setOpenField
Sets the data field which provides the open value. This property is for chart styleStockStyle.STOCK_HIGH_LOW_OPEN_CLOSE
only. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' seeSummaryField
.- Parameters:
summaryOperation
- the summary operation. This only supports operations with number results.field
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST
- Throws:
IllegalArgumentException
- if the required first or second field arenull
or have an unsupported value type.IllegalArgumentException
- if nth is less than zero.- Since:
- 8.0
- See Also:
-
setLowField
Sets the data field which provides the low value. Creates a newSummaryField
with this field, operation and parameters.
For more information on the supported value types of fields and using parameters 'field2nd' and 'nth' seeSummaryField
.- Parameters:
summaryOperation
- the summary operation. This only supports operations with number results.field
- the data fieldfield2nd
- the second data field, used for example for weights in weighted averageSummaryField.WEIGHTED_AVERAGE
.nth
- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST
- Throws:
IllegalArgumentException
- if the required first or second field arenull
or have an unsupported value type.IllegalArgumentException
- if nth is less than zero.- Since:
- 8.0
- See Also:
-