org.pentaho.platform.uifoundation.chart
Class DialChartComponent

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.services.PentahoMessenger
          org.pentaho.platform.uifoundation.component.BaseUIComponent
              org.pentaho.platform.uifoundation.component.xml.XmlComponent
                  org.pentaho.platform.uifoundation.chart.AbstractChartComponent
                      org.pentaho.platform.uifoundation.chart.AbstractJFreeChartComponent
                          org.pentaho.platform.uifoundation.chart.DialChartComponent

All Implemented Interfaces:

Serializable, ILogger, IUIComponent, IXMLComponent

public class DialChartComponent
extends AbstractJFreeChartComponent

See Also:

Serialized Form

Field Summary

static String	MAXVALUE_NODE_NAME
static String	MINVALUE_NODE_NAME
static int	TYPE_DIAL
static int	TYPE_THERMOMETER
static String	VALUE_NODE_NAME

Fields inherited from class org.pentaho.platform.uifoundation.chart.AbstractChartComponent

CHART_NODE_NAME, FILENAME_INDEX, FILENAME_WITHOUT_EXTENSION_INDEX, PARAM2_NODE_NAME, URLTEMPLATE_NODE_NAME

Fields inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent

debug

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

DialChartComponent(int chartType, String definitionPath, int width, int height, IPentahoUrlFactory urlFactory, List messages)

DialChartComponent(IPentahoUrlFactory urlFactory, List messages)

DialChartComponent(String definitionPath, IPentahoUrlFactory urlFactory, ArrayList messages)

Method Summary

Dataset	createChart(Document doc) Creates a Dataset object (actaully one of it's subclasses from the XML doc
Document	getXmlContent()
void	setValue(double value) Sets the value to be displayed by the dial.
boolean	validate()

Methods inherited from class org.pentaho.platform.uifoundation.chart.AbstractJFreeChartComponent

getChartType, getDataDefinitiont, getResourceAsDocument, setChartType, setDataAction, setDataDefinition

Methods inherited from class org.pentaho.platform.uifoundation.chart.AbstractChartComponent

addOuterParamName, dispose, getActionData, getActionName, getActionOutput, getActionPath, getContext, getDefinitionPath, getHeight, getInstanceId, getLogger, getParamName, getSolution, getTitle, getUrlTemplate, getValues, getWidth, isByRow, setActionName, setActionOutput, setActionPath, setByRow, setContext, setDataAction, setDefinitionPath, setHeight, setInstanceId, setLogger, setParamName, setSolution, setTitle, setUrlTemplate, setValues, setWidth

Methods inherited from class org.pentaho.platform.uifoundation.component.xml.XmlComponent

getContent

Methods inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent

done, getObjectParameter, getParameter, getParameterAsArray, getParameterProviders, getXsl, getXslProperties, handleRequest, setParameterProvider, setParameterProviders, setRequestHandler, setUrlFactory, setXsl, setXslProperty, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALUE_NODE_NAME

public static final String VALUE_NODE_NAME

See Also:

Constant Field Values

MAXVALUE_NODE_NAME

public static final String MAXVALUE_NODE_NAME

See Also:

Constant Field Values

MINVALUE_NODE_NAME

public static final String MINVALUE_NODE_NAME

See Also:

Constant Field Values

TYPE_DIAL

public static final int TYPE_DIAL

See Also:

Constant Field Values

TYPE_THERMOMETER

public static final int TYPE_THERMOMETER

See Also:

Constant Field Values

Constructor Detail

DialChartComponent

public DialChartComponent(int chartType,
                          String definitionPath,
                          int width,
                          int height,
                          IPentahoUrlFactory urlFactory,
                          List messages)

DialChartComponent

public DialChartComponent(String definitionPath,
                          IPentahoUrlFactory urlFactory,
                          ArrayList messages)

DialChartComponent

public DialChartComponent(IPentahoUrlFactory urlFactory,
                          List messages)

Method Detail

createChart

public Dataset createChart(Document doc)

Description copied from class: AbstractJFreeChartComponent

Creates a Dataset object (actaully one of it's subclasses from the XML doc

Specified by:

createChart in class AbstractJFreeChartComponent

Parameters:

doc - XML document that describes the chart

Returns:

the Dataset Implementation

getXmlContent

public Document getXmlContent()

Specified by:

getXmlContent in interface IXMLComponent

Specified by:

getXmlContent in class XmlComponent

validate

public boolean validate()

Specified by:

validate in interface IUIComponent

Specified by:

validate in class BaseUIComponent

setValue

public void setValue(double value)

Sets the value to be displayed by the dial.

Parameters:

value - The dial value