com.dukascopy.api.feed

Interface IFeedDescriptor

All Known Subinterfaces:

ITailoredFeedDescriptor<T>

All Known Implementing Classes:

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

public interface IFeedDescriptor

Interface, which describes feed data.

There might be several data types supported by JForex, see DataType

Ticks are defined by
DataType.TICKS (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument))

Candles/Bars are defined by
DataType.TIME_PERIOD_AGGREGATION setter - (setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
OfferSide (setter - setOfferSide(OfferSide)),
Filter (setter - setFilter(Filter)),
Period (setter - setPeriod(Period))

RangeBars are defined by
DataType.PRICE_RANGE_AGGREGATION (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
PriceRange (setter - setPriceRange(PriceRange)),
OfferSide (setter - setOfferSide(OfferSide)),
Period ((base period) setter - setPeriod(Period))

Point and Figures are defined by
DataType.POINT_AND_FIGURE (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
PriceRange called box size (setter - setPriceRange(PriceRange)),
ReversalAmount (setter - setReversalAmount(ReversalAmount)),
OfferSide (setter - setOfferSide(OfferSide)),
Period ((session length) setter - setTimeSession(Period)),
CalculationMethod (setter - setCalculationMethod(CalculationMethod)) Period ((base period) setter - setPeriod(Period)),

Tick Bars are defined by
DataType.TICK_BAR (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
TickBarSize (setter - setTickBarSize(TickBarSize)),
OfferSide (setter - setOfferSide(OfferSide)),
Period ((base period) setter - setPeriod(Period))

Renkos are defined by
DataType.RENKO (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
PriceRange called brick size (setter - setPriceRange(PriceRange)),
OfferSide (setter - setOfferSide(OfferSide),
Period ((session length) setter - setTimeSession(Period)),
CreationPoint (setter - setCreationPoint(CreationPoint)),
Period ((base period) setter - setPeriod(Period)),
RenkoType (setter - setRenkoType(RenkoType))

Line Break lines are defined by
DataType.LINE_BREAK (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
OfferSide (setter - setOfferSide(OfferSide)),
Period ((session length) setter - setTimeSession(Period)),
CreationPoint (setter - setCreationPoint(CreationPoint)),
LineBreakLookback (setter - setLineBreakLookback(LineBreakLookback)),
Period ((base period) setter - setPeriod(Period))

Kagi bars are defined by
DataType.KAGI (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
PriceRange called turnaround amount (setter - setPriceRange(PriceRange)),
OfferSide (setter - setOfferSide(OfferSide)),
Period ((session length) setter - setTimeSession(Period)),
CreationPoint (setter - setCreationPoint(CreationPoint)),
Period ((base period) setter - setPeriod(Period))

Author:

Mark Vilkel, Janis Garsils

Field Summary

Fields

Modifier and Type	Field and Description
static Period	DEFAULT_BASE_PERIOD Base period works as a starting point from which to calculate price aggregation bars.
static Period	INFINITE_BASE_PERIOD

Method Summary

Modifier and Type	Method and Description
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() Deprecated. - use getCreationPoint()
Period	getRenkoSession() Deprecated. - use getTimeSession()
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
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) Deprecated. - use setCreationPoint(CreationPoint creationPoint)
void	setRenkoSession(Period renkoSession) Deprecated. - use setTimeSession(Period timeSession)
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

Field Detail

DEFAULT_BASE_PERIOD

static final Period DEFAULT_BASE_PERIOD

Base period works as a starting point from which to calculate price aggregation bars. E.g. DEFAULT_BASE_PERIOD starts calculation at every Sunday 21:00 or 22:00 UTC (depends on summer/winter time). In theory the calculation of price aggregated bars starts with the first tick of the history. Practically for JForex this means to load all history and calculate bars from the first available tick. This would be very time and resource consuming process. To speed it up, platform uses base period. When the base period starts, price aggr. bars are calculated as if this would be the beginning of the history. So, as a result we don't load all history, but just e.g. 7 days (in case of DEFAULT_BASE_PERIOD).

INFINITE_BASE_PERIOD

static final Period INFINITE_BASE_PERIOD

Method Detail

getInstrument

Instrument getInstrument()

Getter for instrument

Returns:

instrument

setInstrument

void setInstrument(Instrument instrument)

Setter for instrument

Parameters:

instrument - instrument

getOfferSide

OfferSide getOfferSide()

Getter for offer side

Returns:

offer side

setOfferSide

void setOfferSide(OfferSide offerSide)

Setter for offer side

Parameters:

offerSide - offer side

getDataType

DataType getDataType()

Getter for data type

Returns:

data type

setDataType

void setDataType(DataType dataType)

Setter for data type.

Parameters:

dataType - data type

getPeriod

Period getPeriod()

Getter for period

Returns:

period

setPeriod

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 - DEFAULT_BASE_PERIOD). Only two base periods are possible - Period.INFINITY and one week (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 (DEFAULT_BASE_PERIOD).
Period.INFINITY is not allowed on remote run.

Parameters:

period - period

getPriceRange

PriceRange getPriceRange()

Getter for price range

Returns:

price range

setPriceRange

void setPriceRange(PriceRange priceRange)

Setter for price range

Parameters:

priceRange - price range

getReversalAmount

ReversalAmount getReversalAmount()

Getter for reversal amount

Returns:

reversal amount

setReversalAmount

void setReversalAmount(ReversalAmount reversalAmount)

Setter for reversal amount

Parameters:

reversalAmount - reversal amount

getTickBarSize

TickBarSize getTickBarSize()

Getter for tick bar size

Returns:

tick bar size

setTickBarSize

void setTickBarSize(TickBarSize tickBarSize)

Setter for tick bar size

Parameters:

tickBarSize - tick bar size

getFilter

Filter getFilter()

Getter for filter

Returns:

filter

setFilter

void setFilter(Filter filter)

Setter for filter

Parameters:

filter - filter

setRenkoSession

@Deprecated
void setRenkoSession(Period renkoSession)

Deprecated. - use setTimeSession(Period timeSession)

Setter for DataType.RENKO session period

Parameters:

renkoSession - Renko session period

getRenkoSession

@Deprecated
Period getRenkoSession()

Deprecated. - use getTimeSession()

Getter for DataType.RENKO session period

Returns:

Renko session period

setTimeSession

void setTimeSession(Period timeSession)

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

Parameters:

timeSession - session period

getTimeSession

Period getTimeSession()

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

Returns:

session period

setRenkoCreationPoint

@Deprecated
void setRenkoCreationPoint(RenkoCreationPoint renkoCreationPoint)

Deprecated. - use setCreationPoint(CreationPoint creationPoint)

Setter for DataType.RENKO data creation point

Parameters:

renkoCreationPoint - RenkoCreationPoint

getRenkoCreationPoint

@Deprecated
RenkoCreationPoint getRenkoCreationPoint()

Deprecated. - use getCreationPoint()

Getter for DataType.RENKO data creation point

Returns:

RenkoCreationPoint

setCreationPoint

void setCreationPoint(CreationPoint creationPoint)

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

Parameters:

creationPoint - CreationPoint

getCreationPoint

CreationPoint getCreationPoint()

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

Returns:

CreationPoint

setDataInterpolationDescriptor

void setDataInterpolationDescriptor(DataInterpolationDescriptor interpolationDescriptor)

Setter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.

Parameters:

interpolationDescriptor - DataInterpolationDescriptor

getDataInterpolationDescriptor

DataInterpolationDescriptor getDataInterpolationDescriptor()

Getter for DataType.PRICE_RANGE_AGGREGATION DataInterpolationDescriptor.

Returns:

DataInterpolationDescriptor

setLineBreakLookback

void setLineBreakLookback(LineBreakLookback numOfLines)

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

Parameters:

numOfLines - LineBreakLookback

getLineBreakLookback

LineBreakLookback getLineBreakLookback()

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

Returns:

LineBreakLookback

setRenkoType

void setRenkoType(RenkoType renkoType)

Setter for DataType.RENKO bricks type.

Parameters:

renkoType - RenkoType

getRenkoType

RenkoType getRenkoType()

Getter for DataType.RENKO bricks type.

Returns:

RenkoType

setCalculationMethod

void setCalculationMethod(CalculationMethod calculationMethod)

Setter for DataType.POINT_AND_FIGURE calculation method.

Parameters:

calculationMethod - CalculationMethod

getCalculationMethod

CalculationMethod getCalculationMethod()

Getter for DataType.POINT_AND_FIGURE calculation method.

Returns:

CalculationMethod