org.eclipse.persistence.config

Class ResultType

java.lang.Object

org.eclipse.persistence.config.ResultType

public class ResultType
extends Object

Result type hint values. The class contains all the valid values for QueryHints.RESULT_TYPE query hint. By default in JPA for non-single select queries an Array of values is returned. If getSingleResult() is called the first array is returned, for getResultList() a List of arrays is returned.

i.e. "Select e.firstName, e.lastName from Employee e" returns List

or the native query, "SELECT * FROM EMPLOYEE" returns List

The ResultType can be used to instead return a Map of values (DatabaseRecord, ReportQueryResult).

It can also be used to return a single column, or single value. JPA Query Hint Usage:

query.setHint(QueryHints.RESULT_TYPE, ResultType.Map);

or

@QueryHint(name=QueryHints.RESULT_TYPE, value=ResultType.Map)

Hint values are case-insensitive. "" could be used instead of default value ResultType.Array.

Author:

James Sutherland

See Also:

QueryHints.RESULT_TYPE, Record, DatabaseRecord, ReportQueryResult, ReportQuery.setReturnType(int), org.eclipse.persistence.queries.DataReadQuery#setUseAbstractRecord(boolean)

Field Summary

Fields

Modifier and Type	Field and Description
static String	Array An Object array of values is returned (List or Object[]).
static String	Attribute A List of the first selected value is returned.
static String	DEFAULT The default type is Array.
static String	Map A Map of key value pairs is returned.
static String	Value The first value of the first rows is returned.

Constructor Summary

Constructors

Constructor and Description
ResultType()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

Array

public static final String Array

An Object array of values is returned (List or Object[]).

See Also:

Constant Field Values

Map

public static final String Map

A Map of key value pairs is returned. For a native queries the keys are the column names, (List, or DatabaseRecord). For JPQL queries the keys are the attribute names, (List, or ReportQueryResult).

See Also:

Constant Field Values

Attribute

public static final String Attribute

A List of the first selected value is returned.

See Also:

Constant Field Values

Value

public static final String Value

The first value of the first rows is returned.

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

The default type is Array.

See Also:

Constant Field Values

Constructor Detail

ResultType

public ResultType()