org.pentaho.platform.plugin.action.hql
Class HQLBaseComponent

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.engine.services.solution.ComponentBase
              extended by org.pentaho.platform.plugin.action.hql.HQLBaseComponent
All Implemented Interfaces:
Serializable, org.pentaho.commons.connection.IDisposable, IPreparedComponent, IAuditable, IComponent, ILogger, IParameterResolver
Direct Known Subclasses:
HQLDataComponent, HQLLookupRule

public abstract class HQLBaseComponent
extends ComponentBase
implements IPreparedComponent

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
HQLBaseComponent()
           
 
Method Summary
 void dispose()
          if the owner, dispose of the connection
 void done()
          Allows the component to perform any cleanup after the execution of the action.
 org.pentaho.commons.connection.IPentahoResultSet executePrepared(Map preparedParams)
          executes a prepared method that returns a result set executePrepared looks up any "PREPARELATER" params in the preparedParams map.
abstract  org.apache.commons.logging.Log getLogger()
           
abstract  String getResultOutputName()
           
 org.pentaho.commons.connection.IPentahoResultSet getResultSet()
           
 boolean init()
          Initialize the Component.
 org.pentaho.commons.connection.IPentahoConnection shareConnection()
          return this class's 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

HQLBaseComponent

public HQLBaseComponent()
Method Detail

validateSystemSettings

public abstract boolean validateSystemSettings()

getResultOutputName

public abstract String getResultOutputName()

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

executePrepared

public org.pentaho.commons.connection.IPentahoResultSet executePrepared(Map preparedParams)
executes a prepared method that returns a result set executePrepared looks up any "PREPARELATER" params in the preparedParams map.

Specified by:
executePrepared in interface IPreparedComponent
Parameters:
preparedParams - a map of possible parameters.
Returns:
result set

dispose

public void dispose()
if the owner, dispose of the connection

Specified by:
dispose in interface org.pentaho.commons.connection.IDisposable
Specified by:
dispose in interface IPreparedComponent

shareConnection

public org.pentaho.commons.connection.IPentahoConnection shareConnection()
return this class's connection. This implements the IPreparedComponent interface, which may share its connection with others.

Specified by:
shareConnection in interface IPreparedComponent
Returns:
connection object

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