Index (jpaservices 11.4 API)

A B C D E F G H I J L N O P R S T U V W

A

AbstractCrudService - Class in org.fryske_akademy.services: This base class enables you to create crud service beans with minimal effort.
AbstractCrudService() - Constructor for class org.fryske_akademy.services.AbstractCrudService
AbstractCrudServiceEnvers - Class in org.fryske_akademy.services
AbstractCrudServiceEnvers() - Constructor for class org.fryske_akademy.services.AbstractCrudServiceEnvers
AbstractEntity - Class in org.fryske_akademy.jpa: superclass for entities, defines auto generated id (GenerationType.IDENTITY), a version column and a function to check if the entity is transient (not in db yet).
AbstractEntity() - Constructor for class org.fryske_akademy.jpa.AbstractEntity
AbstractWsEntity - Class in org.fryske_akademy.jpa: Base for 'readonly' entities in for example webservices.
AbstractWsEntity() - Constructor for class org.fryske_akademy.jpa.AbstractWsEntity
add(String, Object) - Method in class org.fryske_akademy.jpa.Param.Builder: This method is suitable when your paramValue is the correct object for the query to be executed.
add(String, Object, boolean) - Method in class org.fryske_akademy.jpa.Param.Builder: This method is suitable when your paramValue is the correct object for the query to be executed.
add(String, String, StringConverter) - Method in class org.fryske_akademy.jpa.Param.Builder: This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed.
add(String, String, String, StringConverter) - Method in class org.fryske_akademy.jpa.Param.Builder: Uses true for "or"
add(String, String, boolean, StringConverter) - Method in class org.fryske_akademy.jpa.Param.Builder: This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed.
add(String, String, String, boolean, StringConverter) - Method in class org.fryske_akademy.jpa.Param.Builder: Assumes key and propertyPath are the same
add(String, String, String, String, boolean, StringConverter) - Method in class org.fryske_akademy.jpa.Param.Builder: Bottleneck method for String values, when configured in the Builder, applies syntax support and wildcard mapping, applies conversion of the String value.
add(String, String, String, Object, boolean, boolean) - Method in class org.fryske_akademy.jpa.Param.Builder: Bottleneck method, adds a new Param, does not apply any intelligence.
add(String, CrudReadService.SORTORDER) - Method in class org.fryske_akademy.services.CrudReadService.SORTORDER.Builder
Auditing - Interface in org.fryske_akademy.services: Generic interface for entity history.

B

batchDelete(Collection<? extends EntityInterface>, Integer) - Method in class org.fryske_akademy.services.AbstractCrudService
batchDelete(Collection<? extends EntityInterface>, Integer) - Method in interface org.fryske_akademy.services.CrudWriteService: save multiple entities, NOTE that normally only after commit or flush entitymanagers will reflect changes caused by saving all entities, this may cause entitylisteners to fail.
batchSave(Collection<T>, Integer) - Method in class org.fryske_akademy.services.AbstractCrudService
batchSave(Collection<T>, Integer) - Method in interface org.fryske_akademy.services.CrudWriteService: save multiple entities, NOTE that normally only after commit or flush entitymanagers will reflect changes caused by saving all entities, this may cause entitylisteners to fail.
build() - Method in class org.fryske_akademy.jpa.Param.Builder
build() - Method in class org.fryske_akademy.services.CrudReadService.SORTORDER.Builder
Builder(boolean, Param.Builder.WildcardMapping, boolean) - Constructor for class org.fryske_akademy.jpa.Param.Builder
Builder() - Constructor for class org.fryske_akademy.jpa.Param.Builder: Builder with syntax support in value (!, is [not] null, is [not] empty).
Builder(boolean) - Constructor for class org.fryske_akademy.jpa.Param.Builder: Calls #Builder(boolean, WildcardMapping, boolean) } with true, null and the caseInsensitive argument.
Builder() - Constructor for class org.fryske_akademy.services.CrudReadService.SORTORDER.Builder

C

containsKey(String) - Method in class org.fryske_akademy.jpa.Param.Builder
count(String, List<Param>) - Method in class org.fryske_akademy.services.AbstractCrudService
count(String, List<Param>) - Method in interface org.fryske_akademy.services.CrudReadService: Call this using the same parameters as in CrudReadService.find(java.lang.String, java.util.List, java.lang.Integer, java.lang.Integer, java.lang.Class) to get to know the total number of results
countDynamic(List<Param>, Class) - Method in class org.fryske_akademy.services.AbstractCrudService
countDynamic(List<Param>, Class) - Method in interface org.fryske_akademy.services.CrudReadService: Call this using the same parameters as in findDynamic to get to know the total number of results
create(T) - Method in class org.fryske_akademy.services.AbstractCrudService: When overriding look into roles to use, these are not inherited.
create(T) - Method in interface org.fryske_akademy.services.CrudWriteService
CrudReadService - Interface in org.fryske_akademy.services: Generic interface for read operations on entities.
CrudReadService.SORTORDER - Enum in org.fryske_akademy.services
CrudReadService.SORTORDER.Builder - Class in org.fryske_akademy.services
CrudWriteService - Interface in org.fryske_akademy.services: Generic interface for write operations on entities

D

deepestCause(Throwable) - Static method in class org.fryske_akademy.Util: you can set log level to fine to see the original stacktrace in the log.
DEFAULT_MAPPING - Static variable in class org.fryske_akademy.jpa.Param.Builder
DEFAULT_PAGE_SIZE - Static variable in class org.fryske_akademy.services.AbstractCrudService: default page size (max results), used when no maximum is given.
DefaultWildcardMapping() - Constructor for class org.fryske_akademy.jpa.Param.Builder.DefaultWildcardMapping
delete(EntityInterface) - Method in class org.fryske_akademy.services.AbstractCrudService: When overriding look into roles to use, these are not inherited.
delete(EntityInterface) - Method in interface org.fryske_akademy.services.CrudWriteService

E

EDITORROLE - Static variable in class org.fryske_akademy.services.AbstractCrudService
ENTITY_PREFIX - Static variable in class org.fryske_akademy.jpa.JpqlBuilderImpl
EntityException - Exception in org.fryske_akademy.jpa: An Exception that tracks the entity that caused the failure, useful for example the combination of EntityListeners and batch operations.
EntityException(EntityInterface) - Constructor for exception org.fryske_akademy.jpa.EntityException
EntityException(EntityInterface, String) - Constructor for exception org.fryske_akademy.jpa.EntityException
EntityException(EntityInterface, Exception) - Constructor for exception org.fryske_akademy.jpa.EntityException
EntityException(EntityInterface, String, Exception) - Constructor for exception org.fryske_akademy.jpa.EntityException
EntityInterface - Interface in org.fryske_akademy.jpa
equals(Object) - Method in class org.fryske_akademy.jpa.AbstractEntity
equals(Object) - Method in class org.fryske_akademy.jpa.AbstractWsEntity
equals(Object) - Method in class org.fryske_akademy.jpa.Param

F

FARevisionListener - Class in org.fryske_akademy.jpa
FARevisionListener() - Constructor for class org.fryske_akademy.jpa.FARevisionListener
find(Serializable, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
find(String, List<Param>, Integer, Integer, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
find(Serializable, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
find(String, List<Param>, Integer, Integer, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
findAll(Class<T>, EntityManager) - Static method in class org.fryske_akademy.jpa.JpaUtil
findAll(Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
findAll(Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
findDynamic(Integer, Integer, Map<String, CrudReadService.SORTORDER>, List<Param>, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
findDynamic(Integer, Integer, Map<String, CrudReadService.SORTORDER>, List<Param>, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
findInClass(Class, String) - Static method in class org.fryske_akademy.Util: Look for methods with return type enum, whose simple class is the first part of the argument string, look for the enum constant whose name is the last part of the argument string.
findNative(String, List<Param>, Integer, Integer, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
findNative(String, List<Param>, Integer, Integer, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
findOne(String, List<Param>, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
findOne(String, List<Param>, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService: return one result or null, multiple results throws an exception
findPrincipal() - Static method in class org.fryske_akademy.jpa.JpaUtil: Looks for principal in CDI
fromException(Throwable) - Static method in exception org.fryske_akademy.jpa.EntityException: get hold of an entity in the exception chain.

G

getAndOr() - Method in class org.fryske_akademy.jpa.Param: Will be prepended in the query for parameters except the first
getBean(Class<T>, Annotation...) - Static method in class org.fryske_akademy.Util: find a bean programmatically in CDI provider, can be used if you need one in an unmanaged situation.
getDefaultPageSize() - Method in class org.fryske_akademy.services.AbstractCrudService
getDefaultPageSize() - Method in interface org.fryske_akademy.services.CrudReadService: Return a default page size when no max is given, negative value means no limit
getEntity() - Method in class org.fryske_akademy.jpa.RevInfo
getEntityManager() - Method in interface org.fryske_akademy.services.CrudWriteService
getEntityManagerFactory(String) - Static method in class org.fryske_akademy.jpa.JpaUtil: return a cached EntityManagerFactory, make sure you close it when it is not needed anymore.
getEnumWithValue(Object) - Static method in class org.fryske_akademy.Util: look for a method returning an enum, call it, if the value isn't null return it.
getFailed() - Method in exception org.fryske_akademy.jpa.EntityException
getId() - Method in class org.fryske_akademy.jpa.AbstractEntity
getId() - Method in class org.fryske_akademy.jpa.AbstractWsEntity
getId() - Method in interface org.fryske_akademy.jpa.EntityInterface: an entity should have an id
getMoreIn() - Method in class org.fryske_akademy.jpa.Param.Builder.DefaultWildcardMapping
getMoreIn() - Method in interface org.fryske_akademy.jpa.Param.Builder.WildcardMapping
getMoreOut() - Method in class org.fryske_akademy.jpa.Param.Builder.DefaultWildcardMapping
getMoreOut() - Method in interface org.fryske_akademy.jpa.Param.Builder.WildcardMapping
getNot() - Method in class org.fryske_akademy.jpa.Param
getOneIn() - Method in class org.fryske_akademy.jpa.Param.Builder.DefaultWildcardMapping
getOneIn() - Method in interface org.fryske_akademy.jpa.Param.Builder.WildcardMapping
getOneOut() - Method in class org.fryske_akademy.jpa.Param.Builder.DefaultWildcardMapping
getOneOut() - Method in interface org.fryske_akademy.jpa.Param.Builder.WildcardMapping
getOperator() - Method in class org.fryske_akademy.jpa.Param
getParamKey() - Method in class org.fryske_akademy.jpa.Param: for native queries this key should be a numeric positional parameter
getParamType() - Method in class org.fryske_akademy.jpa.Param
getParamValue() - Method in class org.fryske_akademy.jpa.Param
getPropertyPath() - Method in class org.fryske_akademy.jpa.Param
getRevision(Number, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudServiceEnvers
getRevision(Number, Class<T>) - Method in interface org.fryske_akademy.services.Auditing: get historical data for a certain revision
getRevisionInfo() - Method in class org.fryske_akademy.jpa.RevInfo
getRevisionInfo(Serializable, Integer, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudServiceEnvers
getRevisionInfo(Serializable, Integer, Class<T>) - Method in interface org.fryske_akademy.services.Auditing: return a list holding revision information, newest come first
getRevisionNumbers(Serializable, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudServiceEnvers
getRevisionNumbers(Serializable, Class<T>) - Method in interface org.fryske_akademy.services.Auditing: return list of revision numbers, first is the oldest
getType() - Method in class org.fryske_akademy.jpa.RevInfo
getUsername() - Method in class org.fryske_akademy.jpa.RevisionInfo
getVersion() - Method in class org.fryske_akademy.jpa.AbstractEntity
getVersion() - Method in class org.fryske_akademy.jpa.AbstractWsEntity

H

hashCode() - Method in class org.fryske_akademy.jpa.AbstractEntity
hashCode() - Method in class org.fryske_akademy.jpa.AbstractWsEntity
hashCode() - Method in class org.fryske_akademy.jpa.Param
hasSetterForEnumString(String, Object) - Static method in class org.fryske_akademy.Util: look for a setter ignoring case for a string in the form "enum simple class"."enum name", return true if it is found.

I

isCaseInsensitive() - Method in class org.fryske_akademy.jpa.Param
ISEMPTY - Static variable in class org.fryske_akademy.jpa.Param.Builder
isNegation(String) - Method in class org.fryske_akademy.jpa.Param.Builder: check if a string (user value) indicates a negation and syntaxInValue is used
ISNOTEMPTY - Static variable in class org.fryske_akademy.jpa.Param.Builder
ISNOTNULL - Static variable in class org.fryske_akademy.jpa.Param.Builder
ISNULL - Static variable in class org.fryske_akademy.jpa.Param.Builder
isSyntaxInValue() - Method in class org.fryske_akademy.jpa.Param.Builder: when true wildcards are not replaced and syntax in value is not applied
isTransient() - Method in class org.fryske_akademy.jpa.AbstractEntity: is the entity in the db?
isTransient() - Method in interface org.fryske_akademy.jpa.EntityInterface: is the entity in the database

J

JpaUtil - Class in org.fryske_akademy.jpa
JpaUtil() - Constructor for class org.fryske_akademy.jpa.JpaUtil
JpqlBuilder - Interface in org.fryske_akademy.jpa: Responsible for building where and order by clauses in jpql
JpqlBuilderImpl - Class in org.fryske_akademy.jpa: Stateless, threadsafe builder containing functions for building jpql}.
JpqlBuilderImpl() - Constructor for class org.fryske_akademy.jpa.JpqlBuilderImpl

L

listEnums(Class) - Static method in class org.fryske_akademy.Util: look for all methods whose return type is an enum and add all constants to the result.

N

NEGATION - Static variable in class org.fryske_akademy.jpa.Param.Builder
newRevision(Object) - Method in class org.fryske_akademy.jpa.FARevisionListener: adds principal name or FARevisionListener.UNKNOWN to RevisionInfo.

O

one(String, Object) - Static method in class org.fryske_akademy.jpa.Param: Call Param.one(String, Object, boolean, Builder.WildcardMapping, boolean) with true, Param.Builder.DEFAULT_MAPPING and false
one(String, String, StringConverter) - Static method in class org.fryske_akademy.jpa.Param: Calls Param.one(String, String, StringConverter) }
one(String, Object, boolean, Param.Builder.WildcardMapping, boolean) - Static method in class org.fryske_akademy.jpa.Param: Calls Param.Builder.add(java.lang.String, java.lang.Object)
operator(String, String, boolean) - Static method in class org.fryske_akademy.jpa.Param.Builder: Returns static final Strings when syntax is used and present in value, otherwise the trimmed operator
order(String, CrudReadService.SORTORDER) - Static method in enum org.fryske_akademy.services.CrudReadService.SORTORDER
orderClause(Map<String, CrudReadService.SORTORDER>) - Method in interface org.fryske_akademy.jpa.JpqlBuilder: builds an order by clause
orderClause(Map<String, CrudReadService.SORTORDER>) - Method in class org.fryske_akademy.jpa.JpqlBuilderImpl: builds an order by clause, uses JpqlBuilderImpl.ENTITY_PREFIX.
org.fryske_akademy - package org.fryske_akademy
org.fryske_akademy.jpa - package org.fryske_akademy.jpa: Interfaces classes to support working with entities, most notably an entity interface, a Param class with support for syntax in values and value conversion and a JpqlBuilder that facilitates building (dynamic) queries.
org.fryske_akademy.services - package org.fryske_akademy.services: This package contains interfaces and base classes for the development of crud (EJB/CDI) beans.

P

Param - Class in org.fryske_akademy.jpa: Holder for parameter info that can be used when building a jpql query.
Param.AndOr - Enum in org.fryske_akademy.jpa
Param.Builder - Class in org.fryske_akademy.jpa: Helps building a list of Parameters, there are three approaches for values.
Param.Builder.DefaultWildcardMapping - Class in org.fryske_akademy.jpa: * => %, ? => _, NOTE that this mapping causes all four characters to be interpreted as wildcards in jpql/sql.
Param.Builder.WildcardMapping - Interface in org.fryske_akademy.jpa: translation table a wildcard for more characters and a wildcard for one character

R

remove(String) - Method in class org.fryske_akademy.jpa.Param.Builder
RevInfo<T> - Class in org.fryske_akademy.jpa: container for revision info for an entity, used in Auditing.getRevisionInfo(java.io.Serializable, java.lang.Integer, java.lang.Class)
RevInfo(T, RevInfo.TYPE, RevisionInfo) - Constructor for class org.fryske_akademy.jpa.RevInfo
RevInfo.TYPE - Enum in org.fryske_akademy.jpa
RevisionInfo - Class in org.fryske_akademy.jpa: Include this entity in the list of entity classes in your persistence context.
RevisionInfo() - Constructor for class org.fryske_akademy.jpa.RevisionInfo

S

save(T) - Method in class org.fryske_akademy.services.AbstractCrudService: When overriding look into roles to use, these are not inherited.
save(T) - Method in interface org.fryske_akademy.services.CrudWriteService: create or update depending on EntityInterface.isTransient().
set(Query, String, Object) - Method in class org.fryske_akademy.jpa.JpqlBuilderImpl: When the Query has the parameter "key" call Query.setParameter(java.lang.String, java.lang.Object) otherwise call Query.setParameter(int, java.lang.Object) with Short.valueOf(key), because then a positional parameter in a native query is assumed.
setEnum(Enum, T) - Static method in class org.fryske_akademy.Util: Look for a setter for the enum in the object, call it and return the object.
setEnumsFromString(String, T) - Static method in class org.fryske_akademy.Util: parse a string containing enums the form "enum simple class"."enum name" separated by space, look for the right setter in the Object class and call the setter.
setId(Integer) - Method in class org.fryske_akademy.jpa.AbstractEntity
setId(Integer) - Method in class org.fryske_akademy.jpa.AbstractWsEntity
setJpqlBuilder(JpqlBuilder) - Method in class org.fryske_akademy.services.AbstractCrudService: override to inject your own version of JpqlBuilder
setParam(Query, Param) - Method in interface org.fryske_akademy.jpa.JpqlBuilder: Set the value of a jpql parameter prepared in JpqlBuilder.whereCondition(Param)
setParam(Query, Param) - Method in class org.fryske_akademy.jpa.JpqlBuilderImpl: Fills parameters prepared in JpqlBuilderImpl.setWhereParams(javax.persistence.Query, java.util.List), if the type of the field in the query is a Short or an Integer and the paramValue is a String, it is converted accordingly.
setUsername(String) - Method in class org.fryske_akademy.jpa.RevisionInfo
setVersion(int) - Method in class org.fryske_akademy.jpa.AbstractEntity
setVersion(int) - Method in class org.fryske_akademy.jpa.AbstractWsEntity
setWhereParams(Query, List<Param>) - Method in interface org.fryske_akademy.jpa.JpqlBuilder: Fills parameters created in JpqlBuilder.whereCondition(Param)
setWhereParams(Query, List<Param>) - Method in class org.fryske_akademy.jpa.JpqlBuilderImpl: Calls JpqlBuilderImpl.setParam(Query, Param) for each filter.
split(String, int) - Static method in class org.fryske_akademy.Util: Calls Util.split(java.lang.String, int, boolean) with false.
split(String, int, boolean) - Static method in class org.fryske_akademy.Util: Call Util.split(java.lang.String, java.lang.String, int, boolean) with ": ?" as regex.
split(String, String, int, boolean) - Static method in class org.fryske_akademy.Util: split a string on regex and return the requested index, or null.
stream(String, List<Param>, Integer, Integer, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
stream(String, List<Param>, Integer, Integer, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
streamAll(Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
streamAll(Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
streamDynamic(Integer, Integer, Map<String, CrudReadService.SORTORDER>, List<Param>, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
streamDynamic(Integer, Integer, Map<String, CrudReadService.SORTORDER>, List<Param>, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService
streamNative(String, List<Param>, Integer, Integer, Class<T>) - Method in class org.fryske_akademy.services.AbstractCrudService
streamNative(String, List<Param>, Integer, Integer, Class<T>) - Method in interface org.fryske_akademy.services.CrudReadService

T

toString() - Method in enum org.fryske_akademy.jpa.Param.AndOr
toString() - Method in class org.fryske_akademy.jpa.Param
toString(Enum) - Static method in class org.fryske_akademy.Util: return "enum simple class"."enum name"
toString(List<Enum>) - Static method in class org.fryske_akademy.Util: return "[" + Util.toString(java.lang.Enum) for each enum + "]"

U

UNKNOWN - Static variable in class org.fryske_akademy.jpa.FARevisionListener: when principal name not found
update(T) - Method in class org.fryske_akademy.services.AbstractCrudService: When overriding look into roles to use, these are not inherited.
update(T) - Method in interface org.fryske_akademy.services.CrudWriteService
Util - Class in org.fryske_akademy
Util() - Constructor for class org.fryske_akademy.Util

V

valueIsOperator(String, boolean) - Static method in class org.fryske_akademy.jpa.Param.Builder: users may input "is (not) null", "is (not) empty" etc., in that case there is no parameter value to be set for a key.
valueOf(String) - Static method in enum org.fryske_akademy.jpa.Param.AndOr: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.fryske_akademy.jpa.RevInfo.TYPE: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.fryske_akademy.services.CrudReadService.SORTORDER: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.fryske_akademy.jpa.Param.AndOr: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.fryske_akademy.jpa.RevInfo.TYPE: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.fryske_akademy.services.CrudReadService.SORTORDER: Returns an array containing the constants of this enum type, in the order they are declared.

W

whereClause(List<Param>) - Method in interface org.fryske_akademy.jpa.JpqlBuilder: builds a where clause
whereClause(List<Param>) - Method in class org.fryske_akademy.jpa.JpqlBuilderImpl: builds a where clause, calls JpqlBuilderImpl.whereCondition(Param) for every entry.
whereCondition(Param) - Method in interface org.fryske_akademy.jpa.JpqlBuilder: builds a where condition
whereCondition(Param) - Method in class org.fryske_akademy.jpa.JpqlBuilderImpl: builds a where condition, prepares query parameters later filled in JpqlBuilderImpl.setWhereParams(javax.persistence.Query, java.util.List).

A B C D E F G H I J L N O P R S T U V W