Package de.gsi.dataset.spi.financial

Class OhlcvDataSet

java.lang.Object

de.gsi.dataset.spi.AbstractStylable<D>

de.gsi.dataset.spi.AbstractDataSet<OhlcvDataSet>

de.gsi.dataset.spi.financial.OhlcvDataSet

All Implemented Interfaces:

DataSet, DataSetMetaData, EventSource, AttributeModelAware, IOhlcvItemAware, java.io.Serializable, java.lang.Iterable<IOhlcvItem>

public class OhlcvDataSet
extends AbstractDataSet<OhlcvDataSet>
implements java.lang.Iterable<IOhlcvItem>, IOhlcvItemAware, AttributeModelAware

Dataset Domain Object for encapsulation of IOhlcv API structure.

See Also:

API provides OHLCV domain object access., API provides OHLCV item domain object access., Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DIM_Y_CLOSE
static int	DIM_Y_HIGH
static int	DIM_Y_LOW
static int	DIM_Y_OI
static int	DIM_Y_OPEN
static int	DIM_Y_VOLUME

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet

axisListener, dimension

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor	Description
OhlcvDataSet(java.lang.String title)

Method Summary

Modifier and Type	Method	Description
double	get(int dimIndex, int index)	Gets the x value of the data point with the index i
AttributeModel	getAddon()
AttributeModel	getAddonOrCreate()
IOhlcv	getData()
int	getDataCount()	Get the number of data points in the data set.
IOhlcvItem	getItem(int index)	Provides OHLCV domain object with extensions
IOhlcvItem	getLastItem()
int	getXIndex(double x)	Gets the index of the data point closest to the given x coordinate.
boolean	isCategoryBased()
java.util.Iterator<IOhlcvItem>	iterator()
DataSet	set(DataSet other, boolean copy)
void	setCategoryBased(boolean categoryBased)	Change category or time based axis handling.
void	setData(IOhlcv ohlcv)	Set the domain object with OHLCV data.

Methods inherited from class de.gsi.dataset.spi.AbstractDataSet

addDataLabel, addDataStyle, autoNotification, binarySearch, binarySearch, clearMetaInfo, copyAxisDescription, copyDataLabelsAndStyles, copyMetaData, equalDataLabels, equalEditConstraints, equalErrorValues, equalMetaData, equals, equals, equalValues, fireInvalidated, getAxisDescriptions, getDataLabel, getDataLabelMap, getDataStyleMap, getDimension, getEditConstraints, getErrorList, getIndex, getInfoList, getMetaInfo, getName, getStyle, getThis, getValue, getValues, getWarningList, hashCode, lock, recomputeLimits, removeDataLabel, removeStyle, setEditConstraints, setName, toString, updateEventListener

Methods inherited from class de.gsi.dataset.spi.AbstractStylable

getStyle, setStyle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.gsi.dataset.DataSet

getAxisDescription, getStyle, set, setStyle

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DIM_Y_OPEN

public static final int DIM_Y_OPEN

See Also:

Constant Field Values

DIM_Y_HIGH

public static final int DIM_Y_HIGH

See Also:

Constant Field Values

DIM_Y_LOW

public static final int DIM_Y_LOW

See Also:

Constant Field Values

DIM_Y_CLOSE

public static final int DIM_Y_CLOSE

See Also:

Constant Field Values

DIM_Y_VOLUME

public static final int DIM_Y_VOLUME

See Also:

Constant Field Values

DIM_Y_OI

public static final int DIM_Y_OI

See Also:

Constant Field Values

Constructor Detail

OhlcvDataSet

public OhlcvDataSet(java.lang.String title)

Method Detail

setData

public void setData(IOhlcv ohlcv)

Set the domain object with OHLCV data.

Parameters:

ohlcv - connection with OHLCV data from financial framework.

getData

public IOhlcv getData()

Returns:

get domain object

isCategoryBased

public boolean isCategoryBased()

Returns:

is true for a category axis support

setCategoryBased

public void setCategoryBased(boolean categoryBased)

Change category or time based axis handling.

Parameters:

categoryBased - if true; category based indexes are used. Default false.

get

public double get(int dimIndex,
                  int index)

Description copied from interface: DataSet

Gets the x value of the data point with the index i

Specified by:

get in interface DataSet

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

index - data point index

Returns:

the x value

iterator

public java.util.Iterator<IOhlcvItem> iterator()

Specified by:

iterator in interface java.lang.Iterable<IOhlcvItem>

getDataCount

public int getDataCount()

Description copied from interface: DataSet

Get the number of data points in the data set.

Specified by:

getDataCount in interface DataSet

Returns:

the number of data points

set

public DataSet set(DataSet other,
                   boolean copy)

Specified by:

set in interface DataSet

Parameters:

other - Other DataSet to copy into this DataSet

copy - true: perform a deep copy (default), false: reuse the other dataset's internal data structures (if applicable)

Returns:

itself (fluent design) -- N.B. existing update listener are preserved

getXIndex

public int getXIndex(double x)

Gets the index of the data point closest to the given x coordinate. If the x coordinate lies outside the range of the data set, the index of the first/last point is returned.

Parameters:

x - the x position of the data point

Returns:

the index of the data point

getAddon

public AttributeModel getAddon()

Specified by:

getAddon in interface AttributeModelAware

Returns:

OHLCV addon. If not available, null is return.

getAddonOrCreate

public AttributeModel getAddonOrCreate()

Specified by:

getAddonOrCreate in interface AttributeModelAware

Returns:

OHLCV Item addon. If not available, create it.

getItem

public IOhlcvItem getItem(int index)

Description copied from interface: IOhlcvItemAware

Provides OHLCV domain object with extensions

Specified by:

getItem in interface IOhlcvItemAware

Parameters:

index - to the dataset/domain structure

Returns:

the filled ohlcv item

getLastItem

public IOhlcvItem getLastItem()