com.dukascopy.api.indicators
Class IndicatorInfo

java.lang.Object
  com.dukascopy.api.indicators.IndicatorInfo

public class IndicatorInfo
extends Object

Describes indicator

Constructor Summary

IndicatorInfo()
Creates IndicatorInfo without filling any fields

IndicatorInfo(String name, String title, String groupName, boolean overChart, boolean overVolumes, boolean unstablePeriod, boolean candlesticks, int numberOfInputs, int numberOfOptionalInputs, int numberOfOutputs)
Deprecated. all "candlesticks" indicators are just "overChart" indicators with specific output type

IndicatorInfo(String name, String title, String groupName, boolean overChart, boolean overVolumes, boolean unstablePeriod, int numberOfInputs, int numberOfOptionalInputs, int numberOfOutputs)
Creates IndicatorInfo and fills all fields

Method Summary

String	getGroupName() Returns name of the group
String	getName() Returns name of the indicator.
int	getNumberOfInputs() Returns number of inputs, that should be provided before calling function
int	getNumberOfOptionalInputs() Returns number of optional inputs, that can be set to customize function
int	getNumberOfOutputs() Returns number of indicator outputs.
String	getTitle() Returns title of the indicator
boolean	isCandlesticks() Deprecated. always returns false
boolean	isOverChart() Returns true if indicator should be drawn over chart
boolean	isOverVolumes() Returns true if indicator should be shown over volumes
boolean	isRecalculateAll() Returns true if indicator should be recalculated for all chart data
boolean	isShowOnTicks() Returns true if indicator should be shown on ticks (true by default)
boolean	isSparceIndicator() Return true if indcator is "sparce indicator", that doesn't generates values for every candle
boolean	isUnstablePeriod() Returns true if indicator has unstable period (like EMA or SAR).
void	setCandlesticks(boolean candlesticks) Deprecated. if true, then makes indicator "overChart"
void	setGroupName(String groupName) Sets name of the group
void	setName(String name) Sets name of the indicator.
void	setNumberOfInputs(int numberOfInputs) Sets number of inputs
void	setNumberOfOptionalInputs(int numberOfOptionalInputs) Sets number of optional inputs
void	setNumberOfOutputs(int numberOfOutputs) Sets number of outputs, that indicator will return
void	setOverChart(boolean overChart) Sets flag that defines where indicator should be drawn
void	setOverVolumes(boolean overVolumes) Sets flag that defines where indicator should be drawn
void	setRecalculateAll(boolean recalculateAll) If set to true, then indicator will be recalculated for all chart data, instead of calculating it only for new arriving candle
void	setShowOnTicks(boolean showOnTicks) Set this to false if indicator shouldn't be shown on ticks
void	setSparceIndicator(boolean sparceIndicator) Set this flag to true if indicator doesn't draw values for every candle, like ZigZag indicator.
void	setTitle(String title) Sets title of the indicator
void	setUnstablePeriod(boolean unstablePeriod) Sets flag that defines if indicator has unstable period

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndicatorInfo

public IndicatorInfo()

Creates IndicatorInfo without filling any fields

IndicatorInfo

public IndicatorInfo(String name,
                     String title,
                     String groupName,
                     boolean overChart,
                     boolean overVolumes,
                     boolean unstablePeriod,
                     boolean candlesticks,
                     int numberOfInputs,
                     int numberOfOptionalInputs,
                     int numberOfOutputs)

Deprecated. all "candlesticks" indicators are just "overChart" indicators with specific output type

Creates IndicatorInfo and fills all fields

Parameters:

name - name of the indicator. Should be something simple like SMA for Simple Moving Average or BBANDS for Bollinger Bands

title - title of the indicator

groupName - name of the indicator group

overChart - true if indicator should be drawn over candles/ticks

overVolumes - true if indicator should be drawn over volume information

unstablePeriod - true if indicator has unstable period (like EMA or SAR). This will add more candles in every call to stabilize function

candlesticks - true if indicator is Pattern Recognition function and should be shown over bars

numberOfInputs - number of inputs that user should provide

numberOfOptionalInputs - number of optional inputs

numberOfOutputs - number of outputs, that function returns

IndicatorInfo

public IndicatorInfo(String name,
                     String title,
                     String groupName,
                     boolean overChart,
                     boolean overVolumes,
                     boolean unstablePeriod,
                     int numberOfInputs,
                     int numberOfOptionalInputs,
                     int numberOfOutputs)

Creates IndicatorInfo and fills all fields

Parameters:

name - name of the indicator. Should be something simple like SMA for Simple Moving Average or BBANDS for Bollinger Bands

title - title of the indicator

groupName - name of the indicator group

overChart - true if indicator should be drawn over candles/ticks

overVolumes - true if indicator should be drawn over volume information

unstablePeriod - true if indicator has unstable period (like EMA or SAR). This will add more candles in every call to stabilize function

numberOfInputs - number of inputs that user should provide

numberOfOptionalInputs - number of optional inputs

numberOfOutputs - number of outputs, that function returns

Method Detail

getName

public String getName()

Returns name of the indicator. Should be something simple like SMA for Simple Moving Average or BBANDS for Bollinger Bands

Returns:

name of the indicator

setName

public void setName(String name)

Sets name of the indicator. Should be something simple like SMA for Simple Moving Average or BBANDS for Bollinger Bands

Parameters:

name - name of the indicator

getTitle

public String getTitle()

Returns title of the indicator

Returns:

title of the indicator

setTitle

public void setTitle(String title)

Sets title of the indicator

Parameters:

title - title of the indicator

getGroupName

public String getGroupName()

Returns name of the group

Returns:

name of the group

setGroupName

public void setGroupName(String groupName)

Sets name of the group

Parameters:

groupName - name of the group

isOverChart

public boolean isOverChart()

Returns true if indicator should be drawn over chart

Returns:

true if indicator should be drawn over chart

setOverChart

public void setOverChart(boolean overChart)

Sets flag that defines where indicator should be drawn

Parameters:

overChart - true if indicator should be drawn over chart

isOverVolumes

public boolean isOverVolumes()

Returns true if indicator should be shown over volumes

Returns:

true if indicator should be shown over volumes

setOverVolumes

public void setOverVolumes(boolean overVolumes)

Sets flag that defines where indicator should be drawn

Parameters:

overVolumes - true if indicator should be shown over volumes

isUnstablePeriod

public boolean isUnstablePeriod()

Returns true if indicator has unstable period (like EMA or SAR). This will add more candles in every call to stabilize function

Returns:

true if indicator has unstable period

setUnstablePeriod

public void setUnstablePeriod(boolean unstablePeriod)

Sets flag that defines if indicator has unstable period

Parameters:

unstablePeriod - true if indicator has unstable period

isCandlesticks

public boolean isCandlesticks()

Deprecated. always returns false

setCandlesticks

public void setCandlesticks(boolean candlesticks)

Deprecated. if true, then makes indicator "overChart"

getNumberOfInputs

public int getNumberOfInputs()

Returns number of inputs, that should be provided before calling function

Returns:

number of inputs

setNumberOfInputs

public void setNumberOfInputs(int numberOfInputs)

Sets number of inputs

Parameters:

numberOfInputs - number of inputs

getNumberOfOptionalInputs

public int getNumberOfOptionalInputs()

Returns number of optional inputs, that can be set to customize function

Returns:

number of optional inputs

setNumberOfOptionalInputs

public void setNumberOfOptionalInputs(int numberOfOptionalInputs)

Sets number of optional inputs

Parameters:

numberOfOptionalInputs - number of optional inputs

getNumberOfOutputs

public int getNumberOfOutputs()

Returns number of indicator outputs. Usually every output represents one line

Returns:

number of outputs

setNumberOfOutputs

public void setNumberOfOutputs(int numberOfOutputs)

Sets number of outputs, that indicator will return

Parameters:

numberOfOutputs - number of outputs

isShowOnTicks

public boolean isShowOnTicks()

Returns true if indicator should be shown on ticks (true by default)

Returns:

true if indicator should be shown on ticks

setShowOnTicks

public void setShowOnTicks(boolean showOnTicks)

Set this to false if indicator shouldn't be shown on ticks

Parameters:

showOnTicks - true if indicator should be shown on ticks

isRecalculateAll

public boolean isRecalculateAll()

Returns true if indicator should be recalculated for all chart data

Returns:

true if indicator should be recalculated for all chart data

setRecalculateAll

public void setRecalculateAll(boolean recalculateAll)

If set to true, then indicator will be recalculated for all chart data, instead of calculating it only for new arriving candle

Parameters:

recalculateAll -

isSparceIndicator

public boolean isSparceIndicator()

Return true if indcator is "sparce indicator", that doesn't generates values for every candle

Returns:

"sparce indicator" flag

setSparceIndicator

public void setSparceIndicator(boolean sparceIndicator)

Set this flag to true if indicator doesn't draw values for every candle, like ZigZag indicator. This will force drawing on more data than is visible on the screen making it slower, but with correct lines that goes beyond the chart edge.

Parameters:

sparceIndicator - draw indicator on more data than is visible on the screen