org.pentaho.platform.uifoundation.chart
Class AbstractJFreeChartComponent

java.lang.Object
  extended by org.pentaho.platform.engine.core.system.PentahoBase
      extended by org.pentaho.platform.engine.services.PentahoMessenger
          extended by org.pentaho.platform.uifoundation.component.BaseUIComponent
              extended by org.pentaho.platform.uifoundation.component.xml.XmlComponent
                  extended by org.pentaho.platform.uifoundation.chart.AbstractChartComponent
                      extended by org.pentaho.platform.uifoundation.chart.AbstractJFreeChartComponent
All Implemented Interfaces:
Serializable, ILogger, IUIComponent, IXMLComponent
Direct Known Subclasses:
CategoryDatasetChartComponent, DialChartComponent, PieDatasetChartComponent, TimeSeriesCollectionChartComponent, XYSeriesCollectionChartComponent, XYZSeriesCollectionChartComponent

public abstract class AbstractJFreeChartComponent
extends AbstractChartComponent

See Also:
Serialized Form

Field Summary
 
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
 
Method Summary
abstract  Dataset createChart(Document doc)
          Creates a Dataset object (actaully one of it's subclasses from the XML doc
 int getChartType()
           
 Dataset getDataDefinitiont()
           
static Document getResourceAsDocument(IPentahoSession userSession, IActionSequenceResource actionResource)
           
 void setChartType(int chartType)
           
 boolean setDataAction(String chartDefinition)
           
 void setDataDefinition(Dataset dataSet)
           
 
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, getXmlContent
 
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, 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
 

Method Detail

createChart

public abstract Dataset createChart(Document doc)
Creates a Dataset object (actaully one of it's subclasses from the XML doc

Parameters:
doc - XML document that describes the chart
Returns:
the Dataset Implementation

getDataDefinitiont

public Dataset getDataDefinitiont()
Returns:
Returns the dataSet.

setDataDefinition

public void setDataDefinition(Dataset dataSet)
Parameters:
dataSet - The dataSet to set.

getChartType

public int getChartType()
Returns:
Returns the chartType.

setChartType

public void setChartType(int chartType)
Parameters:
chartType - The chartType to set.

setDataAction

public boolean setDataAction(String chartDefinition)
Specified by:
setDataAction in class AbstractChartComponent
Parameters:
chartDefinition - String that represents a file in the solution to create the chart from.
Returns:

getResourceAsDocument

public static Document getResourceAsDocument(IPentahoSession userSession,
                                             IActionSequenceResource actionResource)
                                      throws IOException
Throws:
IOException