com.dukascopy.api.feed.util

Class LineBreakFeedDescriptor

java.lang.Object

com.dukascopy.api.feed.FeedDescriptor

com.dukascopy.api.feed.util.LineBreakFeedDescriptor

All Implemented Interfaces:

IFeedDescriptor, ITailoredFeedDescriptor<ILineBreak>

public class LineBreakFeedDescriptor
extends FeedDescriptor
implements ITailoredFeedDescriptor<ILineBreak>

Author:

Janis Garsils 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
LineBreakFeedDescriptor(Instrument instrument, OfferSide offerSide) Constructor, that uses minimal set of parameters.
LineBreakFeedDescriptor(Instrument instrument, OfferSide offerSide, Period timeSession) Constructor, that uses default values for: creation point, CreationPoint.CLOSE number of look-back lines, LineBreakLookback.THREE_LINES; base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.
LineBreakFeedDescriptor(Instrument instrument, OfferSide offerSide, Period timeSession, CreationPoint creationPoint) Constructor, that uses default values for: number of look-back lines, LineBreakLookback.THREE_LINES; base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.
LineBreakFeedDescriptor(Instrument instrument, OfferSide offerSide, Period timeSession, CreationPoint creationPoint, LineBreakLookback lookbackLines) Constructor, that uses default values for: base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.
LineBreakFeedDescriptor(Instrument instrument, OfferSide offerSide, Period timeSession, CreationPoint creationPoint, LineBreakLookback lookbackLines, Period basePeriod) Constructor, that sets all required fields.

Method Summary

Modifier and Type	Method and Description
void	setCreationPoint(CreationPoint creationPoint) Setter for DataType.LINE_BREAK, DataType.RENKO, DataType.KAGI data creation point
void	setLineBreakLookback(LineBreakLookback lookbackLines) Setter for DataType.LINE_BREAK number of look-back lines.
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, setCalculationMethod, setDataInterpolationDescriptor, setDataType, setFilter, setInstrument, 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, setCalculationMethod, setDataInterpolationDescriptor, setDataType, setFilter, setInstrument, setOfferSide, setPriceRange, setRenkoCreationPoint, setRenkoSession, setRenkoType, setReversalAmount, setTickBarSize

Constructor Detail

LineBreakFeedDescriptor

public LineBreakFeedDescriptor(Instrument instrument,
                               OfferSide offerSide)

Constructor, that uses minimal set of parameters. Default values are used for:

• time session, Period.TICK
• creation point, CreationPoint.CLOSE
• number of look-back lines, LineBreakLookback.THREE_LINES;
• base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.

Parameters:

instrument - instrument

offerSide - offer side

LineBreakFeedDescriptor

public LineBreakFeedDescriptor(Instrument instrument,
                               OfferSide offerSide,
                               Period timeSession)

Constructor, that uses default values for:

• creation point, CreationPoint.CLOSE
• number of look-back lines, LineBreakLookback.THREE_LINES;
• base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.

Parameters:

instrument - instrument

offerSide - offer side

timeSession - indicates how often we take a price. Can be any valid Period. If null, then default Period.TICK is used.

LineBreakFeedDescriptor

public LineBreakFeedDescriptor(Instrument instrument,
                               OfferSide offerSide,
                               Period timeSession,
                               CreationPoint creationPoint)

Constructor, that uses default values for:

• number of look-back lines, LineBreakLookback.THREE_LINES;
• base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.

Parameters:

instrument - instrument

offerSide - offer side

timeSession - indicates how often we take a price. Can be any valid Period. If null, then default Period.TICK is used.

creationPoint - price point of the time session. If null, then default CreationPoint.CLOSE is used.

LineBreakFeedDescriptor

public LineBreakFeedDescriptor(Instrument instrument,
                               OfferSide offerSide,
                               Period timeSession,
                               CreationPoint creationPoint,
                               LineBreakLookback lookbackLines)

Constructor, that uses default values for:

• base period, IFeedDescriptor.DEFAULT_BASE_PERIOD.

Parameters:

instrument - instrument

offerSide - offer side

timeSession - indicates how often we take a price. Can be any valid Period. If null, then default Period.TICK is used.

creationPoint - price point of the time session. If null, then default CreationPoint.CLOSE is used.

lookbackLines - number of lines which will define turnaround price. If null, then default LineBreakLookback.THREE_LINES is used.

LineBreakFeedDescriptor

public LineBreakFeedDescriptor(Instrument instrument,
                               OfferSide offerSide,
                               Period timeSession,
                               CreationPoint creationPoint,
                               LineBreakLookback lookbackLines,
                               Period basePeriod)

Constructor, that sets all required fields.

Parameters:

instrument - instrument

offerSide - offer side

timeSession - indicates how often we take a price. Can be any valid Period. If null, then default Period.TICK is used.

creationPoint - price point of the time session. If null, then default CreationPoint.CLOSE is used.

lookbackLines - number of lines which will define turnaround price. If null, then default LineBreakLookback.THREE_LINES is used.

basePeriod - the period, in which lines are calculated. If base period is given Period.INFINITY, then new lines are calculated from the beginning of the history. Everything else at data loading time is considered as a default value (IFeedDescriptor.DEFAULT_BASE_PERIOD), 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

setCreationPoint

public void setCreationPoint(CreationPoint creationPoint)

Description copied from class: FeedDescriptor

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

Specified by:

setCreationPoint in interface IFeedDescriptor

Overrides:

setCreationPoint in class FeedDescriptor

Parameters:

creationPoint - CreationPoint

setLineBreakLookback

public void setLineBreakLookback(LineBreakLookback lookbackLines)

Description copied from class: FeedDescriptor

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

Specified by:

setLineBreakLookback in interface IFeedDescriptor

Overrides:

setLineBreakLookback in class FeedDescriptor

Parameters:

lookbackLines - LineBreakLookback