com.dukascopy.api.feed.util

Class PointAndFigureFeedDescriptor

java.lang.Object

com.dukascopy.api.feed.FeedDescriptor

com.dukascopy.api.feed.util.PointAndFigureFeedDescriptor

All Implemented Interfaces:

IFeedDescriptor, ITailoredFeedDescriptor<IPointAndFigure>

public class PointAndFigureFeedDescriptor
extends FeedDescriptor
implements ITailoredFeedDescriptor<IPointAndFigure>

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
PointAndFigureFeedDescriptor(Instrument instrument, PriceRange boxSize, ReversalAmount reversalAmount, OfferSide offerSide) "Fast" constructor, which has minimal set of parameters for FeedDescriptor creation Base period is set to default (one week).
PointAndFigureFeedDescriptor(Instrument instrument, PriceRange boxSize, ReversalAmount reversalAmount, OfferSide offerSide, Period basePeriod) "Fast" constructor, which has minimal set of parameters for FeedDescriptor creation.
PointAndFigureFeedDescriptor(Instrument instrument, PriceRange boxSize, ReversalAmount reversalAmount, OfferSide offerSide, Period timeSession, CalculationMethod calculationMethod, Period basePeriod) Constructor, that sets all required fields.
PointAndFigureFeedDescriptor(Instrument instrument, PriceRange boxSize, ReversalAmount reversalAmount, OfferSide offerSide, Period basePeriod, DataInterpolationDescriptor interpolationDescriptor) Deprecated. Interpolation descriptor is not used for P&F calculation any more. See PointAndFigureFeedDescriptor(com.dukascopy.api.Instrument, com.dukascopy.api.PriceRange, com.dukascopy.api.ReversalAmount, com.dukascopy.api.OfferSide, com.dukascopy.api.Period, com.dukascopy.api.feed.CalculationMethod, com.dukascopy.api.Period)

Method Summary

Modifier and Type	Method and Description
void	setCalculationMethod(CalculationMethod calculationMethod) Setter for DataType.POINT_AND_FIGURE calculation method.
void	setPeriod(Period period) Setter for period.
void	setTimeSession(Period timeSession) Setter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI, DataType.POINT_AND_FIGURE session 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, setCreationPoint, setDataInterpolationDescriptor, setDataType, setFilter, setInstrument, setLineBreakLookback, setOfferSide, setPriceRange, setRenkoCreationPoint, setRenkoSession, setRenkoType, setReversalAmount, setTickBarSize, 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, setCreationPoint, setDataInterpolationDescriptor, setDataType, setFilter, setInstrument, setLineBreakLookback, setOfferSide, setPriceRange, setRenkoCreationPoint, setRenkoSession, setRenkoType, setReversalAmount, setTickBarSize

Constructor Detail

PointAndFigureFeedDescriptor

public PointAndFigureFeedDescriptor(Instrument instrument,
                                    PriceRange boxSize,
                                    ReversalAmount reversalAmount,
                                    OfferSide offerSide)

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

Parameters:

instrument - instrument

boxSize - box size

reversalAmount - reversal amount

offerSide - offer side

PointAndFigureFeedDescriptor

public PointAndFigureFeedDescriptor(Instrument instrument,
                                    PriceRange boxSize,
                                    ReversalAmount reversalAmount,
                                    OfferSide offerSide,
                                    Period basePeriod)

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

Parameters:

instrument - instrument

boxSize - box size

reversalAmount - reversal amount

offerSide - offer side

basePeriod - the period, in which the point and figure bars are calculated. If base period is given Period.INFINITY, then point and figure 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.

PointAndFigureFeedDescriptor

public PointAndFigureFeedDescriptor(Instrument instrument,
                                    PriceRange boxSize,
                                    ReversalAmount reversalAmount,
                                    OfferSide offerSide,
                                    Period basePeriod,
                                    DataInterpolationDescriptor interpolationDescriptor)

Deprecated. Interpolation descriptor is not used for P&F calculation any more. See PointAndFigureFeedDescriptor(com.dukascopy.api.Instrument, com.dukascopy.api.PriceRange, com.dukascopy.api.ReversalAmount, com.dukascopy.api.OfferSide, com.dukascopy.api.Period, com.dukascopy.api.feed.CalculationMethod, com.dukascopy.api.Period)

Constructor, that sets all required fields.

Parameters:

instrument - instrument

boxSize - box size

reversalAmount - reversal amount

offerSide - offer side

basePeriod - the period, in which the point and figure bars are calculated. If base period is given Period.INFINITY, then point and figure 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.

interpolationDescriptor - tick interpolation descriptor. If null, the DataInterpolationDescriptor.DEFAULT interpolation is used. To get most suitable interpolation descriptor, use DataInterpolationDescriptor.getSuitableDataInterpolationDescriptor(PriceRange priceRange, ReversalAmount reversalAmount) method. To find more about tick interpolation from candles and it's purpose, see DataInterpolationDescriptor.

PointAndFigureFeedDescriptor

public PointAndFigureFeedDescriptor(Instrument instrument,
                                    PriceRange boxSize,
                                    ReversalAmount reversalAmount,
                                    OfferSide offerSide,
                                    Period timeSession,
                                    CalculationMethod calculationMethod,
                                    Period basePeriod)

Constructor, that sets all required fields.

Parameters:

instrument - instrument

boxSize - box size

reversalAmount - reversal amount

offerSide - offer side

timeSession - time session

calculationMethod - calculation method

basePeriod - the period, in which the point and figure bars are calculated. If base period is given Period.INFINITY, then point and figure 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

setTimeSession

public void setTimeSession(Period timeSession)

Description copied from class: FeedDescriptor

Setter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI, DataType.POINT_AND_FIGURE session period

Specified by:

setTimeSession in interface IFeedDescriptor

Overrides:

setTimeSession in class FeedDescriptor

Parameters:

timeSession - session period

setCalculationMethod

public void setCalculationMethod(CalculationMethod calculationMethod)

Description copied from class: FeedDescriptor

Setter for DataType.POINT_AND_FIGURE calculation method.

Specified by:

setCalculationMethod in interface IFeedDescriptor

Overrides:

setCalculationMethod in class FeedDescriptor

Parameters:

calculationMethod - CalculationMethod