com.dukascopy.api.feed.util

Class TickBarFeedDescriptor

java.lang.Object

com.dukascopy.api.feed.FeedDescriptor

com.dukascopy.api.feed.util.TickBarFeedDescriptor

All Implemented Interfaces:

IFeedDescriptor, ITailoredFeedDescriptor<ITickBar>

public class TickBarFeedDescriptor
extends FeedDescriptor
implements ITailoredFeedDescriptor<ITickBar>

Author:

Mark Vilkel The class extends FeedDescriptor

Field Summary

Fields inherited from interface com.dukascopy.api.feed.IFeedDescriptor

DEFAULT_BASE_PERIOD, INFINITE_BASE_PERIOD

Constructor Summary

Constructors

Constructor and Description
TickBarFeedDescriptor(Instrument instrument, TickBarSize tickBarSize, OfferSide offerSide) "Fast" constructor, which has minimal set of parameters for FeedDescriptor creation.
TickBarFeedDescriptor(Instrument instrument, TickBarSize tickBarSize, OfferSide offerSide, Period basePeriod) "Fast" constructor, which has minimal set of parameters for FeedDescriptor creation.

Method Summary

Modifier and Type	Method and Description
void	setDataInterpolationDescriptor(DataInterpolationDescriptor interpolationDescriptor) Setter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.
void	setPeriod(Period period) Setter for period.

Methods inherited from class com.dukascopy.api.feed.FeedDescriptor

equals, getCalculationMethod, getCreationPoint, getDataInterpolationDescriptor, getDataType, getFilter, getInstrument, getLineBreakLookback, getOfferSide, getPeriod, getPriceRange, getRenkoCreationPoint, getRenkoSession, getRenkoType, getReversalAmount, getTickBarSize, getTimeSession, hashCode, setCalculationMethod, setCreationPoint, setDataType, setFilter, setInstrument, setLineBreakLookback, setOfferSide, setPriceRange, setRenkoCreationPoint, setRenkoSession, setRenkoType, setReversalAmount, setTickBarSize, setTimeSession, toString, validateBasePeriod, validateCalculationMethod, validateCreationPoint, validateLineBreakLookback, validatePriceRange, validateRenkoCreationPoint, validateRenkoSession, validateRenkoType, validateTimeSession, validateTurnaroundAmount, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dukascopy.api.feed.IFeedDescriptor

getCalculationMethod, getCreationPoint, getDataInterpolationDescriptor, getDataType, getFilter, getInstrument, getLineBreakLookback, getOfferSide, getPeriod, getPriceRange, getRenkoCreationPoint, getRenkoSession, getRenkoType, getReversalAmount, getTickBarSize, getTimeSession, setCalculationMethod, setCreationPoint, setDataType, setFilter, setInstrument, setLineBreakLookback, setOfferSide, setPriceRange, setRenkoCreationPoint, setRenkoSession, setRenkoType, setReversalAmount, setTickBarSize, setTimeSession

Constructor Detail

TickBarFeedDescriptor

public TickBarFeedDescriptor(Instrument instrument,
                             TickBarSize tickBarSize,
                             OfferSide offerSide)

"Fast" constructor, which has minimal set of parameters for FeedDescriptor creation. Base period is set to default (one week).

Parameters:

instrument - instrument

tickBarSize - tick bar size

offerSide - offer side

TickBarFeedDescriptor

public TickBarFeedDescriptor(Instrument instrument,
                             TickBarSize tickBarSize,
                             OfferSide offerSide,
                             Period basePeriod)

"Fast" constructor, which has minimal set of parameters for FeedDescriptor creation. The period represents the base period.

Parameters:

instrument - instrument

tickBarSize - tick bar size

offerSide - offer side

basePeriod - the period, in which the tick bars are calculated. If base period is given Period.INFINITY, then tick bars are calculated from the beginning of the history. Everything else at data loading time is considered as a default value (one week), including null.

Method Detail

setPeriod

public void setPeriod(Period period)

Description copied from class: FeedDescriptor

Setter for period. Setter for period. For price aggregation and tick bars (DataType.TICK_BAR, DataType.PRICE_RANGE_AGGREGATION, DataType.RENKO, DataType.POINT_AND_FIGURE, DataType.LINE_BREAK, DataType.KAGI) period works as a base period (more information about base period - IFeedDescriptor.DEFAULT_BASE_PERIOD). Only two base periods are possible - Period.INFINITY and one week (IFeedDescriptor.DEFAULT_BASE_PERIOD). If one provides anything else (including null) than Period.INFINITY, then at data loading time it is considered to be as a default base period (IFeedDescriptor.DEFAULT_BASE_PERIOD).
Period.INFINITY is not allowed on remote run.

Specified by:

setPeriod in interface IFeedDescriptor

Overrides:

setPeriod in class FeedDescriptor

Parameters:

period - period

setDataInterpolationDescriptor

public void setDataInterpolationDescriptor(DataInterpolationDescriptor interpolationDescriptor)

Description copied from class: FeedDescriptor

Setter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.

Specified by:

setDataInterpolationDescriptor in interface IFeedDescriptor

Overrides:

setDataInterpolationDescriptor in class FeedDescriptor

Parameters:

interpolationDescriptor - DataInterpolationDescriptor