org.pentaho.platform.plugin.action.deprecated

Class UtilityComponent

java.lang.Object

org.pentaho.platform.engine.core.system.PentahoBase

org.pentaho.platform.engine.services.PentahoMessenger

org.pentaho.platform.engine.services.solution.ComponentBase

org.pentaho.platform.plugin.action.deprecated.UtilityComponent

All Implemented Interfaces:

Serializable, org.pentaho.platform.api.engine.IAuditable, org.pentaho.platform.api.engine.IComponent, org.pentaho.platform.api.engine.ILogger, org.pentaho.platform.api.engine.IParameterResolver

public class UtilityComponent
extends ComponentBase

Provides utilities to help manipulate parameters used in action sequences.

• format - Java style message formatting
• getvalues - Make the key value pairs from a property map available as action-outputs
• copy - Set the action-output with the value of the action input
• tostring - Sets the action-output to the string value of the action-input
• -

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

COMPONENT_EXECUTE_FAIL, debug, MISSING_SESSION, UNKNOWN_COMPONENT_ID

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

EMPTYLOGID, loggingLevel, 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

Constructors

Constructor and Description
UtilityComponent()

Method Summary

Modifier and Type	Method and Description
void	done()
protected boolean	executeAction()
protected Object	getActionParameterValue(String name)
org.apache.commons.logging.Log	getLogger()
boolean	init()
protected boolean	validateAction()
protected boolean	validateSystemSettings()

Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

addTempParameter, addTempParameterObject, applyInputsToFormat, audit, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, feedbackAllowed, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getContentOutputItem, getDefaultOutputStream, getFeedbackOutputStream, getId, getInitFailMessage, getInitOk, getInputBooleanValue, getInputLongValue, getInputNames, getInputParameter, getInputStream, getInputStringValue, getInputStringValue, getInputValue, getInstanceId, getLogId, getObjectName, getOutputContentItem, getOutputContentItem, getOutputItem, getOutputItem, getOutputNames, getOutputPreference, getProcessId, getResource, getResourceAsString, getResourceDataSource, getResourceInputStream, getResourceNames, getRuntimeContext, getSession, getSetting, getSolutionName, getSolutionPath, getStringSetting, inputMissingError, isDefinedInput, isDefinedOutput, isDefinedResource, isPromptPending, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, saveSetting, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setFeedbackMimeType, setInstanceId, setOutputMimeType, setOutputMimeType, setOutputValue, setProcessId, setRuntimeContext, setSession, 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, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.platform.api.engine.IComponent

getMessages, setMessages

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

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Constructor Detail

UtilityComponent

public UtilityComponent()

Method Detail

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class PentahoBase

validateSystemSettings

protected boolean validateSystemSettings()

Specified by:

validateSystemSettings in class ComponentBase

validateAction

protected boolean validateAction()

Specified by:

validateAction in class ComponentBase

done

public void done()

Specified by:

done in interface org.pentaho.platform.api.engine.IComponent

Specified by:

done in class ComponentBase

executeAction

protected boolean executeAction()

Specified by:

executeAction in class ComponentBase

init

public boolean init()

Specified by:

init in interface org.pentaho.platform.api.engine.IComponent

Specified by:

init in class ComponentBase

getActionParameterValue

protected Object getActionParameterValue(String name)