Class SettingsDescriptor

java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingsDescriptor
public class SettingsDescriptor extends Object
Contains all of the SettingDescriptor instances that describe the user configurable settings for the study. These settings are organized into tabs to be displayed in the Study Dialog.

  • Constructor Details

    • SettingsDescriptor

      public SettingsDescriptor()

  • Method Details

    • clear

      public void clear()

    • getSettings

      public List<SettingDescriptor> getSettings()
      Gets all of the SettingDescriptor instances declared for this study

    • getSetting

      public SettingDescriptor getSetting(String id)
      Gets all of the SettingDescriptor associated with the given name.

    • getDefaultValue

      public Object getDefaultValue(String name)
      Gets the default value for the setting associated with the given name.

    • getTabs

      public List<SettingTab> getTabs()
      Gets the tabs (as displayed in the Study Dialog).

    • addTab

      public void addTab(SettingTab tab)
      Adds a SettingTab.

    • addTab

      public SettingTab addTab(String tabName)
      Convenience Method. Creates a SettingTab with the given name and adds it to the the list of tabs.
      Parameters:
      tabName - name of the tab
      Returns:
      setting tab that was created

    • addTab

      public SettingTab addTab(String tabName, String header)
      Convenience Method. Creates a SettingTab with the given name and adds it to the the list of tabs.
      Parameters:
      tabName - name of the tab
      header - header that is displayed at the top of the tab
      Returns:
      setting tab that was created

    • addDependency

      public void addDependency(InputDependency d)
      Adds a dependency between 2 or more SettingDescriptors

    • getDependencies

      public List<InputDependency> getDependencies()
      Gets the list of setting dependencies.

    • getDependencies

      public List<InputDependency> getDependencies(String id)

    • addInvisibleSetting

      public void addInvisibleSetting(SettingDescriptor sd)
      Adds a setting that is not part of the UI. Effectively, these settings are not visible to the user.

    • addInvisible

      public void addInvisible(SettingDescriptor... sds)

    • addQuickSettings

      public void addQuickSettings(String... ids)
      Retrieves the setting (if it exists) and adds it as a quick setting.

    • addQuickSettings

      public void addQuickSettings(SettingDescriptor... sds)
      Adds a setting that can be displayed in a tool bar or in the Quick Editor.

    • getQuickSettings

      public List<SettingDescriptor> getQuickSettings()

    • setOnQSUpdated

      public void setOnQSUpdated(String id, SettingsDescriptor.OnUpdated onUpdated)

    • getOnQSUpdated

      public SettingsDescriptor.OnUpdated getOnQSUpdated(String id)

    • addDisplaySettings

      public void addDisplaySettings(String... ids)

    • getDisplaySettings

      public List<SettingDescriptor> getDisplaySettings()

    • rowAlign

      public void rowAlign(String... ids)
      Indicates that the Quick Settings with the given ids should be aligned on the same row (when displaying the Quick Editor)

    • getRowAligns

      public List<String[]> getRowAligns()

    • getStrategySettings

      public List<SettingDescriptor> getStrategySettings()
      Gets the list of settings that are used to configure the strategy. These are used as part of the Back Test and Optimize features. By default this will return non display descriptors.

    • setStrategySettings

      public void setStrategySettings(List<SettingDescriptor> settings)
      Sets the settings used to configure the strategy. These are used by the back test/optimize/walk forward features.

    • addStrategySetting

      public void addStrategySetting(SettingDescriptor setting)
      Adds a setting used to configure the strategy. These are used by the back test/optimize/walk forward features.