com.dukascopy.api.feed

Class FeedDescriptor

java.lang.Object

com.dukascopy.api.feed.FeedDescriptor

All Implemented Interfaces:

IFeedDescriptor

Direct Known Subclasses:

KagiFeedDescriptor, LineBreakFeedDescriptor, PointAndFigureFeedDescriptor, RangeBarFeedDescriptor, RenkoFeedDescriptor, TickBarFeedDescriptor, TicksFeedDescriptor, TimePeriodAggregationFeedDescriptor

public class FeedDescriptor
extends java.lang.Object
implements IFeedDescriptor

Implementation of IFeedDescriptor

Author:

Mark Vilkel

Field Summary

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

DEFAULT_BASE_PERIOD, INFINITE_BASE_PERIOD

Constructor Summary

Constructors

Constructor and Description
FeedDescriptor() Default constructor
FeedDescriptor(DataType dataType, Instrument instrument, Period period, OfferSide offerSide)
FeedDescriptor(DataType dataType, Instrument instrument, Period period, OfferSide offerSide, PriceRange priceRange, ReversalAmount reversalAmount, TickBarSize tickBarSize, Filter filter)
FeedDescriptor(IFeedDescriptor feedDescriptor) Copy constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
CalculationMethod	getCalculationMethod() Getter for DataType.POINT_AND_FIGURE calculation method.
CreationPoint	getCreationPoint() Getter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI data creation point
DataInterpolationDescriptor	getDataInterpolationDescriptor() Getter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.
DataType	getDataType() Getter for data type
Filter	getFilter() Getter for filter
Instrument	getInstrument() Getter for instrument
LineBreakLookback	getLineBreakLookback() Getter for DataType.LINE_BREAK number of look-back lines.
OfferSide	getOfferSide() Getter for offer side
Period	getPeriod() Getter for period
PriceRange	getPriceRange() Getter for price range
RenkoCreationPoint	getRenkoCreationPoint() Getter for DataType.RENKO data creation point
Period	getRenkoSession() Getter for DataType.RENKO session period
RenkoType	getRenkoType() Getter for DataType.RENKO bricks type.
ReversalAmount	getReversalAmount() Getter for reversal amount
TickBarSize	getTickBarSize() Getter for tick bar size
Period	getTimeSession() Getter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI, DataType.POINT_AND_FIGURE session period
int	hashCode()
void	setCalculationMethod(CalculationMethod calculationMethod) Setter for DataType.POINT_AND_FIGURE calculation method.
void	setCreationPoint(CreationPoint creationPoint) Setter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI data creation point
void	setDataInterpolationDescriptor(DataInterpolationDescriptor interpolationDescriptor) Setter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.
void	setDataType(DataType dataType) Setter for data type.
void	setFilter(Filter filter) Setter for filter
void	setInstrument(Instrument instrument) Setter for instrument
void	setLineBreakLookback(LineBreakLookback numOfLines) Setter for DataType.LINE_BREAK number of look-back lines.
void	setOfferSide(OfferSide offerSide) Setter for offer side
void	setPeriod(Period period) Setter for period.
void	setPriceRange(PriceRange priceRange) Setter for price range
void	setRenkoCreationPoint(RenkoCreationPoint renkoCreationPoint) Setter for DataType.RENKO data creation point
void	setRenkoSession(Period nissonRenkoSessionPeriod) Setter for DataType.RENKO session period
void	setRenkoType(RenkoType renkoType) Setter for DataType.RENKO bricks type.
void	setReversalAmount(ReversalAmount reversalAmount) Setter for reversal amount
void	setTickBarSize(TickBarSize tickBarSize) Setter for tick bar size
void	setTimeSession(Period timeSession) Setter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI, DataType.POINT_AND_FIGURE session period
java.lang.String	toString()
static Period	validateBasePeriod(Period basePeriod)
protected static CalculationMethod	validateCalculationMethod(CalculationMethod calculationMethod)
protected static CreationPoint	validateCreationPoint(CreationPoint creationPoint)
protected static LineBreakLookback	validateLineBreakLookback(LineBreakLookback lookbackLines)
protected static PriceRange	validatePriceRange(PriceRange reversalAmount)
protected static RenkoCreationPoint	validateRenkoCreationPoint(RenkoCreationPoint creationPoint)
protected static Period	validateRenkoSession(Period renkoSession)
protected static RenkoType	validateRenkoType(RenkoType renkoType)
protected static Period	validateTimeSession(Period timeSession)
protected static PriceRange	validateTurnaroundAmount(PriceRange reversalAmount)
static FeedDescriptor	valueOf(java.lang.String paramValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedDescriptor

public FeedDescriptor()

Default constructor

FeedDescriptor

public FeedDescriptor(DataType dataType,
                      Instrument instrument,
                      Period period,
                      OfferSide offerSide)

FeedDescriptor

public FeedDescriptor(DataType dataType,
                      Instrument instrument,
                      Period period,
                      OfferSide offerSide,
                      PriceRange priceRange,
                      ReversalAmount reversalAmount,
                      TickBarSize tickBarSize,
                      Filter filter)

FeedDescriptor

public FeedDescriptor(IFeedDescriptor feedDescriptor)

Copy constructor

Parameters:

feedDescriptor - IFeedDescriptor

Method Detail

getInstrument

public Instrument getInstrument()

Getter for instrument

Specified by:

getInstrument in interface IFeedDescriptor

Returns:

instrument

setInstrument

public void setInstrument(Instrument instrument)

Setter for instrument

Specified by:

setInstrument in interface IFeedDescriptor

Parameters:

instrument - instrument

getOfferSide

public OfferSide getOfferSide()

Getter for offer side

Specified by:

getOfferSide in interface IFeedDescriptor

Returns:

offer side

setOfferSide

public void setOfferSide(OfferSide offerSide)

Setter for offer side

Specified by:

setOfferSide in interface IFeedDescriptor

Parameters:

offerSide - offer side

getDataType

public DataType getDataType()

Getter for data type

Specified by:

getDataType in interface IFeedDescriptor

Returns:

data type

setDataType

public void setDataType(DataType dataType)

Setter for data type.

Specified by:

setDataType in interface IFeedDescriptor

Parameters:

dataType - data type

getPeriod

public Period getPeriod()

Getter for period

Specified by:

getPeriod in interface IFeedDescriptor

Returns:

period

setPeriod

public void setPeriod(Period period)

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

Parameters:

period - period

getPriceRange

public PriceRange getPriceRange()

Getter for price range

Specified by:

getPriceRange in interface IFeedDescriptor

Returns:

price range

setPriceRange

public void setPriceRange(PriceRange priceRange)

Setter for price range

Specified by:

setPriceRange in interface IFeedDescriptor

Parameters:

priceRange - price range

getReversalAmount

public ReversalAmount getReversalAmount()

Getter for reversal amount

Specified by:

getReversalAmount in interface IFeedDescriptor

Returns:

reversal amount

setReversalAmount

public void setReversalAmount(ReversalAmount reversalAmount)

Setter for reversal amount

Specified by:

setReversalAmount in interface IFeedDescriptor

Parameters:

reversalAmount - reversal amount

getTickBarSize

public TickBarSize getTickBarSize()

Getter for tick bar size

Specified by:

getTickBarSize in interface IFeedDescriptor

Returns:

tick bar size

setTickBarSize

public void setTickBarSize(TickBarSize tickBarSize)

Setter for tick bar size

Specified by:

setTickBarSize in interface IFeedDescriptor

Parameters:

tickBarSize - tick bar size

getFilter

public Filter getFilter()

Getter for filter

Specified by:

getFilter in interface IFeedDescriptor

Returns:

filter

setFilter

public void setFilter(Filter filter)

Setter for filter

Specified by:

setFilter in interface IFeedDescriptor

Parameters:

filter - filter

setRenkoSession

public void setRenkoSession(Period nissonRenkoSessionPeriod)

Setter for DataType.RENKO session period

Specified by:

setRenkoSession in interface IFeedDescriptor

Parameters:

nissonRenkoSessionPeriod - Renko session period

getRenkoSession

public Period getRenkoSession()

Getter for DataType.RENKO session period

Specified by:

getRenkoSession in interface IFeedDescriptor

Returns:

Renko session period

setTimeSession

public void setTimeSession(Period timeSession)

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

Specified by:

setTimeSession in interface IFeedDescriptor

Parameters:

timeSession - session period

getTimeSession

public Period getTimeSession()

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

Specified by:

getTimeSession in interface IFeedDescriptor

Returns:

session period

getRenkoCreationPoint

public RenkoCreationPoint getRenkoCreationPoint()

Getter for DataType.RENKO data creation point

Specified by:

getRenkoCreationPoint in interface IFeedDescriptor

Returns:

RenkoCreationPoint

setRenkoCreationPoint

public void setRenkoCreationPoint(RenkoCreationPoint renkoCreationPoint)

Setter for DataType.RENKO data creation point

Specified by:

setRenkoCreationPoint in interface IFeedDescriptor

Parameters:

renkoCreationPoint - RenkoCreationPoint

setCreationPoint

public void setCreationPoint(CreationPoint creationPoint)

Setter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI data creation point

Specified by:

setCreationPoint in interface IFeedDescriptor

Parameters:

creationPoint - CreationPoint

getCreationPoint

public CreationPoint getCreationPoint()

Getter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI data creation point

Specified by:

getCreationPoint in interface IFeedDescriptor

Returns:

CreationPoint

setLineBreakLookback

public void setLineBreakLookback(LineBreakLookback numOfLines)

Setter for DataType.LINE_BREAK number of look-back lines.

Specified by:

setLineBreakLookback in interface IFeedDescriptor

Parameters:

numOfLines - LineBreakLookback

getLineBreakLookback

public LineBreakLookback getLineBreakLookback()

Getter for DataType.LINE_BREAK number of look-back lines.

Specified by:

getLineBreakLookback in interface IFeedDescriptor

Returns:

LineBreakLookback

setDataInterpolationDescriptor

public void setDataInterpolationDescriptor(DataInterpolationDescriptor interpolationDescriptor)

Setter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.

Specified by:

setDataInterpolationDescriptor in interface IFeedDescriptor

Parameters:

interpolationDescriptor - DataInterpolationDescriptor

getDataInterpolationDescriptor

public DataInterpolationDescriptor getDataInterpolationDescriptor()

Getter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.

Specified by:

getDataInterpolationDescriptor in interface IFeedDescriptor

Returns:

DataInterpolationDescriptor

setRenkoType

public void setRenkoType(RenkoType renkoType)

Setter for DataType.RENKO bricks type.

Specified by:

setRenkoType in interface IFeedDescriptor

Parameters:

renkoType - RenkoType

getRenkoType

public RenkoType getRenkoType()

Getter for DataType.RENKO bricks type.

Specified by:

getRenkoType in interface IFeedDescriptor

Returns:

RenkoType

setCalculationMethod

public void setCalculationMethod(CalculationMethod calculationMethod)

Setter for DataType.POINT_AND_FIGURE calculation method.

Specified by:

setCalculationMethod in interface IFeedDescriptor

Parameters:

calculationMethod - CalculationMethod

getCalculationMethod

public CalculationMethod getCalculationMethod()

Getter for DataType.POINT_AND_FIGURE calculation method.

Specified by:

getCalculationMethod in interface IFeedDescriptor

Returns:

CalculationMethod

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueOf

public static FeedDescriptor valueOf(java.lang.String paramValue)

validateBasePeriod

public static Period validateBasePeriod(Period basePeriod)

validateRenkoSession

protected static Period validateRenkoSession(Period renkoSession)

validateTimeSession

protected static Period validateTimeSession(Period timeSession)

validateRenkoCreationPoint

protected static RenkoCreationPoint validateRenkoCreationPoint(RenkoCreationPoint creationPoint)

validateCreationPoint

protected static CreationPoint validateCreationPoint(CreationPoint creationPoint)

validateLineBreakLookback

protected static LineBreakLookback validateLineBreakLookback(LineBreakLookback lookbackLines)

validatePriceRange

protected static PriceRange validatePriceRange(PriceRange reversalAmount)

validateTurnaroundAmount

protected static PriceRange validateTurnaroundAmount(PriceRange reversalAmount)

validateRenkoType

protected static RenkoType validateRenkoType(RenkoType renkoType)

validateCalculationMethod

protected static CalculationMethod validateCalculationMethod(CalculationMethod calculationMethod)