Package org.pentaho.platform.plugin.action.hql

Class HQLBaseComponent

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.hql.HQLBaseComponent
All Implemented Interfaces:
Serializable, org.pentaho.commons.connection.IDisposable, org.pentaho.platform.api.data.IPreparedComponent, org.pentaho.platform.api.engine.IAuditable, org.pentaho.platform.api.engine.IComponent, org.pentaho.platform.api.engine.ILogger, org.pentaho.platform.api.engine.IParameterResolver
Direct Known Subclasses:
HQLDataComponent, HQLLookupRule
public abstract class HQLBaseComponent extends org.pentaho.platform.engine.services.solution.ComponentBase implements org.pentaho.platform.api.data.IPreparedComponent
See Also:

  • 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

    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

  • Constructor Summary

    Constructors
    Constructor
    Description
    HQLBaseComponent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    if the owner, dispose of the connection
    void
    done()
     
    protected boolean
    executeAction()
     
    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.
    protected org.pentaho.commons.connection.IPentahoConnection
    getConnection(File hbmCfgFile, String[] classNames)
     
    abstract org.apache.commons.logging.Log
    getLogger()
     
    abstract String
    getResultOutputName()
     
    org.pentaho.commons.connection.IPentahoResultSet
    getResultSet()
     
    boolean
    init()
     
    protected boolean
    prepareQuery(String rawQuery)
    called when in prepared-component mode, this method populates the preparedQuery string and preparedParameters object.
    protected boolean
    runQuery(org.pentaho.commons.connection.IPentahoConnection conn, String[] classNames, String query)
     
    org.pentaho.commons.connection.IPentahoConnection
    shareConnection()
    return this class's connection.
    protected boolean
    validateAction()
     
    abstract 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.IAuditable

    getId, getObjectName

    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.ILogger

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

  • Constructor Details

    • HQLBaseComponent

      public HQLBaseComponent()

  • Method Details

    • validateSystemSettings

      public abstract boolean validateSystemSettings()
      Specified by:
      validateSystemSettings in class org.pentaho.platform.engine.services.solution.ComponentBase

    • getResultOutputName

      public abstract String getResultOutputName()

    • getLogger

      public abstract org.apache.commons.logging.Log getLogger()
      Specified by:
      getLogger in class org.pentaho.platform.engine.core.system.PentahoBase

    • getResultSet

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

    • validateAction

      protected boolean validateAction()
      Specified by:
      validateAction in class org.pentaho.platform.engine.services.solution.ComponentBase

    • done

      public void done()
      Specified by:
      done in interface org.pentaho.platform.api.engine.IComponent
      Specified by:
      done in class org.pentaho.platform.engine.services.solution.ComponentBase

    • executeAction

      protected boolean executeAction()
      Specified by:
      executeAction in class org.pentaho.platform.engine.services.solution.ComponentBase

    • prepareQuery

      protected boolean prepareQuery(String rawQuery)
      called when in prepared-component mode, this method populates the preparedQuery string and preparedParameters object.
      Parameters:
      rawQuery -
      Returns:

    • 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 org.pentaho.platform.api.data.IPreparedComponent
      Parameters:
      preparedParams - a map of possible parameters.
      Returns:
      result set

    • runQuery

      protected boolean runQuery(org.pentaho.commons.connection.IPentahoConnection conn, String[] classNames, String query)

    • 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 org.pentaho.platform.api.data.IPreparedComponent

    • getConnection

      protected org.pentaho.commons.connection.IPentahoConnection getConnection(File hbmCfgFile, String[] classNames)

    • 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 org.pentaho.platform.api.data.IPreparedComponent
      Returns:
      connection object

    • init

      public boolean init()
      Specified by:
      init in interface org.pentaho.platform.api.engine.IComponent
      Specified by:
      init in class org.pentaho.platform.engine.services.solution.ComponentBase