org.pentaho.platform.plugin.action.xml.xquery
Class XQueryBaseComponent

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.xml.xquery.XQueryBaseComponent

All Implemented Interfaces:

Serializable, org.pentaho.commons.connection.IDisposable, IPreparedComponent, IAuditable, IComponent, ILogger, IParameterResolver

Direct Known Subclasses:

XQueryLookupRule

public abstract class XQueryBaseComponent
extends ComponentBase
implements IPreparedComponent

XQueryBaseComponent provides a mechanism to run xqueries within the Pentaho BI Platform. TODO: In regards to IPreparedComponent, implement a method for choosing the datasource on the fly

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.data.IPreparedComponent

PREPARE_LATER_INTER_PREFIX, PREPARE_LATER_PLACEHOLDER, PREPARE_LATER_PREFIX, PREPARED_COMPONENT_NAME, PREPARED_OUTPUT_TYPE

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

XQueryBaseComponent()

Method Summary

void	dispose() disposes of the connection this is called by the runtime context if the object is used as an iprepared component
void	done() Allows the component to perform any cleanup after the execution of the action.
org.pentaho.commons.connection.IPentahoResultSet	executePrepared(Map preparedParams) implements the IPreparedComponent executePrepared, which allows other components to execute the prepared statement.
abstract org.apache.commons.logging.Log	getLogger()
int	getMaxRows()
org.pentaho.commons.connection.IPentahoResultSet	getResultSet()
boolean	init() Initialize the Component.
void	setMaxRows(int value)
org.pentaho.commons.connection.IPentahoConnection	shareConnection() implements IPreparedComponents shareConnection, allowing other xquery components to access the connection
abstract boolean	validateSystemSettings()

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

execute, getActionDefinition, getActionName, getComponentDefinition, getInstanceId, getMessages, getProcessId, getRuntimeContext, getSession, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, setMessages, setProcessId, setRuntimeContext, setSession, validate

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

getId, getObjectName

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

XQueryBaseComponent

public XQueryBaseComponent()

Method Detail

validateSystemSettings

public abstract boolean validateSystemSettings()

getLogger

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

Specified by:

getLogger in class PentahoBase

getResultSet

public org.pentaho.commons.connection.IPentahoResultSet getResultSet()

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

shareConnection

public org.pentaho.commons.connection.IPentahoConnection shareConnection()

implements IPreparedComponents shareConnection, allowing other xquery components to access the connection

Specified by:

shareConnection in interface IPreparedComponent

Returns:

shared connection

executePrepared

public org.pentaho.commons.connection.IPentahoResultSet executePrepared(Map preparedParams)

implements the IPreparedComponent executePrepared, which allows other components to execute the prepared statement.

Specified by:

executePrepared in interface IPreparedComponent

Parameters:

preparedParams - lookup for prepared parameters

Returns:

pentaho result set

getMaxRows

public int getMaxRows()

setMaxRows

public void setMaxRows(int value)

dispose

public void dispose()

disposes of the connection this is called by the runtime context if the object is used as an iprepared component

Specified by:

dispose in interface org.pentaho.commons.connection.IDisposable

Specified by:

dispose in interface IPreparedComponent