org.pentaho.platform.plugin.action.mondrian
Class MondrianModelComponent

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.mondrian.MondrianModelComponent
All Implemented Interfaces:
Serializable, IAuditable, IComponent, ILogger, IParameterResolver

public class MondrianModelComponent
extends ComponentBase

Author:
James Dixon

TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

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.engine.ILogger
ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN
 
Constructor Summary
MondrianModelComponent()
           
 
Method Summary
 void done()
          Allows the component to perform any cleanup after the execution of the action.
 boolean executeAction()
           
static String getInitialQuery(mondrian.olap.Connection connection, String cubeName)
           
static String getInitialQuery(Properties properties, String cubeName, IPentahoSession session)
           
static String getInitialQuery(String modelPath, String connectionString, String cubeName, IPentahoSession session)
          Deprecated.  
static String getInitialQuery(String modelPath, String jndi, String cubeName, String roleName, IPentahoSession session)
          Deprecated.  
static String getInitialQuery(String modelPath, String connectionString, String driver, String user, String password, String cubeName, IPentahoSession session)
          Deprecated.  
static String getInitialQuery(String modelPath, String connectionString, String driver, String user, String password, String cubeName, String roleName, IPentahoSession session)
          Deprecated.  
 org.apache.commons.logging.Log getLogger()
           
 boolean init()
          Initialize the Component.
 boolean validateAction()
           
 
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
getMessages, setMessages
 
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

MondrianModelComponent

public MondrianModelComponent()
Method Detail

getLogger

public org.apache.commons.logging.Log getLogger()
Specified by:
getLogger in class PentahoBase

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

validateAction

public boolean validateAction()

executeAction

public boolean executeAction()

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

getInitialQuery

public static String getInitialQuery(Properties properties,
                                     String cubeName,
                                     IPentahoSession session)
                              throws Throwable
Throws:
Throwable

getInitialQuery

@Deprecated
public static String getInitialQuery(String modelPath,
                                                String connectionString,
                                                String driver,
                                                String user,
                                                String password,
                                                String cubeName,
                                                IPentahoSession session)
                              throws Throwable
Deprecated. 

Parameters:
modelPath -
connectionString -
driver -
user -
password -
cubeName -
Returns:
mdx string that represents the initial query
Throws:
Throwable

getInitialQuery

@Deprecated
public static String getInitialQuery(String modelPath,
                                                String connectionString,
                                                String driver,
                                                String user,
                                                String password,
                                                String cubeName,
                                                String roleName,
                                                IPentahoSession session)
                              throws Throwable
Deprecated. 

Parameters:
modelPath -
connectionString -
driver -
user -
password -
cubeName -
roleName -
Returns:
mdx string that represents the initial query
Throws:
Throwable

getInitialQuery

@Deprecated
public static String getInitialQuery(String modelPath,
                                                String connectionString,
                                                String cubeName,
                                                IPentahoSession session)
                              throws Throwable
Deprecated. 

Parameters:
modelPath -
connectionString -
cubeName -
Returns:
mdx string that represents the initial query
Throws:
Throwable

getInitialQuery

@Deprecated
public static String getInitialQuery(String modelPath,
                                                String jndi,
                                                String cubeName,
                                                String roleName,
                                                IPentahoSession session)
                              throws Throwable
Deprecated. 

Parameters:
modelPath -
jndi -
cubeName -
roleName -
Returns:
mdx string that represents the initial query
Throws:
Throwable

getInitialQuery

public static String getInitialQuery(mondrian.olap.Connection connection,
                                     String cubeName)
                              throws Throwable
Throws:
Throwable