Class Settings

java.lang.Object
com.motivewave.platform.sdk.common.SettingsBase
com.motivewave.platform.sdk.common.Settings
All Implemented Interfaces:
Cloneable
public class Settings extends SettingsBase
Encapsulates the configuration information for a study or strategy.

  • Constructor Details

  • Method Details

    • clearSets

      protected void clearSets()
      Overrides:
      clearSets in class SettingsBase

    • setPath

      public void setPath(String id, PathInfo path)
      Associates the given PathInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the path (key)
      path - path info object

    • getPaths

      public Set<String> getPaths()
      Gets the set of all registered path ids
      Returns:
      a set of all the registered path ids.

    • setMarker

      public void setMarker(String id, MarkerInfo marker)
      Associates the given MarkerInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the marker
      marker - marker info

    • getMarkers

      public Set<String> getMarkers()
      Gets the set of registered marker ids.
      Returns:
      a set of all the registered markers.

    • setIndicator

      public void setIndicator(String id, IndicatorInfo indicator)
      Associates the given IndicatorInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the indicator
      indicator - indicator info object

    • getIndicators

      public Set<String> getIndicators()
      Get the set of all registered indicator ids.
      Returns:
      a set of all the registered indicator ids.

    • setBars

      public void setBars(String id, BarInfo bar)
      Associates the given BarInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the bar info
      bar - bar info object

    • getBars

      public Set<String> getBars()
      Gets the set of all registered bar ids.
      Returns:
      a set of all the registered bar ids.

    • setPriceBar

      public void setPriceBar(String id, PriceBarInfo priceBar)
      Associates the given PriceBarInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the bar info
      priceBar - info object

    • getPriceBars

      public Set<String> getPriceBars()
      Gets the set of all registered price bar ids.
      Returns:
      a set of all the registered price bar ids.

    • setShade

      public void setShade(String id, ShadeInfo shade)
      Associates the given ShadeInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the shade
      shade - shade info object

    • getShades

      public Set<String> getShades()
      Gets the set of all registered shade ids.
      Returns:
      a set of all the registered shade ids.

    • setGuide

      public void setGuide(String id, GuideInfo guide)
      Associates the given GuideInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the guide
      guide - guide info object

    • getGuides

      public Set<String> getGuides()
      Gets the set of all registered guide ids.
      Returns:
      a set of all the registered guides.

    • setFont

      public void setFont(String id, FontInfo font)
      Associates the given FontInfo to the specified id. This is called by the underlying study framework.
      Parameters:
      id - font id
      font - font info object

    • getFonts

      public Set<String> getFonts()
      Gets the set of all registered font ids.
      Returns:
      a set of all the registered font ids.

    • setFile

      public void setFile(String id, File file)
      Associates the given File to the specified id. This is called by the underlying study framework.
      Parameters:
      id - file id
      file - file object

    • getFiles

      public Set<String> getFiles()
      Gets the set of all registered file ids.
      Returns:
      a set of all the registered file ids.

    • setColor

      public void setColor(String id, Color color)
      Associates the given Color to the specified id.
      Parameters:
      id - id of the color
      color - color

    • setColor

      public void setColor(String id, ColorInfo color)
      Associates the given Color to the specified id.
      Parameters:
      id - id of the color
      color - color info object

    • getColors

      public Set<String> getColors()
      Gets the set of all registered color ids.
      Returns:
      a set of all the registered color ids.

    • getInputs

      public Set<String> getInputs()
      Gets the set of all registered input ids.
      Returns:
      a set of all the registered input ids.

    • getMAMethod

      public Enums.MAMethod getMAMethod(String id)
      Gets the Moving Average Calculation method associated to the given id
      Overrides:
      getMAMethod in class SettingsBase
      Parameters:
      id - id of the method
      Returns:
      the MAMethod associated to the given id.

    • getMAMethod

      public Enums.MAMethod getMAMethod(String id, Enums.MAMethod def)
      Gets the Moving Average Calculation method associated to the given id. The given default value is returned if the method is not defined.
      Overrides:
      getMAMethod in class SettingsBase
      Parameters:
      id - id of the method
      def - default value to return if the method is not defined
      Returns:
      the MAMethod associated to the given id.

    • setMAMethod

      public void setMAMethod(String id, Enums.MAMethod method)
      Associates the given MAMethod to the specified id. This is called by the underlying study framework.
      Overrides:
      setMAMethod in class SettingsBase
      Parameters:
      id - id of the method
      method - moving average method

    • getMAMethods

      public Set<String> getMAMethods()
      Gets the set of all registered Moving Average Method ids.
      Returns:
      a set of all the registered MAMethod ids.

    • getBarSizes

      public Set<String> getBarSizes()
      Gets the set of all registered bar size ids.
      Returns:
      a set of all the registered BarSize ids.

    • setInstrument

      public void setInstrument(String id, Instrument instrument)
      Associates the given Instrument to the specified id. This is called by the underlying study framework.
      Overrides:
      setInstrument in class SettingsBase
      Parameters:
      id - id of the instrument
      instrument - instrument to associate

    • getInstruments

      public Set<String> getInstruments()
      Gets the set of all registered instrument ids.
      Returns:
      a set of all the registered Instrument ids.

    • hasInstruments

      public boolean hasInstruments()
      Returns:
      true if instruments are defined

    • getExitPoint

      public ExitPoint getExitPoint(String id)
      Gets the exit point associated to the given id.
      Parameters:
      id - id of the exit point
      Returns:
      the ExitPoint associated to the given id.

    • setExitPoint

      public void setExitPoint(String id, ExitPoint ep)
      Associates the given ExitPoint to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the exit point
      ep - exit point

    • getExitPoints

      public Set<String> getExitPoints()
      Gets the set of all registered Exit Point ids.
      Returns:
      a set of all the registered ExitPoint ids.

    • getTimeFrame

      public TimeFrame getTimeFrame(String id)
      Gets the timeframe associated to the given id.
      Parameters:
      id - id of the timeframe
      Returns:
      the TimeFrame associated to the given id.

    • setTimeFrame

      public void setTimeFrame(String id, TimeFrame tf)
      Associates the given TimeFrame to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the timeframe
      tf - time frame to associate to the given id

    • getTimeFrames

      public Set<String> getTimeFrames()
      Gets the set of all registered time frame ids.
      Returns:
      a set of all the registered TimeFrame ids.

    • getOrderType

      public Enums.OrderType getOrderType(String id)
      Gets the order type associated to the given id.
      Parameters:
      id - id of the order type
      Returns:
      the OrderType associated to the given id.

    • setOrderType

      public void setOrderType(String id, Enums.OrderType type)
      Associates the given OrderType to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the order type
      type - order type

    • getTIF

      public Enums.TIF getTIF(String id)
      Gets the tif (Time In Force) value associated to the given id.
      Parameters:
      id - id of the tif
      Returns:
      time in force associated to the given id

    • setTIF

      public void setTIF(String id, Enums.TIF tif)
      Associates the given TIF (time in force) to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the tif
      tif - time in force

    • getValues

      public Set<String> getValues()
      Gets the set of value keys in the settings.
      Returns:
      set of value keys in the settings

    • setDouble

      public void setDouble(String id, Double val)
      Associates the given double value to the specified id. This is called by the underlying study framework.
      Overrides:
      setDouble in class SettingsBase
      Parameters:
      id - id of the double value
      val - double value

    • setInteger

      public void setInteger(String id, Integer val)
      Associates the given integer value to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the value
      val - value to associate

    • setLong

      public void setLong(String id, Long val)
      Associates the given integer value to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the value
      val - value to associate

    • getBoolean

      public Boolean getBoolean(String id)
      Gets the boolean value associated to the given id.
      Parameters:
      id - id of the value
      Returns:
      associated boolean value

    • getBoolean

      public boolean getBoolean(String id, boolean def)
      Gets the boolean value associated to the given id. The def value is returned if the setting does not exist.
      Parameters:
      id - id of the boolean value
      def - default value to return if the id does not exist
      Returns:
      boolean value

    • setBoolean

      public void setBoolean(String id, Boolean val)
      Associates the given boolean value to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the value
      val - value to associate

    • setString

      public void setString(String id, String val)
      Associates the given string value to the specified id. This is called by the underlying study framework.
      Parameters:
      id - id of the value
      val - string value to associate

    • getSetting

      public Object getSetting(String id)
      Gets the setting associated to the given id.
      Parameters:
      id - id of the setting
      Returns:
      the setting associated with the specified id.

    • update

      public void update(Settings settings)
      Updates the information from the given object. This is called by the underlying study framework.
      Parameters:
      settings - settings object

    • isBarUpdates

      public boolean isBarUpdates()
      Indicates if this study should respond to bar updates instead of only calculating on the close of the bar.
      Returns:
      true if bar updates is enabled.

    • setBarUpdates

      public void setBarUpdates(boolean b)
      Indicates if this study should respond to bar updates instead of only calculating on the close of the bar.
      Parameters:
      b - true if bar updates is enabled.

    • isUseAccountPosition

      public boolean isUseAccountPosition()
      Indicates if this study should use the existing position that is available on the account.
      Returns:
      true if the account position should be used.

    • setUseAccountPosition

      public void setUseAccountPosition(boolean b)
      Indicates if this study should use the existing position that is available on the account.
      Parameters:
      b - true if the account position should be used.

    • isAutoEntry

      public boolean isAutoEntry()
      Indicates if the strategy has auto entry enabled.
      Returns:
      true if auto entry is enabled

    • setAutoEntry

      public void setAutoEntry(boolean b)
      Sets the auto entry attribute for the strategy.
      Parameters:
      b - true if auto entry is enabled

    • getPositionType

      public Enums.PositionType getPositionType()
      Indicates position type to be used with the strategy (long, short or both).
      Returns:
      position type

    • setPositionType

      public void setPositionType(Enums.PositionType p)
      Sets the position type for the strategy.
      Parameters:
      p - position type

    • isEnterOnActivate

      public boolean isEnterOnActivate()
      Indicates if a position should be opened when the strategy is activated. This feature is only set if the strategy supports 'enter on activate' (see StudyHeader).
      Returns:
      true if enter on activate is enabled

    • setEnterOnActivate

      public void setEnterOnActivate(boolean b)
      Indicates if a position should be opened when the strategy is activated. This feature is only set if the strategy supports 'enter on activate' (see StudyHeader).
      Parameters:
      b - true if enter on activate is enabled

    • isCloseOnDeactivate

      public boolean isCloseOnDeactivate()
      Indicates if a position should be closed when the strategy is deactivated. This feature is only set if the strategy supports 'close on deactivate' (see StudyHeader).
      Returns:
      true if close on deactivate is enabled

    • setCloseOnDeactivate

      public void setCloseOnDeactivate(boolean b)
      Indicates if a position should be closed when the strategy is deactivated. This feature is only set if the strategy supports 'close on deactivate' (see StudyHeader).
      Parameters:
      b - true if close on deactivate is enabled

    • setTimeInForce

      public void setTimeInForce(Enums.TIF tif)
      Sets the time in force (TIF) for orders (strategies only).
      Parameters:
      tif - time in force

    • getTimeInForce

      public Enums.TIF getTimeInForce()
      Gets the time in force (TIF) for orders (strategies only).
      Returns:
      time in force

    • setTradeLots

      public void setTradeLots(int tradeLots)
      Sets the number of trade lots to use (strategies only).
      Parameters:
      tradeLots - number of trade lots

    • getTradeLots

      public int getTradeLots()
      Gets the number of trade lots to use (strategies only).
      Returns:
      number of trade lots

    • getSessions

      public List<TimeFrame> getSessions()
      Gets the trading sessions (strategies only).
      Returns:
      trading sessions

    • addSession

      public void addSession(TimeFrame session)
      Adds a session to the strategy. This is called by the underlying study framework.
      Parameters:
      session - trading session

    • clearSessions

      public void clearSessions()

    • isEnterOnSessionStart

      public boolean isEnterOnSessionStart()
      Determines if this strategy should enter automatically when a trading session opens.
      Returns:
      true if this strategy should enter automatically when a trading session opens.

    • setEnterOnSessionStart

      public void setEnterOnSessionStart(boolean b)
      Sets the enter on session start attribute (this is called by the study framework).
      Parameters:
      b - true if enter on session start is enabled

    • isCloseOnSessionEnd

      public boolean isCloseOnSessionEnd()
      Determines if this strategy should exit an open position automatically when a trading session closes.
      Returns:
      true if this strategy should exit an open position automatically when a trading session closes.

    • setCloseOnSessionEnd

      public void setCloseOnSessionEnd(boolean b)
      Sets the close position on session end attribute (this is called by the study framework).
      Parameters:
      b - true if the close position on session end is enabled

    • isTriggerOTH

      public boolean isTriggerOTH()
      Gets the Trigger Outside Trading Hours attribute. If set to true, the order may be triggered outside regular trading hours.
      Returns:
      true if orders can be triggered outside regular trading hours

    • setTriggerOTH

      public void setTriggerOTH(boolean b)
      Sets the Trigger Outside Trading Hours attribute. If set to true, the order may be triggered outside regular trading hours.
      Parameters:
      b - true if orders can be triggered outside regular trading hours

    • getTimeZone

      public TimeZone getTimeZone()
      Gets the timezone for sessions (null for local time zone).
      Returns:
      timezone for sessions

    • setTimeZone

      public void setTimeZone(TimeZone tz)
      Sets the timezone for sessions (null for local time zone).
      Parameters:
      tz - time zone

    • getTbEditorNames

      public List<String> getTbEditorNames()

    • setTbEditorNames

      public void setTbEditorNames(List<String> ids)

    • clone

      public Settings clone()
      Creates a clone (copy) of this object.
      Overrides:
      clone in class SettingsBase
      Returns:
      clone of this object

    • equals

      public boolean equals(Object o)
      Compares this settings object with the given object and returns true if they are equal.
      Overrides:
      equals in class SettingsBase
      Parameters:
      o - object to compare to
      Returns:
      true if this object equals the given object

    • toJson

      public Map<String,Object> toJson()
      Overrides:
      toJson in class SettingsBase

    • fromJson

      public void fromJson(Map<String,Object> json)
      Overrides:
      fromJson in class SettingsBase