SingleValueQueryFunction (classic-core 9.3.0.0-424 API)

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, Expression
```
public class SingleValueQueryFunction
extends ColumnAggregationExpression
```
Deprecated.
use the formula expression with the same name instead.

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

Constructors
Constructor Description

SingleValueQueryFunction()
Deprecated.

Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getQuery()`	Deprecated. Returns the query name.
`int`	`getQueryTimeout()`	Deprecated.
`String`	`getResultColumn()`	Deprecated. Returns the name of the result-column.
`Object`	`getValue()`	Deprecated. Returns the query result.
`void`	`setQuery(String query)`	Deprecated. Defines the query name.
`void`	`setQueryTimeout(int queryTimeout)`	Deprecated.
`void`	`setResultColumn(String resultColumn)`	Deprecated. Defines the name of the result-column.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.ColumnAggregationExpression
getField, getField, getFieldCount, getFieldValues, 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SingleValueQueryFunction
```
public SingleValueQueryFunction()
```
    Deprecated.
    
    Default Constructor.
- Method Detail
  - getQueryTimeout
```
public int getQueryTimeout()
```
    Deprecated.
  - setQueryTimeout
```
public void setQueryTimeout(int queryTimeout)
```
    Deprecated.
  - getResultColumn
```
public String getResultColumn()
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    Returns the query name.
    
    Returns:
    
    the query name.
  - setQuery
```
public void setQuery(String query)
```
    Deprecated.
    
    Defines the query name.
    
    Parameters:
    
    query - the query name.
  - getValue
```
public Object getValue()
```
    Deprecated.
    
    Returns the query result.
    
    Returns:
    
    the query result.