sf.qof.parser
Interface ResultDefinition

All Superinterfaces:

Definition

All Known Implementing Classes:

ResultDefinitionImpl

public interface ResultDefinition
extends Definition

Specification of a result definition.

Method Summary

String[]	getColumns() Returns an array of SQL column names.
int	getConstructorParameter() Returns the index of a parameter in a constructor.
String	getField() Returns the name a field if the result is a Java bean.
int[]	getIndexes() Returns an array of SQL column indexes.
boolean	isMapKey() Returns true if the result definition is for the key if the result is a map.

Methods inherited from interface sf.qof.parser.Definition

getPartialDefinitionGroup, getPartialDefinitionPart, getType, isPartialDefinition

Method Detail

getColumns

String[] getColumns()

Returns an array of SQL column names. Can be empty.

Returns:

array of SQL column names

getField

String getField()

Returns the name a field if the result is a Java bean.

Returns:

name of a field in a Java bean result.

getConstructorParameter

int getConstructorParameter()

Returns the index of a parameter in a constructor.

Returns:

parameter index in the constructor

getIndexes

int[] getIndexes()

Returns an array of SQL column indexes. Can be empty.

Returns:

array of SQL column indexes

isMapKey

boolean isMapKey()

Returns true if the result definition is for the key if the result is a map.

Returns:

map key