Class MDXBaseComponent
- 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.mdx.MDXBaseComponent
-
- All Implemented Interfaces:
Serializable
,org.pentaho.commons.connection.IDisposable
,org.pentaho.platform.api.data.IDataComponent
,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:
MDXDataComponent
,MDXLookupRule
public abstract class MDXBaseComponent extends org.pentaho.platform.engine.services.solution.ComponentBase implements org.pentaho.platform.api.data.IDataComponent, org.pentaho.platform.api.data.IPreparedComponent
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
FORMATTED_CELL_VALUES
-
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
-
-
Constructor Summary
Constructors Constructor Description MDXBaseComponent()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected String
applyInputsToFormat(String format)
void
dispose()
if the owner, dispose of the connectionvoid
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()
protected org.pentaho.commons.connection.IPentahoConnection
getConnectionOrig()
org.pentaho.commons.connection.IPentahoConnection
getDatasourceConnection()
attempt to aquire a connection.abstract org.apache.commons.logging.Log
getLogger()
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 localConnection, String rawQuery)
protected void
setConnection(org.pentaho.commons.connection.IPentahoConnection connection)
protected void
setOutputValue(String outputName, Object value)
org.pentaho.commons.connection.IPentahoConnection
shareConnection()
return this class's connection.protected boolean
validateAction()
abstract boolean
validateSystemSettings()
protected void
waitFor(int millis)
-
Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase
addTempParameter, addTempParameterObject, 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, 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
execute, getActionDefinition, getActionName, getComponentDefinition, getInstanceId, getMessages, getProcessId, getRuntimeContext, getSession, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, setMessages, setProcessId, setRuntimeContext, setSession, validate
-
-
-
-
Field Detail
-
FORMATTED_CELL_VALUES
public static final String FORMATTED_CELL_VALUES
- See Also:
- Constant Field Values
-
-
Method Detail
-
validateSystemSettings
public abstract boolean validateSystemSettings()
- Specified by:
validateSystemSettings
in classorg.pentaho.platform.engine.services.solution.ComponentBase
-
getLogger
public abstract org.apache.commons.logging.Log getLogger()
- Specified by:
getLogger
in classorg.pentaho.platform.engine.core.system.PentahoBase
-
getResultSet
public org.pentaho.commons.connection.IPentahoResultSet getResultSet()
- Specified by:
getResultSet
in interfaceorg.pentaho.platform.api.data.IDataComponent
-
validateAction
protected boolean validateAction()
- Specified by:
validateAction
in classorg.pentaho.platform.engine.services.solution.ComponentBase
-
done
public void done()
- Specified by:
done
in interfaceorg.pentaho.platform.api.engine.IComponent
- Specified by:
done
in classorg.pentaho.platform.engine.services.solution.ComponentBase
-
executeAction
protected boolean executeAction()
- Specified by:
executeAction
in classorg.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:
-
dispose
public void dispose()
if the owner, dispose of the connection- Specified by:
dispose
in interfaceorg.pentaho.platform.api.data.IDataComponent
- Specified by:
dispose
in interfaceorg.pentaho.commons.connection.IDisposable
- Specified by:
dispose
in interfaceorg.pentaho.platform.api.data.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 interfaceorg.pentaho.platform.api.data.IPreparedComponent
- Returns:
- connection object
-
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 interfaceorg.pentaho.platform.api.data.IPreparedComponent
- Parameters:
preparedParams
- a map of possible parameters.- Returns:
- result set
-
runQuery
protected boolean runQuery(org.pentaho.commons.connection.IPentahoConnection localConnection, String rawQuery)
-
getDatasourceConnection
public org.pentaho.commons.connection.IPentahoConnection getDatasourceConnection()
attempt to aquire a connection. if connection isn't available, wait a certain period of time before trying again.- Returns:
- connection
-
waitFor
protected void waitFor(int millis)
-
getConnection
protected org.pentaho.commons.connection.IPentahoConnection getConnection()
-
getConnectionOrig
protected org.pentaho.commons.connection.IPentahoConnection getConnectionOrig()
-
init
public boolean init()
- Specified by:
init
in interfaceorg.pentaho.platform.api.engine.IComponent
- Specified by:
init
in classorg.pentaho.platform.engine.services.solution.ComponentBase
-
setOutputValue
protected void setOutputValue(String outputName, Object value)
- Overrides:
setOutputValue
in classorg.pentaho.platform.engine.services.solution.ComponentBase
-
setConnection
protected void setConnection(org.pentaho.commons.connection.IPentahoConnection connection)
-
-