org.pentaho.platform.plugin.action.pentahometadata

Class MetadataQueryComponent

java.lang.Object

org.pentaho.platform.plugin.action.pentahometadata.MetadataQueryComponent

public class MetadataQueryComponent
extends Object

This is the BI Platform Pojo Component for Pentaho Metadata Queries. It currently supports executing the inline etl and sql physical models. TODO: We should eventually move the copy and pasted code that executes the SQL into a pojo SQL Component.

Author:

Will Gorman

Constructor Summary

Constructors

Constructor and Description
MetadataQueryComponent()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute()
org.pentaho.commons.connection.IPentahoResultSet	getResultSet()
void	setInputs(Map<String,Object> inputs)
void	setLive(boolean live)
void	setLogSql(boolean logSql)
void	setMaxRows(Integer maxRows)
void	setQuery(String query)
void	setQueryModelXmlHelper(String xmlHelperClass)
void	setQueryObject(org.pentaho.metadata.query.model.Query queryObject) Sets the query to be executed.
void	setReadOnly(Boolean readOnly) This sets the read only property in the Pentaho SQLConnection API
void	setTimeout(Integer timeout)
void	setUseForwardOnlyResultSet(boolean useForwardOnlyResultSet)
boolean	validate()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataQueryComponent

public MetadataQueryComponent()

Method Detail

setInputs

public void setInputs(Map<String,Object> inputs)

setLogSql

public void setLogSql(boolean logSql)

setQuery

public void setQuery(String query)

setQueryObject

public void setQueryObject(org.pentaho.metadata.query.model.Query queryObject)

Sets the query to be executed. This is a query model that will be executed in preference to a string-based query.

Parameters:

queryObject -

setMaxRows

public void setMaxRows(Integer maxRows)

setTimeout

public void setTimeout(Integer timeout)

setLive

public void setLive(boolean live)

setReadOnly

public void setReadOnly(Boolean readOnly)

This sets the read only property in the Pentaho SQLConnection API

Parameters:

readOnly - true if read only

setUseForwardOnlyResultSet

public void setUseForwardOnlyResultSet(boolean useForwardOnlyResultSet)

setQueryModelXmlHelper

public void setQueryModelXmlHelper(String xmlHelperClass)

execute

public boolean execute()

validate

public boolean validate()

getResultSet

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