org.otfeed.command
Class HistDataCommand

java.lang.Object
  org.otfeed.command.HistDataCommand

All Implemented Interfaces:

ICommand

public final class HistDataCommand
extends java.lang.Object
implements ICommand

Request for the historical aggregated OHLC (open-high-low-close) data.

The aggregation span varies from 2 ticks to years. Default aggregation span is 1 day.

Generates ohlc events.

For the request to receive raw ticks data (not aggregated), see HistTicksCommand.

Constructor Summary

HistDataCommand()
Default constructor.

HistDataCommand(java.lang.String exchangeCode, java.lang.String symbolCode, java.util.Date startDate, java.util.Date endDate, AggregationSpan aggregationSpan, IDataDelegate<OTOHLC> dataDelegate)
Creates new historical data command, initializing all its properties.

HistDataCommand(java.lang.String exchangeCode, java.lang.String symbolCode, java.util.Date startDate, java.util.Date endDate, IDataDelegate<OTOHLC> dataDelegate)
Creates new historical data command with default aggregation interval of one day.

Method Summary

AggregationSpan	getAggregationSpan() Determines the length of the aggregation interval, e.g.
ICompletionDelegate	getCompletionDelegate() Option delegate to watch stream completion event.
IDataDelegate<OTOHLC>	getDataDelegate() Delegate to receive OTOHLC events.
java.util.Date	getEndDate() End date/time for the historical data.
java.lang.String	getExchangeCode() Exchange code.
java.util.Date	getStartDate() Start date/time for the historical data.
java.lang.String	getSymbolCode() Symbol code.
void	setAggregationSpan(AggregationSpan val) Sets aggregation span.
void	setCompletionDelegate(ICompletionDelegate val) Sets completion delegate.
void	setDataDelegate(IDataDelegate<OTOHLC> dataDelegate) Sets delegate.
void	setEndDate(java.util.Date val) Sets end date/time.
void	setExchangeCode(java.lang.String exchangeCode) Sets the exchange code.
void	setStartDate(java.util.Date val) Sets start date/time.
void	setSymbolCode(java.lang.String val) Sets symbol code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistDataCommand

public HistDataCommand(java.lang.String exchangeCode,
                       java.lang.String symbolCode,
                       java.util.Date startDate,
                       java.util.Date endDate,
                       AggregationSpan aggregationSpan,
                       IDataDelegate<OTOHLC> dataDelegate)

Creates new historical data command, initializing all its properties.

Parameters:

exchangeCode - echange code.

symbolCode - symbol code.

startDate - start date.

endDate - end date.

aggregationSpan - aggregation time span.

dataDelegate - delegate.

HistDataCommand

public HistDataCommand()

Default constructor. Initializes aggregationSpan to its default value of 1 day. All other properties must be set explicitly before using this command object.

HistDataCommand

public HistDataCommand(java.lang.String exchangeCode,
                       java.lang.String symbolCode,
                       java.util.Date startDate,
                       java.util.Date endDate,
                       IDataDelegate<OTOHLC> dataDelegate)

Creates new historical data command with default aggregation interval of one day. Aggreagation span is set to one day.

Parameters:

exchangeCode - exchange code.

symbolCode - symbol code.

startDate - start date.

endDate - end date.

dataDelegate - data delegate.

Method Detail

getAggregationSpan

public AggregationSpan getAggregationSpan()

Determines the length of the aggregation interval, e.g. AggregationSpan.hours(int).

Returns:

aggregation span.

setAggregationSpan

public void setAggregationSpan(AggregationSpan val)

Sets aggregation span.

Parameters:

val -

getDataDelegate

public IDataDelegate<OTOHLC> getDataDelegate()

Delegate to receive OTOHLC events. This parameter is mandatory.

Returns:

delegate.

setDataDelegate

public void setDataDelegate(IDataDelegate<OTOHLC> dataDelegate)

Sets delegate.

Parameters:

dataDelegate - delegate.

getStartDate

public final java.util.Date getStartDate()

Start date/time for the historical data.

Returns:

Start date/time.

setStartDate

public final void setStartDate(java.util.Date val)

Sets start date/time.

Parameters:

val - Start date/time.

getEndDate

public final java.util.Date getEndDate()

End date/time for the historical data.

Returns:

End date/time.

setEndDate

public final void setEndDate(java.util.Date val)

Sets end date/time.

Parameters:

val - end date/time.

getExchangeCode

public final java.lang.String getExchangeCode()

Exchange code.

Returns:

exchange code.

setExchangeCode

public final void setExchangeCode(java.lang.String exchangeCode)

Sets the exchange code.

Parameters:

exchangeCode - exchange code.

getSymbolCode

public final java.lang.String getSymbolCode()

Symbol code.

Returns:

symbol code.

setSymbolCode

public final void setSymbolCode(java.lang.String val)

Sets symbol code.

Parameters:

val - symbol code.

getCompletionDelegate

public ICompletionDelegate getCompletionDelegate()

Option delegate to watch stream completion event.

Returns:

delegate.

setCompletionDelegate

public void setCompletionDelegate(ICompletionDelegate val)

Sets completion delegate.

Parameters:

val - delegate.