com.inet.report.chart.dataset

Interface StockDataset

All Superinterfaces:

BaseDataset, java.io.Serializable

All Known Implementing Classes:

StockForAllRecordsDataset, StockForEachRecordDataset, StockOneGroupDataset

public interface StockDataset
extends BaseDataset

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:

StockForAllRecordsDataset, StockForEachRecordDataset, StockOneGroupDataset

Field Summary

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

TOKEN_DATASET

Method Summary

Modifier and Type	Method and Description
SummaryField	getCloseField() Returns the data field which provides the close value.
SummaryField	getHighField() Returns the data field which provides the high value.
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.

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

getChart, getDataField, getDataFields, getLabelProvider, verify

Method Detail

getCloseField

SummaryField getCloseField()

Returns the data field which provides the close value. This property is for chart style StockStyle.STOCK_HIGH_LOW_OPEN_CLOSE only.

Returns:

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

Since:

8.0

See Also:

setCloseField(int, Field, Field, int)

getHighField

SummaryField getHighField()

Returns the data field which provides the high value.

Returns:

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

Since:

8.0

See Also:

setHighField(int, Field, Field, int)

getOpenField

SummaryField getOpenField()

Returns the data field which provides the open value. This property is for chart style StockStyle.STOCK_HIGH_LOW_OPEN_CLOSE only.

Returns:

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

Since:

8.0

See Also:

setOpenField(int, Field, Field, int)

getLowField

SummaryField getLowField()

Returns the data field which provides the low value.

Returns:

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

Since:

8.0

See Also:

setLowField(int, Field, Field, int)

setCloseField

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.

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

Throws:

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

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

Since:

8.0

See Also:

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

setHighField

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.

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

Throws:

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

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

Since:

8.0

See Also:

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

setOpenField

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.

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

Throws:

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

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

Since:

8.0

See Also:

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

setLowField

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.

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

Throws:

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

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

Since:

8.0

See Also:

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