public class RuntimeDescriptor
extends java.lang.Object
Constructor and Description |
---|
RuntimeDescriptor()
Creates a RuntimeDescriptor object.
|
Modifier and Type | Method and Description |
---|---|
void |
addHorizontalLine(LineInfo info)
Adds a horizontal line to the default plot using the information defined in LineInfo.
|
void |
addPlot(java.lang.String name,
Plot plot)
Adds a new plot to the study.
|
void |
declareBars(java.lang.Object valueKey)
Declare bar sequence on the default plot using the default settings for drawing bars.
|
void |
declareBars(java.lang.Object valueKey,
java.lang.String settingsKey)
Declare a bar sequence associated with the given value key for the default plot.
|
void |
declareIndicator(java.lang.Object valueKey,
java.lang.String indicatorKey)
Associates a value key to an indicator on the default plot.
|
void |
declarePath(java.lang.Object valueKey,
java.lang.String pathSettingsKey)
Declare a path associated with the given value key for the default plot.
|
void |
declareSignal(java.lang.Object key,
java.lang.String label)
Declare a signal with the given key and user readable string.
|
void |
exportValue(ValueDescriptor desc)
Exports a value so that it may be used outside of the context of the study.
|
ValueDescriptor |
findExportedValue(java.lang.String keyString)
Finds the exported value using a string key.
|
java.util.Map<java.lang.Object,java.lang.String> |
getBars()
Gets the map of declared bars for the default plot.
|
int |
getBottomInsetPixels()
Gets the bottom inset for the default plot (in pixels).
|
Plot |
getDefaultPlot()
Gets the default plot.
|
ValueDescriptor |
getExportedValue(java.lang.Object key)
Gets the exported value associated with the given key.
|
java.util.List<ValueDescriptor> |
getExportedValues()
Gets the list of exported values.
|
java.lang.Integer |
getFixedBottomValue()
Gets the 'fixed' bottom value (null if not defined).
|
java.lang.Integer |
getFixedTopValue()
Gets the 'fixed' top value (null if not defined).
|
java.util.List<LineInfo> |
getHorizontalLines()
Gets the list of horizontal lines declared for the default plot.
|
java.util.List<java.lang.String> |
getIDSettings()
Gets the set of settings that are part of the ID for the default plot.
|
java.util.Map<java.lang.Object,java.lang.String> |
getIndicators()
Gets the map of declared indicators for the default plot.
|
java.lang.String |
getLabelPrefix()
Gets the label prefix for the default plot.
|
java.util.List<java.lang.String> |
getLabelSettings()
Gets the label settings for the default plot.
|
java.lang.Integer |
getMaxBottomValue()
Gets the 'maximum' bottom value (null if not defined).
|
java.lang.Double |
getMinTick()
Gets the minimum tick value for the vertical axis of the default plot (if this is not an overlay).
|
java.lang.Integer |
getMinTopValue()
Gets the 'minimum' top value (null if not defined).
|
java.util.Map<java.lang.Object,java.lang.String> |
getPaths()
Gets the map of declared paths for the default plot.
|
Plot |
getPlot(java.lang.String name)
Gets the plot associated with the given name.
|
java.util.Set<java.lang.String> |
getPlotKeys()
Gets the set of plot keys registered to this study.
|
Plot |
getPricePlot()
Gets the price plot.
|
java.util.List<java.lang.Object> |
getRangeKeys()
Gets the range keys for the default plot.
|
SignalDescriptor |
getSignal(java.lang.Object key)
Gets the signal associated with the given key.
|
java.util.List<SignalDescriptor> |
getSignals()
Gets the list of signals generated by this study.
|
java.lang.String |
getTabName()
Gets the tab name for the default plot.
|
int |
getTopInsetPixels()
Gets the top inset for the default plot (in pixels).
|
BarSize |
getValueSeries(java.lang.Object valueKey)
Gets the data series for the value key.
|
boolean |
isPricePlotRequired()
Indicates that the price plot is required for this study.
|
boolean |
isRangeOrRenkoOnly()
Returns true if this study if only for Range or Renko bars.
|
void |
setBottomInsetPixels(int pixels)
Sets the bottom inset for the default plot (in pixels).
|
void |
setFixedBottomValue(java.lang.Integer value)
Sets the 'fixed' bottom value (null if not defined).
|
void |
setFixedTopValue(java.lang.Integer value)
Sets the 'fixed' top value (null if not defined).
|
void |
setIDSettings(java.lang.String... vals)
Use this method to identify which settings should be part of the default plot identifier.
|
void |
setLabelPrefix(java.lang.String label)
Sets the label prefix for the default plot.
|
void |
setLabelSettings(java.lang.String... vals)
Use this method to identify which settings should be part of
the default plot label (and to identify the study).
|
void |
setMaxBottomValue(java.lang.Integer max)
Sets the 'maximum' bottom value (null if not defined).
|
void |
setMinTick(java.lang.Double minTick)
Sets the minimum tick for the vertical axis of the default plot (if this is not an overlay).
|
void |
setMinTopValue(java.lang.Integer v)
Sets the 'minimum' top value (null if not defined).
|
void |
setPricePlotRequired(boolean b)
Sets the required attribute for the price plot.
|
void |
setRangeKeys(java.lang.Object... keys)
Use this method to identify the numeric values generated by
this study that are to affect the vertical range of the default plot
(when auto scale is turned on).
|
void |
setRangeOrRenkoOnly(boolean b)
Use this method to set a study to be used with Range or Renko bars only.
|
void |
setTabName(java.lang.String label)
Sets the tab name.
|
void |
setTopInsetPixels(int pixels)
Sets the top inset for the default plot (in pixels).
|
void |
setValueSeries(java.lang.Object valueKey,
BarSize barSize)
Sets the data series for the value key.
|
public RuntimeDescriptor()
public void addPlot(java.lang.String name, Plot plot)
name
- plot
- public Plot getPlot(java.lang.String name)
name
- public Plot getDefaultPlot()
public Plot getPricePlot()
public boolean isPricePlotRequired()
public void setPricePlotRequired(boolean b)
b
- true if the price plot is requiredpublic java.util.Set<java.lang.String> getPlotKeys()
public void exportValue(ValueDescriptor desc)
desc
- - describes the exported valuepublic ValueDescriptor getExportedValue(java.lang.Object key)
key
- public java.util.List<ValueDescriptor> getExportedValues()
public ValueDescriptor findExportedValue(java.lang.String keyString)
keyString
- public void declareSignal(java.lang.Object key, java.lang.String label)
key
- label
- public java.util.List<SignalDescriptor> getSignals()
public SignalDescriptor getSignal(java.lang.Object key)
key
- public boolean isRangeOrRenkoOnly()
public void setRangeOrRenkoOnly(boolean b)
b
- true if this study is only for Range or Renko bars.public void setLabelSettings(java.lang.String... vals)
public java.util.List<java.lang.String> getLabelSettings()
public void setIDSettings(java.lang.String... vals)
vals
- ID setting valuespublic java.util.List<java.lang.String> getIDSettings()
public java.lang.String getLabelPrefix()
public void setLabelPrefix(java.lang.String label)
label
- label prefixpublic java.lang.String getTabName()
public void setTabName(java.lang.String label)
label
- tab name labelpublic void setRangeKeys(java.lang.Object... keys)
public java.util.List<java.lang.Object> getRangeKeys()
public void declarePath(java.lang.Object valueKey, java.lang.String pathSettingsKey)
valueKey
- - unique identifier for the valuepathSettingsKey
- - settings key of the pathpublic void setValueSeries(java.lang.Object valueKey, BarSize barSize)
valueKey
- - unique identifier for the valuebarSize
- - bar size of the data series, null for the primary data seriespublic BarSize getValueSeries(java.lang.Object valueKey)
valueKey
- - unique identifier for the valuepublic void declareIndicator(java.lang.Object valueKey, java.lang.String indicatorKey)
valueKey
- indicatorKey
- public void declareBars(java.lang.Object valueKey, java.lang.String settingsKey)
valueKey
- settingsKey
- public void declareBars(java.lang.Object valueKey)
valueKey
- public void addHorizontalLine(LineInfo info)
info
- line info objectpublic int getTopInsetPixels()
public void setTopInsetPixels(int pixels)
pixels
- public int getBottomInsetPixels()
public void setBottomInsetPixels(int pixels)
pixels
- public java.lang.Integer getFixedBottomValue()
public void setFixedBottomValue(java.lang.Integer value)
value
- fixed bottom valuepublic java.lang.Integer getFixedTopValue()
public void setFixedTopValue(java.lang.Integer value)
value
- public java.lang.Integer getMaxBottomValue()
public void setMaxBottomValue(java.lang.Integer max)
max
- maximum bottom valuepublic java.lang.Integer getMinTopValue()
public void setMinTopValue(java.lang.Integer v)
public java.lang.Double getMinTick()
public void setMinTick(java.lang.Double minTick)
minTick
- minimum tick valuepublic java.util.List<LineInfo> getHorizontalLines()
public java.util.Map<java.lang.Object,java.lang.String> getPaths()
public java.util.Map<java.lang.Object,java.lang.String> getIndicators()
public java.util.Map<java.lang.Object,java.lang.String> getBars()