com.dukascopy.api.feed
Interface IFeedDescriptor

All Known Implementing Classes:
FeedDescriptor, 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))

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))

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

Renkos are defined by
DataType.RENKO (setter - setDataType(DataType)),
Instrument (setter - setInstrument(Instrument)),
PriceRange called brick size (setter - setPriceRange(PriceRange)),
OfferSide (setter - setOfferSide(OfferSide))

Method Summary
 DataType getDataType()
          Getter for data type
 Filter getFilter()
          Getter for filter
 Instrument getInstrument()
          Getter for instrument
 OfferSide getOfferSide()
          Getter for offer side
 Period getPeriod()
          Getter for period
 PriceRange getPriceRange()
          Getter for price range
 ReversalAmount getReversalAmount()
          Getter for reversal amount
 TickBarSize getTickBarSize()
          Getter for tick bar size
 void setDataType(DataType dataType)
          Setter for data type
 void setFilter(Filter filter)
          Setter for filter
 void setInstrument(Instrument instrument)
          Setter for instrument
 void setOfferSide(OfferSide offerSide)
          Setter for offer side
 void setPeriod(Period period)
          Setter for period
 void setPriceRange(PriceRange priceRange)
          Setter for price range
 void setReversalAmount(ReversalAmount reversalAmount)
          Setter for reversal amount
 void setTickBarSize(TickBarSize tickBarSize)
          Setter for tick bar size
 

Method Detail

getInstrument

Instrument getInstrument()
Getter for instrument

Returns:
instrument

setInstrument

void setInstrument(Instrument instrument)
Setter for instrument

Parameters:
instrument -

getOfferSide

OfferSide getOfferSide()
Getter for offer side

Returns:

setOfferSide

void setOfferSide(OfferSide offerSide)
Setter for offer side

Parameters:
offerSide -

getDataType

DataType getDataType()
Getter for data type

Returns:

setDataType

void setDataType(DataType dataType)
Setter for data type

Parameters:
dataType -

getPeriod

Period getPeriod()
Getter for period

Returns:

setPeriod

void setPeriod(Period period)
Setter for period

Parameters:
period -

getPriceRange

PriceRange getPriceRange()
Getter for price range

Returns:

setPriceRange

void setPriceRange(PriceRange priceRange)
Setter for price range

Parameters:
priceRange -

getReversalAmount

ReversalAmount getReversalAmount()
Getter for reversal amount

Returns:
reversal amount

setReversalAmount

void setReversalAmount(ReversalAmount reversalAmount)
Setter for reversal amount

Parameters:
reversalAmount -

getTickBarSize

TickBarSize getTickBarSize()
Getter for tick bar size

Returns:
tick bar size

setTickBarSize

void setTickBarSize(TickBarSize tickBarSize)
Setter for tick bar size

Parameters:
tickBarSize -

getFilter

Filter getFilter()
Getter for filter

Returns:
filter

setFilter

void setFilter(Filter filter)
Setter for filter

Parameters:
filter -