com.dukascopy.api.indicators
Interface IIndicatorsProvider

public interface IIndicatorsProvider

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

getGroups

java.util.Collection<java.lang.String> getGroups()

Returns list of indicator groups

Returns:

list of indicator groups

getNames

java.util.Collection<java.lang.String> getNames(java.lang.String groupName)

Returns indicator names that belongs to specified group

Parameters:

groupName - indicator group

Returns:

indicator names

getAllNames

java.util.Collection<java.lang.String> getAllNames()

Returns list of all indicator names

Returns:

list of all indicator names

getIndicator

IIndicator getIndicator(java.lang.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(java.lang.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(java.lang.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

java.lang.String getTitle(java.lang.String name)

Returns indicator's title

Parameters:

name - name of the indicator

Returns:

indicator's title

registerUserIndicator

java.lang.String registerUserIndicator(java.io.File compiledCustomIndcatorFile)
                                       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

registerUserIndicator

java.lang.String registerUserIndicator(java.io.File compiledCustomIndicatorFile,
                                       boolean packInJfx)
                                       throws JFException

Attempts to open and register custom indicator in the system If packInJfx is set true then all custom indicator files will be packaged inside indicators's jfx file

Parameters:

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

packInJfx - true if indicator .jfx file is packaged inside indicators's jfx file

Returns:

the name of registered indicator

Throws:

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