com.dukascopy.api.indicators

Interface IIndicatorsProvider

public interface IIndicatorsProvider

Interface to get indicator groups, indicator names, and indicators themselves

Author:

Dmitry Shohov

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getAllNames() Returns list of all indicator names
Collection<String>	getGroups() Returns list of indicator groups
IIndicator	getIndicator(String name) Returns indicator with specified name or null if no indicator was found
IIndicator	getIndicator(String name, IIndicatorContext context) Returns indicator with specified name or null if no indicator was found
Collection<String>	getNames(String groupName) Returns indicator names that belongs to specified group
String	getTitle(String name) Returns indicator's title
boolean	isEnabledOnCharts(String indicatorName) Returns true if indicator should be available in add indicator dialog
String	registerUserIndicator(File compiledCustomIndicatorFile) Attempts to open and register custom indicator in the system

Method Detail

getGroups

Collection<String> getGroups()

Returns list of indicator groups

Returns:

list of indicator groups

getNames

Collection<String> getNames(String groupName)

Returns indicator names that belongs to specified group

Parameters:

groupName - indicator group

Returns:

indicator names

getAllNames

Collection<String> getAllNames()

Returns list of all indicator names

Returns:

list of all indicator names

getIndicator

IIndicator getIndicator(String name,
                      IIndicatorContext context)

Returns indicator with specified name or null if no indicator was found

Parameters:

name - name of the indicator

context - instance of IIndicatorContext

Returns:

indicator

getIndicator

IIndicator getIndicator(String name)

Returns indicator with specified name or null if no indicator was found

Parameters:

name - name of the indicator

Returns:

indicator

isEnabledOnCharts

boolean isEnabledOnCharts(String indicatorName)

Returns true if indicator should be available in add indicator dialog

Parameters:

indicatorName - name of the indicator

Returns:

true if indicator should be available in add indicator dialog or false otherwise

getTitle

String getTitle(String name)

Returns indicator's title

Parameters:

name - name of the indicator

Returns:

indicator's title

registerUserIndicator

String registerUserIndicator(File compiledCustomIndicatorFile)
                             throws JFException

Attempts to open and register custom indicator in the system

Parameters:

compiledCustomIndicatorFile - file with the compiled indicator (the one with .jfx extension)

Returns:

the name of registered indicator

Throws:

JFException - when indicator does not exist or can not be instantiated or does not pass the validation