Top Description Fields Constructors Methods
org.eclipse.persistence.queries

public Class DirectReadQuery

extends DataReadQuery
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.queries.ValueReadQuery
Imports
org.eclipse.persistence.mappings.converters.Converter

Purpose: Concrete class to perform a direct read.

Responsibilities: Used in conjunction with DirectCollectionMapping. This can be used to read a single column of data (i.e. one field). A container (implementing Collection) of the data values is returned.

Author
Yvon Lavoie
Since
TOPLink/Java 1.0

Field Summary

Modifier and TypeField and Description
protected Converter
valueConverter

Allows user defined conversion between the result value and the database value.

Inherited from org.eclipse.persistence.queries.DataReadQuery:
ARRAYATTRIBUTEAUTOcontainerPolicyMAPresultTypeVALUE

Constructor Summary

AccessConstructor and Description
public
DirectReadQuery()

PUBLIC: Initialize the state of the query.

public
DirectReadQuery(String sqlString)

PUBLIC: Initialize the query to use the specified SQL string.

public
DirectReadQuery(Call call)

PUBLIC: Initialize the query to use the specified call.

Method Summary

Modifier and TypeMethod and Description
public Converter
getValueConverter()

Overrides org.eclipse.persistence.queries.DataReadQuery.getValueConverter.

PUBLIC: Return the converter on the query.
public boolean
isDirectReadQuery()

Overrides org.eclipse.persistence.queries.DatabaseQuery.isDirectReadQuery.

PUBLIC: Return if this is a direct read query.
public void
setValueConverter(Converter valueConverter)

PUBLIC: Set the converter on the query.

Inherited from org.eclipse.persistence.queries.DataReadQuery:
buildObjectcacheResultcloneexecuteexecuteDatabaseQueryexecuteNonCursorgetContainerPolicygetResultTypeisDataReadQueryprepareprepareForExecutionremoteExecutesetContainerPolicysetResultTypesetResultTypeuseCollectionClassuseCursoredStreamuseCursoredStreamuseCursoredStreamuseScrollableCursoruseScrollableCursoruseScrollableCursor

Field Detail

valueConverterback to summary
protected Converter valueConverter

Allows user defined conversion between the result value and the database value.

Constructor Detail

DirectReadQueryback to summary
public DirectReadQuery()

PUBLIC: Initialize the state of the query.

DirectReadQueryback to summary
public DirectReadQuery(String sqlString)

PUBLIC: Initialize the query to use the specified SQL string.

Warning

Allowing an unverified SQL string to be passed into this method makes your application vulnerable to SQL injection attacks.

DirectReadQueryback to summary
public DirectReadQuery(Call call)

PUBLIC: Initialize the query to use the specified call.

Method Detail

getValueConverterback to summary
public Converter getValueConverter()

Overrides org.eclipse.persistence.queries.DataReadQuery.getValueConverter.

PUBLIC: Return the converter on the query. A converter can be used to convert between the result value and database value.

Annotations
@Override
isDirectReadQueryback to summary
public boolean isDirectReadQuery()

Overrides org.eclipse.persistence.queries.DatabaseQuery.isDirectReadQuery.

PUBLIC: Return if this is a direct read query.

Annotations
@Override
setValueConverterback to summary
public void setValueConverter(Converter valueConverter)

PUBLIC: Set the converter on the query. A converter can be used to convert between the result value and database value.