public class FeedDescriptor extends java.lang.Object implements IFeedDescriptor
IFeedDescriptor
DEFAULT_BASE_PERIOD, INFINITE_BASE_PERIOD
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
|
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) |
public FeedDescriptor()
public FeedDescriptor(DataType dataType, Instrument instrument, Period period, OfferSide offerSide)
public FeedDescriptor(DataType dataType, Instrument instrument, Period period, OfferSide offerSide, PriceRange priceRange, ReversalAmount reversalAmount, TickBarSize tickBarSize, Filter filter)
public FeedDescriptor(IFeedDescriptor feedDescriptor)
feedDescriptor
- IFeedDescriptorpublic Instrument getInstrument()
getInstrument
in interface IFeedDescriptor
public void setInstrument(Instrument instrument)
setInstrument
in interface IFeedDescriptor
instrument
- instrumentpublic OfferSide getOfferSide()
getOfferSide
in interface IFeedDescriptor
public void setOfferSide(OfferSide offerSide)
setOfferSide
in interface IFeedDescriptor
offerSide
- offer sidepublic DataType getDataType()
getDataType
in interface IFeedDescriptor
public void setDataType(DataType dataType)
setDataType
in interface IFeedDescriptor
dataType
- data typepublic Period getPeriod()
getPeriod
in interface IFeedDescriptor
public void setPeriod(Period period)
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.setPeriod
in interface IFeedDescriptor
period
- periodpublic PriceRange getPriceRange()
getPriceRange
in interface IFeedDescriptor
public void setPriceRange(PriceRange priceRange)
setPriceRange
in interface IFeedDescriptor
priceRange
- price rangepublic ReversalAmount getReversalAmount()
getReversalAmount
in interface IFeedDescriptor
public void setReversalAmount(ReversalAmount reversalAmount)
setReversalAmount
in interface IFeedDescriptor
reversalAmount
- reversal amountpublic TickBarSize getTickBarSize()
getTickBarSize
in interface IFeedDescriptor
public void setTickBarSize(TickBarSize tickBarSize)
setTickBarSize
in interface IFeedDescriptor
tickBarSize
- tick bar sizepublic Filter getFilter()
getFilter
in interface IFeedDescriptor
public void setFilter(Filter filter)
setFilter
in interface IFeedDescriptor
filter
- filterpublic void setRenkoSession(Period nissonRenkoSessionPeriod)
setRenkoSession
in interface IFeedDescriptor
nissonRenkoSessionPeriod
- Renko session periodpublic Period getRenkoSession()
getRenkoSession
in interface IFeedDescriptor
public void setTimeSession(Period timeSession)
setTimeSession
in interface IFeedDescriptor
timeSession
- session periodpublic Period getTimeSession()
getTimeSession
in interface IFeedDescriptor
public RenkoCreationPoint getRenkoCreationPoint()
getRenkoCreationPoint
in interface IFeedDescriptor
public void setRenkoCreationPoint(RenkoCreationPoint renkoCreationPoint)
setRenkoCreationPoint
in interface IFeedDescriptor
renkoCreationPoint
- RenkoCreationPointpublic void setCreationPoint(CreationPoint creationPoint)
setCreationPoint
in interface IFeedDescriptor
creationPoint
- CreationPointpublic CreationPoint getCreationPoint()
getCreationPoint
in interface IFeedDescriptor
public void setLineBreakLookback(LineBreakLookback numOfLines)
setLineBreakLookback
in interface IFeedDescriptor
numOfLines
- LineBreakLookbackpublic LineBreakLookback getLineBreakLookback()
getLineBreakLookback
in interface IFeedDescriptor
public void setDataInterpolationDescriptor(DataInterpolationDescriptor interpolationDescriptor)
setDataInterpolationDescriptor
in interface IFeedDescriptor
interpolationDescriptor
- DataInterpolationDescriptorpublic DataInterpolationDescriptor getDataInterpolationDescriptor()
getDataInterpolationDescriptor
in interface IFeedDescriptor
public void setRenkoType(RenkoType renkoType)
setRenkoType
in interface IFeedDescriptor
renkoType
- RenkoTypepublic RenkoType getRenkoType()
getRenkoType
in interface IFeedDescriptor
public void setCalculationMethod(CalculationMethod calculationMethod)
setCalculationMethod
in interface IFeedDescriptor
calculationMethod
- CalculationMethodpublic CalculationMethod getCalculationMethod()
getCalculationMethod
in interface IFeedDescriptor
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static FeedDescriptor valueOf(java.lang.String paramValue)
protected static RenkoCreationPoint validateRenkoCreationPoint(RenkoCreationPoint creationPoint)
protected static CreationPoint validateCreationPoint(CreationPoint creationPoint)
protected static LineBreakLookback validateLineBreakLookback(LineBreakLookback lookbackLines)
protected static PriceRange validatePriceRange(PriceRange reversalAmount)
protected static PriceRange validateTurnaroundAmount(PriceRange reversalAmount)
protected static CalculationMethod validateCalculationMethod(CalculationMethod calculationMethod)
Copyright © 2024. All rights reserved.