Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
public interface EntityManager
Интерфейс, используемый, чтобы взаимодействовать с контекстом персистентности.
EntityManager
экземпляр связывается с контекстом персистентности. Контекст персистентности является рядом экземпляров объекта в который для любых персистентных идентификационных данных объекта есть уникальный экземпляр объекта. В пределах контекста персистентности управляют экземплярами объекта и их жизненным циклом. EntityManager
API используется, чтобы создать и удалить персистентные экземпляры объекта, найти объекты их первичным ключом, и запросить по объектам.
Набор объектов, которыми можно управлять данным EntityManager
экземпляр определяется модулем персистентности. Модуль персистентности определяет набор всех классов, которые связываются или группируются приложением, и которые должны быть colocated в их отображении на единственную базу данных.
Query
, TypedQuery
, CriteriaQuery
, PersistenceContext
Сводка метода | ||
---|---|---|
void |
clear()
Очистите контекст персистентности, заставляя все управляемые объекты стать отсоединенными. |
|
void |
close()
Закройте управляемого приложением менеджера по объекту. |
|
boolean |
contains(java.lang.Object entity)
Проверьте, является ли экземпляр управляемым экземпляром объекта, принадлежащим текущему контексту персистентности. |
|
Запрос |
createNamedQuery(java.lang.String name)
Создайте экземпляр Query для того, чтобы выполнить именованный запрос (в языке запросов Персистентности Java или в собственном SQL). |
|
|
createNamedQuery(java.lang.String name, java.lang.Class<T> resultClass)
Создайте экземпляр TypedQuery для того, чтобы выполнить язык запросов Персистентности Java, названный запросом. |
|
Запрос |
createNativeQuery(java.lang.String sqlString)
Создайте экземпляр Query для того, чтобы выполнить собственный SQL-оператор, например, для обновления или удаляют. |
|
Запрос |
createNativeQuery(java.lang.String sqlString, java.lang.Class resultClass)
Создайте экземпляр Query для того, чтобы выполнить собственный SQL-запрос. |
|
Запрос |
createNativeQuery(java.lang.String sqlString, java.lang.String resultSetMapping)
Создайте экземпляр Query для того, чтобы выполнить собственный SQL-запрос. |
|
|
createQuery(CriteriaQuery<T> criteriaQuery)
Создайте экземпляр TypedQuery для того, чтобы выполнить запрос критериев. |
|
Запрос |
createQuery(java.lang.String qlString)
Создайте экземпляр Query для того, чтобы выполнить оператор языка запросов Персистентности Java. |
|
|
createQuery(java.lang.String qlString, java.lang.Class<T> resultClass)
Создайте экземпляр TypedQuery для того, чтобы выполнить оператор языка запросов Персистентности Java. |
|
void |
detach(java.lang.Object entity)
Удалите данный объект из контекста персистентности, заставляя управляемый объект стать отсоединенными. |
|
|
find(java.lang.Class<T> entityClass, java.lang.Object primaryKey)
Найдите первичным ключом. |
|
|
find(java.lang.Class<T> entityClass, java.lang.Object primaryKey, LockModeType lockMode)
Найдите первичным ключом и блокировкой. |
|
|
find(java.lang.Class<T> entityClass, java.lang.Object primaryKey, LockModeType lockMode, java.util.Map<java.lang.String,java.lang.Object> properties)
Найдите первичным ключом и блокировкой, используя указанные свойства. |
|
|
find(java.lang.Class<T> entityClass, java.lang.Object primaryKey, java.util.Map<java.lang.String,java.lang.Object> properties)
Найдите первичным ключом, используя указанные свойства. |
|
void |
flush()
Синхронизируйте контекст персистентности с базовой базой данных. |
|
CriteriaBuilder |
getCriteriaBuilder()
Возвратите экземпляр CriteriaBuilder для создания CriteriaQuery объекты. |
|
java.lang.Object |
getDelegate()
Возвратите базовый объект провайдера для EntityManager , при наличии. |
|
EntityManagerFactory |
getEntityManagerFactory()
Возвратите менеджера по объекту фабрика для менеджера по объекту. |
|
FlushModeType |
getFlushMode()
Получите режим сброса, который применяется ко всем объектам, содержавшимся в контексте персистентности. |
|
LockModeType |
getLockMode(java.lang.Object entity)
Получите текущий режим блокировки для экземпляра объекта. |
|
Метамодель |
getMetamodel()
Возвратите экземпляр Metamodel интерфейс для доступа к метамодели модуля персистентности. |
|
java.util.Map<java.lang.String,java.lang.Object> |
getProperties()
Получите свойства и подсказки и присваиваемые значения, которые являются в действительности для менеджера по объекту. |
|
|
getReference(java.lang.Class<T> entityClass, java.lang.Object primaryKey)
Получите экземпляр, состояние которого может быть лениво выбрано. |
|
EntityTransaction |
getTransaction()
Возвратите на уровне ресурса EntityTransaction объект. |
|
boolean |
isOpen()
Определите, открыт ли менеджер по объекту. |
|
void |
joinTransaction()
Укажите менеджеру по объекту, что транзакция JTA является активной. |
|
void |
lock(java.lang.Object entity, LockModeType lockMode)
Заблокируйте экземпляр объекта, который содержится в контексте персистентности с указанным типом режима блокировки. |
|
void |
lock(java.lang.Object entity, LockModeType lockMode, java.util.Map<java.lang.String,java.lang.Object> properties)
Заблокируйте экземпляр объекта, который содержится в контексте персистентности с указанным типом режима блокировки и с указанными свойствами. |
|
|
merge(T entity)
Объедините состояние данного объекта в текущий контекст персистентности. |
|
void |
persist(java.lang.Object entity)
Сделайте экземпляр управляемым и персистентным. |
|
void |
refresh(java.lang.Object entity)
Обновите состояние экземпляра от базы данных, перезаписывая изменения, произведенные в объекте, если любой. |
|
void |
refresh(java.lang.Object entity, LockModeType lockMode)
Обновите состояние экземпляра от базы данных, перезаписывая изменения, произведенные в объекте, если таковые вообще имеются, и заблокируйте это относительно данного типа режима блокировки. |
|
void |
refresh(java.lang.Object entity, LockModeType lockMode, java.util.Map<java.lang.String,java.lang.Object> properties)
Обновите состояние экземпляра от базы данных, перезаписывая изменения, произведенные в объекте, если таковые вообще имеются, и заблокируйте это относительно данного типа режима блокировки и с указанными свойствами. |
|
void |
refresh(java.lang.Object entity, java.util.Map<java.lang.String,java.lang.Object> properties)
Обновите состояние экземпляра от базы данных, используя указанные свойства, и перезаписывая изменения, произведенные в объекте, если любой. |
|
void |
remove(java.lang.Object entity)
Удалите экземпляр объекта. |
|
void |
setFlushMode(FlushModeType flushMode)
Установите режим сброса, который применяется ко всем объектам, содержавшимся в контексте персистентности. |
|
void |
setProperty(java.lang.String propertyName, java.lang.Object value)
Установите менеджера по объекту свойство или подсказка. |
|
|
unwrap(java.lang.Class<T> cls)
Возвратите объект указанного типа предоставить доступ к специфичному для провайдера API. |
Деталь метода |
---|
void persist(java.lang.Object entity)
entity
- экземпляр объекта EntityExistsException
- если объект уже существует. (Если объект уже существует, EntityExistsException
может быть брошен, когда сохранять работа вызывается, или EntityExistsException
или другой PersistenceException
может быть брошен во время фиксации или сбросе.) IllegalArgumentException
- если экземпляр не является объектом TransactionRequiredException
- если вызвано на управляемого контейнером менеджера по объекту типа PersistenceContextType.TRANSACTION
и нет никакой транзакции<T> T merge(T entity)
entity
- экземпляр объекта IllegalArgumentException
- если экземпляр не является объектом или является удаленным объектом TransactionRequiredException
- если вызвано на управляемого контейнером менеджера по объекту типа PersistenceContextType.TRANSACTION
и нет никакой транзакцииvoid remove(java.lang.Object entity)
entity
- экземпляр объекта IllegalArgumentException
- если экземпляр не является объектом или является отсоединенным объектом TransactionRequiredException
- если вызвано на управляемого контейнером менеджера по объекту типа PersistenceContextType.TRANSACTION
и нет никакой транзакции<T> T find(java.lang.Class<T> entityClass, java.lang.Object primaryKey)
entityClass
- объект classprimaryKey
- первичный ключ IllegalArgumentException
- если первый параметр не обозначает тип объекта, или второй параметр, не допустимый тип для этого entitys первичный ключ или нуль<T> T find(java.lang.Class<T> entityClass, java.lang.Object primaryKey, java.util.Map<java.lang.String,java.lang.Object> properties)
entityClass
- объект classprimaryKey
- первичный ключproperties
- стандартные и специфичные для поставщика свойства и подсказки IllegalArgumentException
- если первый параметр не обозначает тип объекта, или второй параметр, не допустимый тип для этого entitys первичный ключ или нуль<T> T find(java.lang.Class<T> entityClass, java.lang.Object primaryKey, LockModeType lockMode)
Если объект находится в пределах контекста персистентности, и тип режима блокировки пессимистичен, и у объекта есть атрибут версии, провайдер персистентности должен выполнить оптимистические проверки версии, получая блокировку базы данных. Если эти проверки перестали работать, OptimisticLockException
будет брошен.
Если тип режима блокировки пессимистичен, и экземпляр объекта находится, но не может быть заблокирован:
PessimisticLockException
будет брошен, если база данных, блокирующая отказ, вызовет откат на уровне транзакции LockTimeoutException
будет брошен, если база данных, блокирующая отказ, вызовет только откат на уровне оператора
entityClass
- объект classprimaryKey
- первичный ключlockMode
- режим блокировки IllegalArgumentException
- если первый параметр не обозначает тип объекта, или второй параметр не является допустимым типом для первичного ключа того объекта или является нулем TransactionRequiredException
- если нет никакой транзакции, и режим блокировки ни кроме ОДНОГО не определяется OptimisticLockException
- если оптимистическая проверка версии перестала работать PessimisticLockException
- если пессимистические сбои блокировки и транзакция откатываются LockTimeoutException
- если пессимистические сбои блокировки и только оператор откатываются PersistenceException
- если неподдерживаемый вызов блокировки выполняется<T> T find(java.lang.Class<T> entityClass, java.lang.Object primaryKey, LockModeType lockMode, java.util.Map<java.lang.String,java.lang.Object> properties)
Если объект находится в пределах контекста персистентности, и тип режима блокировки пессимистичен, и у объекта есть атрибут версии, провайдер персистентности должен выполнить оптимистические проверки версии, получая блокировку базы данных. Если эти проверки перестали работать, OptimisticLockException
будет брошен.
Если тип режима блокировки пессимистичен, и экземпляр объекта находится, но не может быть заблокирован:
PessimisticLockException
будет брошен, если база данных, блокирующая отказ, вызовет откат на уровне транзакции LockTimeoutException
будет брошен, если база данных, блокирующая отказ, вызовет только откат на уровне оператора Если специфичное для поставщика свойство или подсказка не распознаются, это тихо игнорируется.
Переносимые приложения не должны положиться на стандартную подсказку тайм-аута. В зависимости от базы данных в использовании и механизмах блокировки, используемых провайдером, подсказка может или не может наблюдаться.
entityClass
- объект classprimaryKey
- первичный ключlockMode
- режим блокировкиproperties
- стандартные и специфичные для поставщика свойства и подсказки IllegalArgumentException
- если первый параметр не обозначает тип объекта, или второй параметр не является допустимым типом для первичного ключа того объекта или является нулем TransactionRequiredException
- если нет никакой транзакции и режима блокировки кроме NONE
определяется OptimisticLockException
- если оптимистическая проверка версии перестала работать PessimisticLockException
- если пессимистические сбои блокировки и транзакция откатываются LockTimeoutException
- если пессимистические сбои блокировки и только оператор откатываются PersistenceException
- если неподдерживаемый вызов блокировки выполняется<T> T getReference(java.lang.Class<T> entityClass, java.lang.Object primaryKey)
EntityNotFoundException
бросается, когда к состоянию экземпляра сначала получают доступ. (Времени выполнения провайдера персистентности разрешают бросить EntityNotFoundException
когда getReference
вызывается.) Приложение не должно ожидать, что состояние экземпляра будет доступно после отсоединения, если к этому не получило доступ приложение, в то время как менеджер по объекту был открыт.
entityClass
- объект classprimaryKey
- первичный ключ IllegalArgumentException
- если первый параметр не обозначает тип объекта, или второй параметр не является допустимым типом для этого entitys первичный ключ или является нулем EntityNotFoundException
- если к состоянию объекта нельзя получить доступvoid flush()
TransactionRequiredException
- если нет никакой транзакции PersistenceException
- если сброс перестал работатьvoid setFlushMode(FlushModeType flushMode)
flushMode
- режим сбросаFlushModeType getFlushMode()
void lock(java.lang.Object entity, LockModeType lockMode)
Если пессимистический тип режима блокировки определяется, и объект содержит атрибут версии, провайдер персистентности должен также выполнить оптимистические проверки версии, получая блокировку базы данных. Если эти проверки перестали работать, OptimisticLockException
будет брошен.
Если тип режима блокировки пессимистичен, и экземпляр объекта находится, но не может быть заблокирован:
PessimisticLockException
будет брошен, если база данных, блокирующая отказ, вызовет откат на уровне транзакции LockTimeoutException
будет брошен, если база данных, блокирующая отказ, вызовет только откат на уровне оператора
entity
- экземпляр объектаlockMode
- режим блокировки IllegalArgumentException
- если экземпляр не является объектом или является отсоединенным объектом TransactionRequiredException
- если нет никакой транзакции EntityNotFoundException
- если объект не существует в базе данных, когда пессимистическая блокировка выполняется OptimisticLockException
- если оптимистическая проверка версии перестала работать PessimisticLockException
- если пессимистические сбои блокировки и транзакция откатываются LockTimeoutException
- если пессимистические сбои блокировки и только оператор откатываются PersistenceException
- если неподдерживаемый вызов блокировки выполняетсяvoid lock(java.lang.Object entity, LockModeType lockMode, java.util.Map<java.lang.String,java.lang.Object> properties)
Если пессимистический тип режима блокировки определяется, и объект содержит атрибут версии, провайдер персистентности должен также выполнить оптимистические проверки версии, получая блокировку базы данных. Если эти проверки перестали работать, OptimisticLockException
будет брошен.
Если тип режима блокировки пессимистичен, и экземпляр объекта находится, но не может быть заблокирован:
PessimisticLockException
будет брошен, если база данных, блокирующая отказ, вызовет откат на уровне транзакции LockTimeoutException
будет брошен, если база данных, блокирующая отказ, вызовет только откат на уровне оператора Если специфичное для поставщика свойство или подсказка не распознаются, это тихо игнорируется.
Переносимые приложения не должны положиться на стандартную подсказку тайм-аута. В зависимости от базы данных в использовании и механизмах блокировки, используемых провайдером, подсказка может или не может наблюдаться.
entity
- экземпляр объектаlockMode
- режим блокировкиproperties
- стандартные и специфичные для поставщика свойства и подсказки IllegalArgumentException
- если экземпляр не является объектом или является отсоединенным объектом TransactionRequiredException
- если нет никакой транзакции EntityNotFoundException
- если объект не существует в базе данных, когда пессимистическая блокировка выполняется OptimisticLockException
- если оптимистическая проверка версии перестала работать PessimisticLockException
- если пессимистические сбои блокировки и транзакция откатываются LockTimeoutException
- если пессимистические сбои блокировки и только оператор откатываются PersistenceException
- если неподдерживаемый вызов блокировки выполняетсяvoid refresh(java.lang.Object entity)
entity
- экземпляр объекта IllegalArgumentException
- если экземпляр не является объектом, или объектом не управляют TransactionRequiredException
- если вызвано на управляемого контейнером менеджера по объекту типа PersistenceContextType.TRANSACTION
и нет никакой транзакции EntityNotFoundException
- если объект больше не существует в базе данныхvoid refresh(java.lang.Object entity, java.util.Map<java.lang.String,java.lang.Object> properties)
Если специфичное для поставщика свойство или подсказка не распознаются, это тихо игнорируется.
entity
- экземпляр объектаproperties
- стандартные и специфичные для поставщика свойства и подсказки IllegalArgumentException
- если экземпляр не является объектом, или объектом не управляют TransactionRequiredException
- если вызвано на управляемого контейнером менеджера по объекту типа PersistenceContextType.TRANSACTION
и нет никакой транзакции EntityNotFoundException
- если объект больше не существует в базе данныхvoid refresh(java.lang.Object entity, LockModeType lockMode)
Если тип режима блокировки пессимистичен, и экземпляр объекта находится, но не может быть заблокирован:
PessimisticLockException
будет брошен, если база данных, блокирующая отказ, вызовет откат на уровне транзакции LockTimeoutException
будет брошен, если база данных, блокирующая отказ, вызовет только откат на уровне оператора.
entity
- экземпляр объектаlockMode
- режим блокировки IllegalArgumentException
- если экземпляр не является объектом, или объектом не управляют TransactionRequiredException
- если нет никакой транзакции и если вызвано на управляемый контейнером EntityManager
экземпляр с PersistenceContextType.TRANSACTION
или с режимом блокировки кроме NONE
EntityNotFoundException
- если объект больше не существует в базе данных PessimisticLockException
- если пессимистические сбои блокировки и транзакция откатываются LockTimeoutException
- если пессимистические сбои блокировки и только оператор откатываются PersistenceException
- если неподдерживаемый вызов блокировки выполняетсяvoid refresh(java.lang.Object entity, LockModeType lockMode, java.util.Map<java.lang.String,java.lang.Object> properties)
Если тип режима блокировки пессимистичен, и экземпляр объекта находится, но не может быть заблокирован:
PessimisticLockException
будет брошен, если база данных, блокирующая отказ, вызовет откат на уровне транзакции LockTimeoutException
будет брошен, если база данных, блокирующая отказ, вызовет только откат на уровне оператора Если специфичное для поставщика свойство или подсказка не распознаются, это тихо игнорируется.
Переносимые приложения не должны положиться на стандартную подсказку тайм-аута. В зависимости от базы данных в использовании и механизмах блокировки, используемых провайдером, подсказка может или не может наблюдаться.
entity
- экземпляр объектаlockMode
- режим блокировкиproperties
- стандартные и специфичные для поставщика свойства и подсказки IllegalArgumentException
- если экземпляр не является объектом, или объектом не управляют TransactionRequiredException
- если нет никакой транзакции и если вызвано на управляемый контейнером EntityManager
экземпляр с PersistenceContextType.TRANSACTION
или с режимом блокировки кроме NONE
EntityNotFoundException
- если объект больше не существует в базе данных PessimisticLockException
- если пессимистические сбои блокировки и транзакция откатываются LockTimeoutException
- если пессимистические сбои блокировки и только оператор откатываются PersistenceException
- если неподдерживаемый вызов блокировки выполняетсяvoid clear()
void detach(java.lang.Object entity)
entity
- экземпляр объекта IllegalArgumentException
- если экземпляр не является объектомboolean contains(java.lang.Object entity)
entity
- экземпляр объекта IllegalArgumentException
- если не объектLockModeType getLockMode(java.lang.Object entity)
entity
- экземпляр объекта TransactionRequiredException
- если нет никакой транзакции IllegalArgumentException
- если экземпляр не является управляемым объектом, и транзакция является активнойvoid setProperty(java.lang.String propertyName, java.lang.Object value)
propertyName
- имя свойства или подсказкиvalue
- значение для свойства или подсказки IllegalArgumentException
- если второй параметр не допустим для реализацииjava.util.Map<java.lang.String,java.lang.Object> getProperties()
Query createQuery(java.lang.String qlString)
Query
для того, чтобы выполнить оператор языка запросов Персистентности Java.
qlString
- Персистентность Java запрашивает строку IllegalArgumentException
- если строка запроса, как находят, недопустима<T> TypedQuery<T> createQuery(CriteriaQuery<T> criteriaQuery)
TypedQuery
для того, чтобы выполнить запрос критериев.
criteriaQuery
- критерии запрашивают объект IllegalArgumentException
- если запрос критериев, как находят, недопустим<T> TypedQuery<T> createQuery(java.lang.String qlString, java.lang.Class<T> resultClass)
TypedQuery
для того, чтобы выполнить оператор языка запросов Персистентности Java. Список выборки запроса должен содержать только единственный элемент, который должен быть присваиваемым типу, определенному resultClass
параметр.
qlString
- Персистентность Java запрашивает строкуresultClass
- тип результата запроса IllegalArgumentException
- если строка запроса, как находят, недопустима или если результат запроса, как находят, не присваиваем указанному типуQuery createNamedQuery(java.lang.String name)
Query
для того, чтобы выполнить именованный запрос (в языке запросов Персистентности Java или в собственном SQL).
name
- имя запроса определяется в метаданных IllegalArgumentException
- если запрос не был определен с помощью имени или если строка запроса, как находят, недопустима<T> TypedQuery<T> createNamedQuery(java.lang.String name, java.lang.Class<T> resultClass)
TypedQuery
для того, чтобы выполнить язык запросов Персистентности Java, названный запросом. Список выборки запроса должен содержать только единственный элемент, который должен быть присваиваемым типу, определенному resultClass
параметр.
name
- имя запроса определяется в метаданныхresultClass
- тип результата запроса IllegalArgumentException
- если запрос не был определен с помощью имени или если строка запроса, как находят, недопустима или если результат запроса, как находят, не присваиваем указанному типуQuery createNativeQuery(java.lang.String sqlString)
Query
для того, чтобы выполнить собственный SQL-оператор, например, для обновления или удаляют.
sqlString
- собственная строка SQL-запроса Query createNativeQuery(java.lang.String sqlString, java.lang.Class resultClass)
Query
для того, чтобы выполнить собственный SQL-запрос.
sqlString
- собственная строка SQL-запросаresultClass
- class результирующего экземпляра (ов) Query createNativeQuery(java.lang.String sqlString, java.lang.String resultSetMapping)
Query
для того, чтобы выполнить собственный SQL-запрос.
sqlString
- собственная строка SQL-запросаresultSetMapping
- имя отображения набора результатов void joinTransaction()
TransactionRequiredException
- если нет никакой транзакции<T> T unwrap(java.lang.Class<T> cls)
EntityManager
реализация не поддерживает указанный class, PersistenceException
бросается.
cls
- class объекта, который будет возвращен. Это - обычно любой базовое EntityManager
class реализации или интерфейс, который это реализует. PersistenceException
- если провайдер не поддерживает вызовjava.lang.Object getDelegate()
EntityManager
, при наличии. Результатом этого метода является определенная реализация. unwrap
метод должен быть предпочтен для новых приложений.
void close()
EntityManager
экземпляр и любой Query
и TypedQuery
объекты, полученные из этого, бросят IllegalStateException
за исключением getProperties
, getTransaction
, и isOpen
(который возвратит false). Если этот метод вызывают, когда менеджер по объекту связывается с активной транзакцией, контекст персистентности остается управляемым, пока транзакция не завершается.
IllegalStateException
- если менеджер по объекту управляется контейнеромboolean isOpen()
EntityTransaction getTransaction()
EntityTransaction
объект. EntityTransaction
экземпляр может использоваться последовательно, чтобы начать и фиксировать многократные транзакции.
IllegalStateException
- если вызвано на менеджера по объекту JTAEntityManagerFactory getEntityManagerFactory()
IllegalStateException
- если менеджер по объекту был закрытCriteriaBuilder getCriteriaBuilder()
CriteriaBuilder
для создания CriteriaQuery
объекты.
IllegalStateException
- если менеджер по объекту был закрытMetamodel getMetamodel()
Metamodel
интерфейс для доступа к метамодели модуля персистентности.
IllegalStateException
- если менеджер по объекту был закрыт
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41