Class AbstractChartComponent
- 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
-
- All Implemented Interfaces:
Serializable
,org.pentaho.platform.api.engine.ILogger
,org.pentaho.platform.api.ui.IUIComponent
,org.pentaho.platform.api.ui.IXMLComponent
- Direct Known Subclasses:
AbstractJFreeChartComponent
public abstract class AbstractChartComponent extends XmlComponent
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected String
actionOutput
protected String
actionPath
protected boolean
byRow
static String
CHART_NODE_NAME
XML Node for the chart configurationprotected static int
chartCount
protected org.pentaho.platform.api.engine.IRuntimeContext
context
protected String
definitionPath
static int
FILENAME_INDEX
Index into array of the filenamestatic int
FILENAME_WITHOUT_EXTENSION_INDEX
Index into array of the filename without the extensionprotected int
height
protected String
instanceId
protected static org.apache.commons.logging.Log
logger
protected List<String>
outerParamNames
static String
PARAM2_NODE_NAME
XML node for the series nameprotected String
paramName
protected String
title
protected String
urlTemplate
static String
URLTEMPLATE_NODE_NAME
XML node for the URL Templateprotected Object
values
protected int
width
-
Fields inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent
contentTypes, debug, urlFactory, xslProperties
-
Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase
EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractChartComponent(String definitionPath, int width, int height, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)
protected
AbstractChartComponent(String definitionPath, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, ArrayList messages)
protected
AbstractChartComponent(org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addOuterParamName(String outerParamName)
protected void
applyOuterURLTemplateParam()
protected String[]
createTempFile()
void
dispose()
org.pentaho.commons.connection.IPentahoResultSet
getActionData()
Gets a IPentahoResultSet from the action outputString
getActionOutput()
String
getActionPath()
org.pentaho.platform.api.engine.IRuntimeContext
getContext()
String
getDefinitionPath()
int
getHeight()
String
getInstanceId()
org.apache.commons.logging.Log
getLogger()
String
getParamName()
String
getTitle()
String
getUrlTemplate()
Object
getValues()
int
getWidth()
boolean
isByRow()
void
setActionOutput(String actionOutput)
void
setActionPath(String actionPath)
void
setByRow(boolean byRow)
void
setContext(org.pentaho.platform.api.engine.IRuntimeContext context)
abstract boolean
setDataAction(String chartDefinition)
void
setDataAction(String actionPath, String actionOutput)
Sets the action to be executed to get the data for the piesvoid
setDefinitionPath(String definitionPath)
void
setHeight(int height)
void
setInstanceId(String instanceId)
void
setLogger(org.apache.commons.logging.Log logger)
void
setParamName(String paramName)
void
setTitle(String title)
void
setUrlTemplate(String urlTemplate)
void
setValues(Object values)
void
setWidth(int width)
-
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, getRequestHandler, getSession, getSourcePath, getUrlFactory, getXsl, getXslProperties, handleRequest, setParameterProvider, setParameterProviders, setRequestHandler, setSourcePath, setUrlFactory, setXsl, setXslProperty, validate, validate
-
Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger
debug, debug, error, 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
-
-
-
-
Field Detail
-
CHART_NODE_NAME
public static final String CHART_NODE_NAME
XML Node for the chart configuration- See Also:
- Constant Field Values
-
URLTEMPLATE_NODE_NAME
public static final String URLTEMPLATE_NODE_NAME
XML node for the URL Template- See Also:
- Constant Field Values
-
PARAM2_NODE_NAME
public static final String PARAM2_NODE_NAME
XML node for the series name- See Also:
- Constant Field Values
-
FILENAME_INDEX
public static final int FILENAME_INDEX
Index into array of the filename- See Also:
- Constant Field Values
-
FILENAME_WITHOUT_EXTENSION_INDEX
public static final int FILENAME_WITHOUT_EXTENSION_INDEX
Index into array of the filename without the extension- See Also:
- Constant Field Values
-
definitionPath
protected String definitionPath
-
width
protected int width
-
height
protected int height
-
title
protected String title
-
values
protected Object values
-
byRow
protected boolean byRow
-
actionPath
protected String actionPath
-
actionOutput
protected String actionOutput
-
instanceId
protected String instanceId
-
context
protected org.pentaho.platform.api.engine.IRuntimeContext context
-
urlTemplate
protected String urlTemplate
-
paramName
protected String paramName
-
chartCount
protected static int chartCount
-
logger
protected static org.apache.commons.logging.Log logger
-
-
Constructor Detail
-
AbstractChartComponent
protected AbstractChartComponent(String definitionPath, int width, int height, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)
-
AbstractChartComponent
protected AbstractChartComponent(String definitionPath, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, ArrayList messages)
- Parameters:
definitionPath
-urlFactory
-messages
-
-
AbstractChartComponent
protected AbstractChartComponent(org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)
-
-
Method Detail
-
setDataAction
public abstract boolean setDataAction(String chartDefinition)
- Parameters:
chartDefinition
- String that represents a file in the solution to create the chart from.- Returns:
-
setDataAction
public void setDataAction(String actionPath, String actionOutput)
Sets the action to be executed to get the data for the pies- Parameters:
solution
-actionPath
-actionName
-actionOutput
-
-
getActionData
public org.pentaho.commons.connection.IPentahoResultSet getActionData()
Gets a IPentahoResultSet from the action output- Returns:
- IPentahoResultSet
-
getLogger
public org.apache.commons.logging.Log getLogger()
- Specified by:
getLogger
in classBaseUIComponent
-
createTempFile
protected String[] createTempFile()
- Returns:
- String that represents the file path to a temporary file
-
applyOuterURLTemplateParam
protected void applyOuterURLTemplateParam()
-
dispose
public void dispose()
-
getActionOutput
public String getActionOutput()
- Returns:
- Returns the actionOutput.
-
setActionOutput
public void setActionOutput(String actionOutput)
- Parameters:
actionOutput
- The actionOutput to set.
-
getActionPath
public String getActionPath()
- Returns:
- Returns the actionPath.
-
setActionPath
public void setActionPath(String actionPath)
- Parameters:
actionPath
- The actionPath to set.
-
getContext
public org.pentaho.platform.api.engine.IRuntimeContext getContext()
- Returns:
- Returns the context.
-
setContext
public void setContext(org.pentaho.platform.api.engine.IRuntimeContext context)
- Parameters:
context
- The context to set.
-
getDefinitionPath
public String getDefinitionPath()
- Returns:
- Returns the definitionPath.
-
setDefinitionPath
public void setDefinitionPath(String definitionPath)
- Parameters:
definitionPath
- The definitionPath to set.
-
getHeight
public int getHeight()
- Returns:
- Returns the height.
-
setHeight
public void setHeight(int height)
- Parameters:
height
- The height to set.
-
getInstanceId
public String getInstanceId()
- Returns:
- Returns the instanceId.
-
setInstanceId
public void setInstanceId(String instanceId)
- Parameters:
instanceId
- The instanceId to set.
-
getTitle
public String getTitle()
- Returns:
- Returns the title.
-
setTitle
public void setTitle(String title)
- Parameters:
title
- The title to set.
-
getUrlTemplate
public String getUrlTemplate()
- Returns:
- Returns the urlTemplate.
-
setUrlTemplate
public void setUrlTemplate(String urlTemplate)
- Parameters:
urlTemplate
- The urlTemplate to set.
-
getValues
public Object getValues()
- Returns:
- Returns the values.
-
setValues
public void setValues(Object values)
- Parameters:
values
- The values to set.
-
getWidth
public int getWidth()
- Returns:
- Returns the width.
-
setWidth
public void setWidth(int width)
- Parameters:
width
- The width to set.
-
setLogger
public void setLogger(org.apache.commons.logging.Log logger)
- Parameters:
logger
- The logger to set.
-
isByRow
public boolean isByRow()
- Returns:
- Returns the byRow.
-
setByRow
public void setByRow(boolean byRow)
- Parameters:
byRow
- The byRow to set.
-
getParamName
public String getParamName()
- Returns:
- Returns the paramName.
-
setParamName
public void setParamName(String paramName)
- Parameters:
paramName
- The paramName to set.
-
addOuterParamName
public void addOuterParamName(String outerParamName)
- Parameters:
outerParamName
- The outerParamNames name to add to the outParamNames list.
-
-