org.josef.jpa

Class JpaUtil

java.lang.Object

org.josef.jpa.JpaUtil

@Status(stage=TEST,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public final class JpaUtil
extends Object

JPA Utility Class.

Version:

1.0 $Revision: 5855 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static List<String>	getColumns(Class<? extends Persistable> persistableClass) Gets all the columns that are defined within the supplied persistableClass (or one of its super classes).
static CompareField[]	getCompareFields(Class<? extends Persistable> persistableClass) Gets all the possible fields that can be compared upon in the supplied persistableClass (or one of its super classes).
static void	setParameters(javax.persistence.Query query, List<Object> parameters) Sets the supplied parameters on the supplied query.
static void	setParameters(javax.persistence.Query query, Map<String,Object> parameterNamesToValues) Sets the supplied parameterNamesToValues on the supplied query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getColumns

public static List<String> getColumns(Class<? extends Persistable> persistableClass)

Gets all the columns that are defined within the supplied persistableClass (or one of its super classes).

Parameters:

persistableClass - The persistable class to get the columns from.

Returns:

All the columns that are defined within the supplied persistableClass (or one of its super classes).

getCompareFields

public static CompareField[] getCompareFields(Class<? extends Persistable> persistableClass)

Gets all the possible fields that can be compared upon in the supplied persistableClass (or one of its super classes).
This includes the fields that can be reached from the supplied persistableClass via a @OneToOne or @ManyToOne relationship.

Parameters:

persistableClass - The persistable class to get the fields from.

Returns:

all the possible fields that can be compared upon in the supplied persistableClass (or one of its super classes).

setParameters

public static void setParameters(javax.persistence.Query query,
                                 List<Object> parameters)

Sets the supplied parameters on the supplied query.
This method assumes that parameters are numbered!

Parameters:

query - The query.

parameters - The parameters to set on the supplied query.
When null, no parameters are set.

Throws:

IllegalArgumentException - When the number of parameters does not match or when the type of the parameter does not match.

NullPointerException - When the supplied query is null.

setParameters

public static void setParameters(javax.persistence.Query query,
                                 Map<String,Object> parameterNamesToValues)

Sets the supplied parameterNamesToValues on the supplied query.
This method assumes that parameters are named!

Parameters:

query - The query.

parameterNamesToValues - The parameter name/parameter value pairs to set on the supplied query.
When null, no parameters are set.

Throws:

NullPointerException - When the supplied query or parameters is null.