org.pentaho.reporting.engine.classic.core.function.sys
Class SingleValueQueryFunction

java.lang.Object
  org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      org.pentaho.reporting.engine.classic.core.function.ColumnAggregationExpression
          org.pentaho.reporting.engine.classic.core.function.sys.SingleValueQueryFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ReportListener, Expression, Function

public class SingleValueQueryFunction
extends ColumnAggregationExpression
implements Function

Fires a query against the data-source and returns a single value. The current data-row is used as source for the parameters of the query. The parameters that should be used must be declared as list of fields.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

SingleValueQueryFunction()
Default Constructor.

Method Summary

String	getQuery() Returns the query name.
int	getQueryTimeout()
String	getResultColumn() Returns the name of the result-column.
Object	getValue() Returns the query result.
void	groupFinished(ReportEvent event) Calls the perform-query method.
void	groupStarted(ReportEvent event) Calls the perform-query method.
void	itemsAdvanced(ReportEvent event) Calls the perform-query method.
void	itemsFinished(ReportEvent event) Calls the perform-query method.
void	itemsStarted(ReportEvent event) Calls the perform-query method.
void	reportDone(ReportEvent event) Calls the perform-query method.
void	reportFinished(ReportEvent event) Calls the perform-query method.
void	reportInitialized(ReportEvent event) Calls the perform-query method.
void	reportStarted(ReportEvent event) Calls the perform-query method.
void	setQuery(String query) Defines the query name.
void	setQueryTimeout(int queryTimeout)
void	setResultColumn(String resultColumn) Defines the name of the result-column.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.ColumnAggregationExpression

getField, getField, getFieldCount, getInstance, setField, setField

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

clone, getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression

clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Constructor Detail

SingleValueQueryFunction

public SingleValueQueryFunction()

Default Constructor.

Method Detail

getQueryTimeout

public int getQueryTimeout()

setQueryTimeout

public void setQueryTimeout(int queryTimeout)

getResultColumn

public String getResultColumn()

Returns the name of the result-column. The result-column specified the name of the column of the query's result-table that should be used. If undefined, the first column is used.

Returns:

the result column name.

setResultColumn

public void setResultColumn(String resultColumn)

Defines the name of the result-column. The result-column specified the name of the column of the query's result-table that should be used. If undefined, the first column is used.

Parameters:

resultColumn - the result column name.

getQuery

public String getQuery()

Returns the query name.

Returns:

the query name.

setQuery

public void setQuery(String query)

Defines the query name.

Parameters:

query - the query name.

reportInitialized

public void reportInitialized(ReportEvent event)

Calls the perform-query method.

Specified by:

reportInitialized in interface ReportListener

Parameters:

event - the event.

reportStarted

public void reportStarted(ReportEvent event)

Calls the perform-query method.

Specified by:

reportStarted in interface ReportListener

Parameters:

event - the event.

reportFinished

public void reportFinished(ReportEvent event)

Calls the perform-query method.

Specified by:

reportFinished in interface ReportListener

Parameters:

event - the event.

reportDone

public void reportDone(ReportEvent event)

Calls the perform-query method.

Specified by:

reportDone in interface ReportListener

Parameters:

event - the event.

groupStarted

public void groupStarted(ReportEvent event)

Calls the perform-query method.

Specified by:

groupStarted in interface ReportListener

Parameters:

event - the event.

groupFinished

public void groupFinished(ReportEvent event)

Calls the perform-query method.

Specified by:

groupFinished in interface ReportListener

Parameters:

event - the event.

itemsStarted

public void itemsStarted(ReportEvent event)

Calls the perform-query method.

Specified by:

itemsStarted in interface ReportListener

Parameters:

event - the event.

itemsFinished

public void itemsFinished(ReportEvent event)

Calls the perform-query method.

Specified by:

itemsFinished in interface ReportListener

Parameters:

event - the event.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)

Calls the perform-query method.

Specified by:

itemsAdvanced in interface ReportListener

Parameters:

event - the event.

getValue

public Object getValue()

Returns the query result.

Specified by:

getValue in interface Expression

Returns:

the query result.