com.exponto.jstock.indicators
Class CandleStick

java.lang.Object
  extended bycom.exponto.jstock.indicators.Indicator
      extended bycom.exponto.jstock.indicators.CandleStick
All Implemented Interfaces:
IndicatorInterface, IndicatorLinesInterface

public class CandleStick
extends Indicator
implements IndicatorInterface, IndicatorLinesInterface

CandleStick draws a logarithmic candlestick chart. Note that this class doesn't have any indicator parameters (for now) and returns null when asked for some.

Author:
kaare

Field Summary
 
Fields inherited from class com.exponto.jstock.indicators.Indicator
sm_indicatorColor, sm_indicatorName, sm_isDisplayed
 
Constructor Summary
CandleStick()
           
 
Method Summary
 boolean drawWithCandleSticks()
          Information for the class that allocates screenspace wheter a particular indicator requires a separate screen space or if it shall be painted with the candlesticks.
 java.lang.String getDailyPrintOut(int n)
          Makes a String with name, parameters and value (e.g.
 IndicatorAxisInfo getIndicatorAxisInfo()
           
 java.lang.String getIndicatorName()
           
 IndicatorParameters getIndicatorParameters()
          This returns the IndicatorParameter used together with a specific indicator.
 boolean hasChanged()
          Check if the calling class can use data obtained from a previous call to paintIndicator or not.
 void initiateIndicator(LogDataSeries lDS)
          Initiates an indicator with the provided LogDataSeries combined with indicator specific parameters either provied from a properties file or the user.
 void initiateIndicator(LogDataSeries lDS, IndicatorParameters indParam)
           
 void initiateIndicator(LogDataSeries lDS, java.lang.String indParam)
          As above but with Indicatorparameters provided in a string format.
 boolean isMainIndicator()
          One of the indicators is a main indicator and is given more screen space than the rest.
 void markSelectedStick(java.awt.Graphics2D g2d, int number, int lMargin, int tMargin)
           
 void paintIndicator(java.awt.Graphics2D g, GraphicsParameters gP)
          Sends the Indicator a Graphics2D and asks it to paint itself on that Graphics.
 java.lang.String[] printAll(int number)
          Generates an Array of strings that is suitable for printing to file or debugging purposes with all data within the range.
static void setMinorLineLevel(int minorLineLevel)
           
static void setVolumeScale(double volumeScale)
           
 boolean supportIndicatorValuesInterface()
          Return true if theIndicatorValuesInterface is implemented for this class.
 java.lang.String toString()
           
 
Methods inherited from class com.exponto.jstock.indicators.Indicator
displayNumberToArrayIndex, getColor, getDisplayed, setColor, setDisplayed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.exponto.jstock.indicators.IndicatorInterface
getDisplayed, setDisplayed
 

Constructor Detail

CandleStick

public CandleStick()
Method Detail

setVolumeScale

public static void setVolumeScale(double volumeScale)

setMinorLineLevel

public static void setMinorLineLevel(int minorLineLevel)

getIndicatorName

public java.lang.String getIndicatorName()
Specified by:
getIndicatorName in interface IndicatorInterface
Overrides:
getIndicatorName in class Indicator

getIndicatorParameters

public IndicatorParameters getIndicatorParameters()
Description copied from interface: IndicatorInterface
This returns the IndicatorParameter used together with a specific indicator. If none is specifically defined in the class, the default static indicatorparameter is returned.

Specified by:
getIndicatorParameters in interface IndicatorInterface
Specified by:
getIndicatorParameters in class Indicator

initiateIndicator

public void initiateIndicator(LogDataSeries lDS)
Description copied from interface: IndicatorInterface
Initiates an indicator with the provided LogDataSeries combined with indicator specific parameters either provied from a properties file or the user.

Specified by:
initiateIndicator in interface IndicatorInterface
Specified by:
initiateIndicator in class Indicator

initiateIndicator

public void initiateIndicator(LogDataSeries lDS,
                              IndicatorParameters indParam)

initiateIndicator

public void initiateIndicator(LogDataSeries lDS,
                              java.lang.String indParam)
Description copied from interface: IndicatorInterface
As above but with Indicatorparameters provided in a string format. The string will be passed on to a new instance of indicatorParameters for decoding.

Specified by:
initiateIndicator in interface IndicatorInterface
Specified by:
initiateIndicator in class Indicator

isMainIndicator

public boolean isMainIndicator()
Description copied from interface: IndicatorInterface
One of the indicators is a main indicator and is given more screen space than the rest. At the time of writing only on main indicator is supported (candlesticks). If more than one indicator a mechanism for selecting one of them must be written.

Specified by:
isMainIndicator in interface IndicatorInterface
Overrides:
isMainIndicator in class Indicator

drawWithCandleSticks

public boolean drawWithCandleSticks()
Description copied from interface: IndicatorInterface
Information for the class that allocates screenspace wheter a particular indicator requires a separate screen space or if it shall be painted with the candlesticks.

Specified by:
drawWithCandleSticks in interface IndicatorInterface
Specified by:
drawWithCandleSticks in class Indicator

hasChanged

public boolean hasChanged()
Description copied from interface: IndicatorInterface
Check if the calling class can use data obtained from a previous call to paintIndicator or not. The intention is that the calling class may store the graphics in an image in order to speed up the drawing time (at the cost of memory)

Specified by:
hasChanged in interface IndicatorInterface
Specified by:
hasChanged in class Indicator

paintIndicator

public void paintIndicator(java.awt.Graphics2D g,
                           GraphicsParameters gP)
Description copied from interface: IndicatorInterface
Sends the Indicator a Graphics2D and asks it to paint itself on that Graphics.

Specified by:
paintIndicator in interface IndicatorInterface
Specified by:
paintIndicator in class Indicator

markSelectedStick

public void markSelectedStick(java.awt.Graphics2D g2d,
                              int number,
                              int lMargin,
                              int tMargin)

getDailyPrintOut

public java.lang.String getDailyPrintOut(int n)
Description copied from interface: IndicatorInterface
Makes a String with name, parameters and value (e.g. "RSI(14) = 74") that can be used to print information about a particular day on screen. The Indicators them self has only indirect knowledge about dates other than start and stop date for the indicator, so the indicator number displayed on screen are used. 0 is the leftmost visible indicator.

Specified by:
getDailyPrintOut in interface IndicatorInterface
Specified by:
getDailyPrintOut in class Indicator

printAll

public java.lang.String[] printAll(int number)
Description copied from interface: IndicatorInterface
Generates an Array of strings that is suitable for printing to file or debugging purposes with all data within the range. There shall be one String per timeperiode (e.g. one per day for daily charts). A header String may also be generated. Note that the start and stop values shall be based on the original LogDataSeries and not the indicator series. If the indicatorSeries has no valid data for parts of the series "not valid" may be printed.

Specified by:
printAll in interface IndicatorInterface
Specified by:
printAll in class Indicator

supportIndicatorValuesInterface

public boolean supportIndicatorValuesInterface()
Description copied from interface: IndicatorInterface
Return true if theIndicatorValuesInterface is implemented for this class.

Specified by:
supportIndicatorValuesInterface in interface IndicatorInterface
Returns:
true if the IndicatorValuesInterface is supporteted, false otherwise.

toString

public java.lang.String toString()

getIndicatorAxisInfo

public IndicatorAxisInfo getIndicatorAxisInfo()
Specified by:
getIndicatorAxisInfo in interface IndicatorLinesInterface


Copyright © 2004 Kaare Ranum