public abstract class PanacheEntityBase extends Object
Represents an entity. If your Hibernate entities extend this class they gain auto-generated accessors
to all their public fields (unless annotated with Transient
), as well as a lot of useful
methods. Unless you have a custom ID strategy, you should not extend this class directly but extend
PanacheEntity
instead.
PanacheEntity
Constructor and Description |
---|
PanacheEntityBase() |
Modifier and Type | Method and Description |
---|---|
static long |
count()
Counts the number of this type of entity in the database.
|
static long |
count(String query,
Map<String,Object> params)
Counts the number of this type of entity matching the given query, with named parameters.
|
static long |
count(String query,
Object... params)
Counts the number of this type of entity matching the given query, with optional indexed parameters.
|
static long |
count(String query,
Parameters params)
Counts the number of this type of entity matching the given query, with named parameters.
|
void |
delete()
Delete this entity from the database, if it is already persisted.
|
static long |
delete(String query,
Map<String,Object> params)
Delete all entities of this type matching the given query, with named parameters.
|
static long |
delete(String query,
Object... params)
Delete all entities of this type matching the given query, with optional indexed parameters.
|
static long |
delete(String query,
Parameters params)
Delete all entities of this type matching the given query, with named parameters.
|
static long |
deleteAll()
Delete all entities of this type from the database.
|
static <T extends PanacheEntityBase> |
find(String query,
Map<String,Object> params)
Find entities using a query, with named parameters.
|
static <T extends PanacheEntityBase> |
find(String query,
Object... params)
Find entities using a query, with optional indexed parameters.
|
static <T extends PanacheEntityBase> |
find(String query,
Parameters params)
Find entities using a query, with named parameters.
|
static <T extends PanacheEntityBase> |
find(String query,
Sort sort,
Map<String,Object> params)
Find entities using a query and the given sort options, with named parameters.
|
static <T extends PanacheEntityBase> |
find(String query,
Sort sort,
Object... params)
Find entities using a query and the given sort options, with optional indexed parameters.
|
static <T extends PanacheEntityBase> |
find(String query,
Sort sort,
Parameters params)
Find entities using a query and the given sort options, with named parameters.
|
static <T extends PanacheEntityBase> |
findAll()
Find all entities of this type.
|
static <T extends PanacheEntityBase> |
findAll(Sort sort)
Find all entities of this type, in the given order.
|
static <T extends PanacheEntityBase> |
findById(Object id)
Find an entity of this type by ID.
|
void |
flush()
Flushes all pending changes to the database.
|
boolean |
isPersistent()
Returns true if this entity is persistent in the database.
|
static <T extends PanacheEntityBase> |
list(String query,
Map<String,Object> params)
Find entities matching a query, with named parameters.
|
static <T extends PanacheEntityBase> |
list(String query,
Object... params)
Find entities matching a query, with optional indexed parameters.
|
static <T extends PanacheEntityBase> |
list(String query,
Parameters params)
Find entities matching a query, with named parameters.
|
static <T extends PanacheEntityBase> |
list(String query,
Sort sort,
Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters.
|
static <T extends PanacheEntityBase> |
list(String query,
Sort sort,
Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters.
|
static <T extends PanacheEntityBase> |
list(String query,
Sort sort,
Parameters params)
Find entities matching a query and the given sort options, with named parameters.
|
static <T extends PanacheEntityBase> |
listAll()
Find all entities of this type.
|
static <T extends PanacheEntityBase> |
listAll(Sort sort)
Find all entities of this type, in the given order.
|
void |
persist()
Persist this entity in the database, if not already persisted.
|
static void |
persist(Iterable<?> entities)
Persist all given entities.
|
static void |
persist(Object firstEntity,
Object... entities)
Persist all given entities.
|
static void |
persist(Stream<?> entities)
Persist all given entities.
|
void |
persistAndFlush()
Persist this entity in the database, if not already persisted.
|
static <T extends PanacheEntityBase> |
stream(String query,
Map<String,Object> params)
Find entities matching a query, with named parameters.
|
static <T extends PanacheEntityBase> |
stream(String query,
Object... params)
Find entities matching a query, with optional indexed parameters.
|
static <T extends PanacheEntityBase> |
stream(String query,
Parameters params)
Find entities matching a query, with named parameters.
|
static <T extends PanacheEntityBase> |
stream(String query,
Sort sort,
Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters.
|
static <T extends PanacheEntityBase> |
stream(String query,
Sort sort,
Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters.
|
static <T extends PanacheEntityBase> |
stream(String query,
Sort sort,
Parameters params)
Find entities matching a query and the given sort options, with named parameters.
|
static <T extends PanacheEntityBase> |
streamAll()
Find all entities of this type.
|
static <T extends PanacheEntityBase> |
streamAll(Sort sort)
Find all entities of this type, in the given order.
|
public void persist()
public void persistAndFlush()
public void delete()
public boolean isPersistent()
public void flush()
@GenerateBridge(targetReturnTypeErased=true) public static <T extends PanacheEntityBase> T findById(Object id)
id
- the ID of the entity to find.null
if not found.@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> find(String query, Object... params)
query
- a query string
params
- optional sequence of indexed parametersPanacheQuery
instance for the given queryfind(String, Sort, Object...)
,
find(String, Map)
,
find(String, Parameters)
,
list(String, Object...)
,
stream(String, Object...)
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> find(String query, Sort sort, Object... params)
query
- a query string
sort
- the sort strategy to useparams
- optional sequence of indexed parametersPanacheQuery
instance for the given queryfind(String, Object...)
,
find(String, Sort, Map)
,
find(String, Sort, Parameters)
,
list(String, Sort, Object...)
,
stream(String, Sort, Object...)
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> find(String query, Map<String,Object> params)
query
- a query string
params
- Map
of named parametersPanacheQuery
instance for the given queryfind(String, Sort, Map)
,
find(String, Object...)
,
find(String, Parameters)
,
list(String, Map)
,
stream(String, Map)
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> find(String query, Sort sort, Map<String,Object> params)
query
- a query string
sort
- the sort strategy to useparams
- Map
of indexed parametersPanacheQuery
instance for the given queryfind(String, Map)
,
find(String, Sort, Object...)
,
find(String, Sort, Parameters)
,
list(String, Sort, Map)
,
stream(String, Sort, Map)
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> find(String query, Parameters params)
query
- a query string
params
- Parameters
of named parametersPanacheQuery
instance for the given queryfind(String, Sort, Parameters)
,
find(String, Map)
,
find(String, Parameters)
,
list(String, Parameters)
,
stream(String, Parameters)
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> find(String query, Sort sort, Parameters params)
query
- a query string
sort
- the sort strategy to useparams
- Parameters
of indexed parametersPanacheQuery
instance for the given queryfind(String, Parameters)
,
find(String, Sort, Map)
,
find(String, Sort, Parameters)
,
list(String, Sort, Parameters)
,
stream(String, Sort, Parameters)
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> findAll()
PanacheQuery
instance to find all entities of this type.findAll(Sort)
,
listAll()
,
streamAll()
@GenerateBridge public static <T extends PanacheEntityBase> PanacheQuery<T> findAll(Sort sort)
sort
- the sort order to usePanacheQuery
instance to find all entities of this type.findAll()
,
listAll(Sort)
,
streamAll(Sort)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> list(String query, Object... params)
find(query, params).list()
.query
- a query string
params
- optional sequence of indexed parametersList
containing all results, without paginglist(String, Sort, Object...)
,
list(String, Map)
,
list(String, Parameters)
,
find(String, Object...)
,
stream(String, Object...)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> list(String query, Sort sort, Object... params)
find(query, sort, params).list()
.query
- a query string
sort
- the sort strategy to useparams
- optional sequence of indexed parametersList
containing all results, without paginglist(String, Object...)
,
list(String, Sort, Map)
,
list(String, Sort, Parameters)
,
find(String, Sort, Object...)
,
stream(String, Sort, Object...)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> list(String query, Map<String,Object> params)
find(query, params).list()
.query
- a query string
params
- Map
of named parametersList
containing all results, without paginglist(String, Sort, Map)
,
list(String, Object...)
,
list(String, Parameters)
,
find(String, Map)
,
stream(String, Map)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> list(String query, Sort sort, Map<String,Object> params)
find(query, sort, params).list()
.query
- a query string
sort
- the sort strategy to useparams
- Map
of indexed parametersList
containing all results, without paginglist(String, Map)
,
list(String, Sort, Object...)
,
list(String, Sort, Parameters)
,
find(String, Sort, Map)
,
stream(String, Sort, Map)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> list(String query, Parameters params)
find(query, params).list()
.query
- a query string
params
- Parameters
of named parametersList
containing all results, without paginglist(String, Sort, Parameters)
,
list(String, Object...)
,
list(String, Map)
,
find(String, Parameters)
,
stream(String, Parameters)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> list(String query, Sort sort, Parameters params)
find(query, sort, params).list()
.query
- a query string
sort
- the sort strategy to useparams
- Parameters
of indexed parametersList
containing all results, without paginglist(String, Parameters)
,
list(String, Sort, Object...)
,
list(String, Sort, Map)
,
find(String, Sort, Parameters)
,
stream(String, Sort, Parameters)
@GenerateBridge public static <T extends PanacheEntityBase> List<T> listAll()
findAll().list()
.List
containing all results, without paginglistAll(Sort)
,
findAll()
,
streamAll()
@GenerateBridge public static <T extends PanacheEntityBase> List<T> listAll(Sort sort)
findAll(sort).list()
.sort
- the sort order to useList
containing all results, without paginglistAll()
,
findAll(Sort)
,
streamAll(Sort)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> stream(String query, Object... params)
find(query, params).stream()
.query
- a query string
params
- optional sequence of indexed parametersStream
containing all results, without pagingstream(String, Sort, Object...)
,
stream(String, Map)
,
stream(String, Parameters)
,
find(String, Object...)
,
list(String, Object...)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> stream(String query, Sort sort, Object... params)
find(query, sort, params).stream()
.query
- a query string
sort
- the sort strategy to useparams
- optional sequence of indexed parametersStream
containing all results, without pagingstream(String, Object...)
,
stream(String, Sort, Map)
,
stream(String, Sort, Parameters)
,
find(String, Sort, Object...)
,
list(String, Sort, Object...)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> stream(String query, Map<String,Object> params)
find(query, params).stream()
.query
- a query string
params
- Map
of named parametersStream
containing all results, without pagingstream(String, Sort, Map)
,
stream(String, Object...)
,
stream(String, Parameters)
,
find(String, Map)
,
list(String, Map)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> stream(String query, Sort sort, Map<String,Object> params)
find(query, sort, params).stream()
.query
- a query string
sort
- the sort strategy to useparams
- Map
of indexed parametersStream
containing all results, without pagingstream(String, Map)
,
stream(String, Sort, Object...)
,
stream(String, Sort, Parameters)
,
find(String, Sort, Map)
,
list(String, Sort, Map)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> stream(String query, Parameters params)
find(query, params).stream()
.query
- a query string
params
- Parameters
of named parametersStream
containing all results, without pagingstream(String, Sort, Parameters)
,
stream(String, Object...)
,
stream(String, Map)
,
find(String, Parameters)
,
list(String, Parameters)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> stream(String query, Sort sort, Parameters params)
find(query, sort, params).stream()
.query
- a query string
sort
- the sort strategy to useparams
- Parameters
of indexed parametersStream
containing all results, without pagingstream(String, Parameters)
,
stream(String, Sort, Object...)
,
stream(String, Sort, Map)
,
find(String, Sort, Parameters)
,
list(String, Sort, Parameters)
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> streamAll()
findAll().stream()
.Stream
containing all results, without pagingstreamAll(Sort)
,
findAll()
,
listAll()
@GenerateBridge public static <T extends PanacheEntityBase> Stream<T> streamAll(Sort sort)
findAll(sort).stream()
.sort
- the sort order to useStream
containing all results, without pagingstreamAll()
,
findAll(Sort)
,
listAll(Sort)
@GenerateBridge public static long count()
count(String, Object...)
,
count(String, Map)
,
count(String, Parameters)
@GenerateBridge public static long count(String query, Object... params)
query
- a query string
params
- optional sequence of indexed parameterscount()
,
count(String, Map)
,
count(String, Parameters)
@GenerateBridge public static long count(String query, Map<String,Object> params)
query
- a query string
params
- Map
of named parameterscount()
,
count(String, Object...)
,
count(String, Parameters)
@GenerateBridge public static long count(String query, Parameters params)
query
- a query string
params
- Parameters
of named parameterscount()
,
count(String, Object...)
,
count(String, Map)
@GenerateBridge public static long deleteAll()
delete(String, Object...)
,
delete(String, Map)
,
delete(String, Parameters)
@GenerateBridge public static long delete(String query, Object... params)
query
- a query string
params
- optional sequence of indexed parametersdeleteAll()
,
delete(String, Map)
,
delete(String, Parameters)
@GenerateBridge public static long delete(String query, Map<String,Object> params)
query
- a query string
params
- Map
of named parametersdeleteAll()
,
delete(String, Object...)
,
delete(String, Parameters)
@GenerateBridge public static long delete(String query, Parameters params)
query
- a query string
params
- Parameters
of named parametersdeleteAll()
,
delete(String, Object...)
,
delete(String, Map)
public static void persist(Iterable<?> entities)
entities
- the entities to persistpersist()
,
persist(Stream)
,
persist(Object,Object...)
public static void persist(Stream<?> entities)
entities
- the entities to persistpersist()
,
persist(Iterable)
,
persist(Object,Object...)
public static void persist(Object firstEntity, Object... entities)
entities
- the entities to persistpersist()
,
persist(Stream)
,
persist(Iterable)
Copyright © 2019 JBoss by Red Hat. All rights reserved.