org.pentaho.platform.engine.services.solution
Class PojoComponent

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.engine.services.solution.PojoComponent

All Implemented Interfaces:

java.io.Serializable, IAuditable, IComponent, ILogger, IParameterResolver

Direct Known Subclasses:

PojoComponent

public class PojoComponent
extends ComponentBase

This class interfaces with a plain old Java object and makes it available as a component within the Pentaho platform. Resources and Input Parameters are set on a Pojo via setters. Any public setter is available to both, without bias. The setters are called individually for Resources and Input Parameters and as such may be called for each one should a parameter exist in both forms. Resources are processed first, followed by Input Parameters giving Input Parameters the power to override. All public getters are exposed through the PojoComponent for consumption as Output Parameters within an Action Sequence. There exist special methods which may be defined on a Pojo (No interface needed) in order to better facilitate integration to the platform. They are as follows: configure validate execute done getOutputs setResources setInputs setLogger setSession setOutputStream / getMimeType

Author:

jamesdixon

See Also:

Serialized Form

Field Summary

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

COMPONENT_EXECUTE_FAIL, MISSING_SESSION

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

PojoComponent()

Method Summary

void	done() Allows the component to perform any cleanup after the execution of the action.
org.apache.commons.logging.Log	getLogger()
boolean	init() Initialize the Component.
void	setPojo(java.lang.Object pojo)

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

createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getId, getInitFailMessage, getInitOk, getInstanceId, getLogId, getObjectName, getProcessId, getResourceAsString, getRuntimeContext, getSession, inputMissingError, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, 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

equals, 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

PojoComponent

public PojoComponent()

Method Detail

getLogger

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

Specified by:

getLogger in class PentahoBase

done

public void done()

Description copied from interface: IComponent

Allows the component to perform any cleanup after the execution of the action.

Specified by:

done in interface IComponent

Specified by:

done in class ComponentBase

init

public boolean init()

Description copied from interface: IComponent

Initialize the Component. This method is typically called on construction.

Specified by:

init in interface IComponent

Specified by:

init in class ComponentBase

Returns:

returns true if the Component initialized successfully, otherwise returns false

setPojo

public void setPojo(java.lang.Object pojo)