Spec-Zone .ru спецификации, руководства, описания, API

javax.persistence
Запрос интерфейса

Все Известные Подынтерфейсы:

TypedQuery <X>

public interface Query

Интерфейс, используемый, чтобы управлять выполнением запроса.

С тех пор:

Персистентность Java 1.0

См. Также:

TypedQuery, Parameter

Сводка метода

int	executeUpdate() Выполните обновление или оператор удаления.
int	getFirstResult() Позиция первого результата объект запроса была установлена получить.
FlushModeType	getFlushMode() Получите режим сброса в действительности для выполнения запроса.
java.util.Map<java.lang.String,java.lang.Object>	getHints() Получите свойства и подсказки и присваиваемые значения, которые являются в действительности для экземпляра запроса.
LockModeType	getLockMode() Получите текущий режим блокировки для запроса.
int	getMaxResults() Максимальное количество результатов объект запроса было установлено получить.
Parameter<?>	getParameter(int position) Получите соответствие объекта параметра объявленному позиционному параметру с данной позицией.
<T> Parameter<T>	getParameter(int position, java.lang.Class<T> type) Получите соответствие объекта параметра объявленному позиционному параметру с данной позицией и типом.
Parameter<?>	getParameter(java.lang.String name) Получите соответствие объекта параметра объявленному параметру имени.
<T> Parameter<T>	getParameter(java.lang.String name, java.lang.Class<T> type) Получите соответствие объекта параметра объявленному параметру имени и типа.
java.util.Set<Parameter<?>>	getParameters() Получите объекты параметра, соответствующие объявленным параметрам запроса.
java.lang.Object	getParameterValue(int position) Возвратите значение, связанное с позиционным параметром.
<T> T	getParameterValue(Parameter<T> param) Возвратите значение, связанное с параметром.
java.lang.Object	getParameterValue(java.lang.String name) Возвратите значение, связанное с именованным параметром.
java.util.List	getResultList() Выполните Запрос Select и возвратите результаты запроса как невведенный Список.
java.lang.Object	getSingleResult() Выполните Запрос Select, который возвращает единственный невведенный результат.
boolean	isBound(Parameter<?> param) Возвратите булево указание, было ли значение связано с параметром.
Запрос	setFirstResult(int startPosition) Установите позицию первого результата получить.
Запрос	setFlushMode(FlushModeType flushMode) Установите тип режима сброса, который будет использоваться для выполнения запроса.
Запрос	setHint(java.lang.String hintName, java.lang.Object value) Установите свойство запроса или подсказку.
Запрос	setLockMode(LockModeType lockMode) Установите тип режима блокировки, который будет использоваться для выполнения запроса.
Запрос	setMaxResults(int maxResult) Установите максимальное количество результатов получить.
Запрос	setParameter(int position, java.util.Calendar value, TemporalType temporalType) Свяжите экземпляр java.util.Calendar к позиционному параметру.
Запрос	setParameter(int position, java.util.Date value, TemporalType temporalType) Свяжите экземпляр java.util.Date к позиционному параметру.
Запрос	setParameter(int position, java.lang.Object value) Свяжите параметр позиционному параметру.
Запрос	setParameter(Parameter<java.util.Calendar> param, java.util.Calendar value, TemporalType temporalType) Свяжите экземпляр java.util.Calendar к a Parameter объект.
Запрос	setParameter(Parameter<java.util.Date> param, java.util.Date value, TemporalType temporalType) Свяжите экземпляр java.util.Date к a Parameter объект.
<T> Query	setParameter(Parameter<T> param, T value) Свяжите значение a Parameter объект.
Запрос	setParameter(java.lang.String name, java.util.Calendar value, TemporalType temporalType) Свяжите экземпляр java.util.Calendar к именованному параметру.
Запрос	setParameter(java.lang.String name, java.util.Date value, TemporalType temporalType) Свяжите экземпляр java.util.Date к именованному параметру.
Запрос	setParameter(java.lang.String name, java.lang.Object value) Свяжите параметр именованному параметру.
<T> T	unwrap(java.lang.Class<T> cls) Возвратите объект указанного типа предоставить доступ к специфичному для провайдера API.

Деталь метода

getResultList

java.util.List getResultList()

Выполните Запрос Select и возвратите результаты запроса как невведенный Список.

Возвраты:

список результатов

Броски:

IllegalStateException - если требующийся ОБНОВЛЕНИЕ языка запросов Персистентности Java или Оператор удаления

QueryTimeoutException - если выполнение запроса превышает набор значений тайм-аута запроса, и только оператор откатывается

TransactionRequiredException - если режим блокировки был установлен и нет никакой транзакции

PessimisticLockException - если пессимистические сбои блокировки и транзакция откатываются

LockTimeoutException - если пессимистические сбои блокировки и только оператор откатываются

PersistenceException - если выполнение запроса превышает набор значений тайм-аута запроса, и транзакция откатывается

getSingleResult

java.lang.Object getSingleResult()

Выполните Запрос Select, который возвращает единственный невведенный результат.

Возвраты:

результат

Броски:

NoResultException - если нет никакого результата

NonUniqueResultException - если больше чем один результат

IllegalStateException - если требующийся ОБНОВЛЕНИЕ языка запросов Персистентности Java или Оператор удаления

QueryTimeoutException - если выполнение запроса превышает набор значений тайм-аута запроса, и только оператор откатывается

TransactionRequiredException - если режим блокировки был установлен и нет никакой транзакции

PessimisticLockException - если пессимистические сбои блокировки и транзакция откатываются

LockTimeoutException - если пессимистические сбои блокировки и только оператор откатываются

PersistenceException - если выполнение запроса превышает набор значений тайм-аута запроса, и транзакция откатывается

executeUpdate

int executeUpdate()

Выполните обновление или оператор удаления.

Возвраты:

число объектов, обновленных или удаленных

Броски:

IllegalStateException - если требующийся оператор SELECT языка запросов Персистентности Java или для запроса критериев

TransactionRequiredException - если нет никакой транзакции

QueryTimeoutException - если выполнение оператора превышает набор значений тайм-аута запроса, и только оператор откатывается

PersistenceException - если выполнение запроса превышает набор значений тайм-аута запроса, и транзакция откатывается

setMaxResults

Query setMaxResults(int maxResult)

Установите максимальное количество результатов получить.

Параметры:

maxResult - максимальное количество результатов получить

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если параметр отрицателен

getMaxResults

int getMaxResults()

Максимальное количество результатов объект запроса было установлено получить. Возвраты Integer.MAX_VALUE если setMaxResults не был применен к объекту запроса.

Возвраты:

максимальное количество результатов

С тех пор:

Персистентность Java 2.0

setFirstResult

Query setFirstResult(int startPosition)

Установите позицию первого результата получить.

Параметры:

startPosition - позиция первого результата, пронумерованного от 0

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если параметр отрицателен

getFirstResult

int getFirstResult()

Позиция первого результата объект запроса была установлена получить. Возвраты 0, если setFirstResult не был применен к объекту запроса.

Возвраты:

позиция первого результата

С тех пор:

Персистентность Java 2.0

setHint

Query setHint(java.lang.String hintName,
              java.lang.Object value)

Установите свойство запроса или подсказку. Элементы подсказок могут использоваться, чтобы определить свойства запроса и подсказки. Свойства, определенные этой спецификацией, должны наблюдаться провайдером. Специфичные для поставщика подсказки, которые не распознаются провайдером, должны быть тихо проигнорированы. Переносимые приложения не должны положиться на стандартную подсказку тайм-аута. В зависимости от базы данных в использовании и механизмах блокировки, используемых провайдером, эта подсказка может или не может наблюдаться.

Параметры:

hintName - имя свойства или подсказки

value - значение для свойства или подсказки

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если второй параметр не допустим для реализации

getHints

java.util.Map<java.lang.String,java.lang.Object> getHints()

Получите свойства и подсказки и присваиваемые значения, которые являются в действительности для экземпляра запроса.

Возвраты:

свойства запроса и подсказки

С тех пор:

Персистентность Java 2.0

setParameter

<T> Query setParameter(Parameter<T> param,
                       T value)

Свяжите значение a Parameter объект.

Параметры:

param - объект параметра

value - значение параметра

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если параметр не соответствует параметру запроса

С тех пор:

Персистентность Java 2.0

setParameter

Query setParameter(Parameter<java.util.Calendar> param,
                   java.util.Calendar value,
                   TemporalType temporalType)

Свяжите экземпляр java.util.Calendar к a Parameter объект.

Параметры:

param - объект параметра

value - значение параметра

temporalType - временный тип

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если параметр не соответствует параметру запроса

С тех пор:

Персистентность Java 2.0

setParameter

Query setParameter(Parameter<java.util.Date> param,
                   java.util.Date value,
                   TemporalType temporalType)

Свяжите экземпляр java.util.Date к a Parameter объект.

Параметры:

param - объект параметра

value - значение параметра

temporalType - временный тип

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если параметр не соответствует параметру запроса

С тех пор:

Персистентность Java 2.0

setParameter

Query setParameter(java.lang.String name,
                   java.lang.Object value)

Свяжите параметр именованному параметру.

Параметры:

name - название параметра

value - значение параметра

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если название параметра не соответствует параметру запроса или если параметр имеет неправильный тип

setParameter

Query setParameter(java.lang.String name,
                   java.util.Calendar value,
                   TemporalType temporalType)

Свяжите экземпляр java.util.Calendar к именованному параметру.

Параметры:

name - название параметра

value - значение параметра

temporalType - временный тип

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если название параметра не соответствует параметру запроса или если параметр значения имеет неправильный тип

setParameter

Query setParameter(java.lang.String name,
                   java.util.Date value,
                   TemporalType temporalType)

Свяжите экземпляр java.util.Date к именованному параметру.

Параметры:

name - название параметра

value - значение параметра

temporalType - временный тип

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если название параметра не соответствует параметру запроса или если параметр значения имеет неправильный тип

setParameter

Query setParameter(int position,
                   java.lang.Object value)

Свяжите параметр позиционному параметру.

Параметры:

position - позиция

value - значение параметра

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если позиция не соответствует позиционному параметру запроса или если параметр имеет неправильный тип

setParameter

Query setParameter(int position,
                   java.util.Calendar value,
                   TemporalType temporalType)

Свяжите экземпляр java.util.Calendar к позиционному параметру.

Параметры:

position - позиция

value - значение параметра

temporalType - временный тип

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если позиция не соответствует позиционному параметру запроса или если параметр значения имеет неправильный тип

setParameter

Query setParameter(int position,
                   java.util.Date value,
                   TemporalType temporalType)

Свяжите экземпляр java.util.Date к позиционному параметру.

Параметры:

position - позиция

value - значение параметра

temporalType - временный тип

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalArgumentException - если позиция не соответствует позиционному параметру запроса или если параметр значения имеет неправильный тип

getParameters

java.util.Set<Parameter<?>> getParameters()

Получите объекты параметра, соответствующие объявленным параметрам запроса. Пустое множество возвратов, если у запроса нет никаких параметров. Этот метод не обязан поддерживаться для собственных запросов.

Возвраты:

набор объектов параметра

Броски:

IllegalStateException - если вызвано на собственный запрос, когда реализация не поддерживает это использование

С тех пор:

Персистентность Java 2.0

getParameter

Parameter<?> getParameter(java.lang.String name)

Получите соответствие объекта параметра объявленному параметру имени. Этот метод не обязан поддерживаться для собственных запросов.

Параметры:

name - название параметра

Возвраты:

объект параметра

Броски:

IllegalArgumentException - если параметр указанного имени не существует

IllegalStateException - если вызвано на собственный запрос, когда реализация не поддерживает это использование

С тех пор:

Персистентность Java 2.0

getParameter

<T> Parameter<T> getParameter(java.lang.String name,
                              java.lang.Class<T> type)

Получите соответствие объекта параметра объявленному параметру имени и типа. Этот метод обязан поддерживаться для запросов критериев только.

Параметры:

name - название параметра

type - ввести

Возвраты:

объект параметра

Броски:

IllegalArgumentException - если параметр указанного имени не существует или не присваиваем типу

IllegalStateException - если вызвано на собственный запрос или запрос языка запросов Персистентности Java, когда реализация не поддерживает это использование

С тех пор:

Персистентность Java 2.0

getParameter

Parameter<?> getParameter(int position)

Получите соответствие объекта параметра объявленному позиционному параметру с данной позицией. Этот метод не обязан поддерживаться для собственных запросов.

Параметры:

position - позиция

Возвраты:

объект параметра

Броски:

IllegalArgumentException - если параметр с указанной позицией не существует

IllegalStateException - если вызвано на собственный запрос, когда реализация не поддерживает это использование

С тех пор:

Персистентность Java 2.0

getParameter

<T> Parameter<T> getParameter(int position,
                              java.lang.Class<T> type)

Получите соответствие объекта параметра объявленному позиционному параметру с данной позицией и типом. Этот метод не обязан поддерживаться провайдером.

Параметры:

position - позиция

type - ввести

Возвраты:

объект параметра

Броски:

IllegalArgumentException - если параметр с указанной позицией не существует или не присваиваем типу

IllegalStateException - если вызвано на собственный запрос или запрос языка запросов Персистентности Java, когда реализация не поддерживает это использование

С тех пор:

Персистентность Java 2.0

isBound

boolean isBound(Parameter<?> param)

Возвратите булево указание, было ли значение связано с параметром.

Параметры:

param - объект параметра

Возвраты:

булево указание, был ли параметр связан

С тех пор:

Персистентность Java 2.0

getParameterValue

<T> T getParameterValue(Parameter<T> param)

Возвратите значение, связанное с параметром.

Параметры:

param - объект параметра

Возвраты:

значение параметра

Броски:

IllegalArgumentException - если параметр не является параметром запроса

IllegalStateException - если параметр не был связан

С тех пор:

Персистентность Java 2.0

getParameterValue

java.lang.Object getParameterValue(java.lang.String name)

Возвратите значение, связанное с именованным параметром.

Параметры:

name - название параметра

Возвраты:

значение параметра

Броски:

IllegalStateException - если параметр не был связан

IllegalArgumentException - если параметр указанного имени не существует

С тех пор:

Персистентность Java 2.0

getParameterValue

java.lang.Object getParameterValue(int position)

Возвратите значение, связанное с позиционным параметром.

Параметры:

position - позиция

Возвраты:

значение параметра

Броски:

IllegalStateException - если параметр не был связан

IllegalArgumentException - если параметр с указанной позицией не существует

С тех пор:

Персистентность Java 2.0

setFlushMode

Query setFlushMode(FlushModeType flushMode)

Установите тип режима сброса, который будет использоваться для выполнения запроса. Тип режима сброса применяется к запросу независимо от режима сброса, вводят использование для менеджера по объекту.

Параметры:

flushMode - режим сброса

Возвраты:

тот же самый экземпляр запроса

getFlushMode

FlushModeType getFlushMode()

Получите режим сброса в действительности для выполнения запроса. Если режим сброса не был установлен для объекта запроса, возвращает режим сброса в действительности для менеджера по объекту.

Возвраты:

режим сброса

С тех пор:

Персистентность Java 2.0

setLockMode

Query setLockMode(LockModeType lockMode)

Установите тип режима блокировки, который будет использоваться для выполнения запроса.

Параметры:

lockMode - режим блокировки

Возвраты:

тот же самый экземпляр запроса

Броски:

IllegalStateException - если запросом, как находят, не является Запрос Select языка запросов Персистентности Java или запрос API Критериев

С тех пор:

Персистентность Java 2.0

getLockMode

LockModeType getLockMode()

Получите текущий режим блокировки для запроса.

Возвраты:

режим блокировки

Броски:

IllegalStateException - если запросом, как находят, не является Запрос Select языка запросов Персистентности Java или запрос API Критериев

С тех пор:

Персистентность Java 2.0

развернуть

<T> T unwrap(java.lang.Class<T> cls)

Возвратите объект указанного типа предоставить доступ к специфичному для провайдера API. Если реализация запроса провайдера не поддерживает указанный class, PersistenceException бросается.

Параметры:

cls - class объекта, который будет возвращен. Это обычно - или базовая реализация запроса class или интерфейс, который это реализует.

Возвраты:

экземпляр указанного class

Броски:

PersistenceException - если провайдер не поддерживает вызов

С тех пор:

Персистентность Java 2.0