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

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

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

XMLABaseComponent()

Method Summary

Map	discoverDS() retrieve data source properties
void	dispose() Disposes of resources held by the data component
void	done() Allows the component to perform any cleanup after the execution of the action.
boolean	executeQuery(String query, String catalog) Execute query
abstract Log	getLogger()
abstract String	getResultOutputName()
IPentahoResultSet	getResultSet()
boolean	init() Initialize the Component.
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, 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

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

getResultOutputName

public abstract String getResultOutputName()

getLogger

public abstract Log getLogger()

Specified by:

getLogger in class PentahoBase

getResultSet

public IPentahoResultSet getResultSet()

Specified by:

getResultSet in interface IDataComponent

Returns:

Returns the resultSet that the component currently has.

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

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

Description copied from interface: IDataComponent

Disposes of resources held by the data component

Specified by:

dispose in interface IDataComponent

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