org.pentaho.platform.plugin.action.xmla

Class XMLABaseComponent

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.xmla.XMLABaseComponent

All Implemented Interfaces:

Serializable, IDataComponent, IAuditable, IComponent, ILogger, IParameterResolver

Direct Known Subclasses:

XMLADataComponent, XMLALookupRule

public abstract class XMLABaseComponent
extends ComponentBase
implements IDataComponent

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROVIDER_ESSBASE
static int	PROVIDER_MICROSOFT
static int	PROVIDER_MONDRIAN
static int	PROVIDER_SAP

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

Constructor Summary

Constructors

Constructor and Description
XMLABaseComponent()

Method Summary

Modifier and Type	Method and Description
Map	discoverDS() retrieve data source properties
void	dispose()
void	done()
protected boolean	executeAction()
boolean	executeQuery(String query, String catalog) Execute query
abstract org.apache.commons.logging.Log	getLogger()
abstract String	getResultOutputName()
org.pentaho.commons.connection.IPentahoResultSet	getResultSet()
boolean	init()
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.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

Field Detail

PROVIDER_MICROSOFT

public static final int PROVIDER_MICROSOFT

See Also:

Constant Field Values

PROVIDER_SAP

public static final int PROVIDER_SAP

See Also:

Constant Field Values

PROVIDER_MONDRIAN

public static final int PROVIDER_MONDRIAN

See Also:

Constant Field Values

PROVIDER_ESSBASE

public static final int PROVIDER_ESSBASE

See Also:

Constant Field Values

Constructor Detail

XMLABaseComponent

public XMLABaseComponent()

Method Detail

validateSystemSettings

public abstract boolean validateSystemSettings()

Specified by:

validateSystemSettings in class ComponentBase

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()

Specified by:

getResultSet in interface IDataComponent

validateAction

protected boolean validateAction()

Specified by:

validateAction in class ComponentBase

done

public void done()

Specified by:

done in interface IComponent

Specified by:

done in class ComponentBase

executeAction

protected boolean executeAction()

Specified by:

executeAction in class ComponentBase

executeQuery

public boolean executeQuery(String query,
                            String catalog)
                     throws XMLAException

Execute query

Parameters:

query - - MDX to be executed

catalog -

handler - Callback handler

Throws:

XMLAException

discoverDS

public Map discoverDS()
               throws XMLAException

retrieve data source properties

Returns:

Map of key/value strings

Throws:

XMLAException

See Also:

DataSourceBrowser

dispose

public void dispose()

Specified by:

dispose in interface IDataComponent

init

public boolean init()

Specified by:

init in interface IComponent

Specified by:

init in class ComponentBase