no.g9.domain

Class DomainUtil

java.lang.Object

no.g9.domain.DomainUtil

public class DomainUtil
extends Object

Utility class for domain objects.

Method Summary

Modifier and Type	Method and Description
static boolean	equalsLockFlag(Serializable flag1, Serializable flag2) Return true if two lockFlags are equal
static <T,U extends T> Class<T>	getDomainClass(Class<U> clazz) Get the "true" domain class for a given class, i.e.
static <T,U extends T> Class<T>	getDomainClass(U domainObject) Get the "true" domain class for a given domainObject, i.e.
static <T,U extends T> Class<T>	getDomainSuperClass(Class<U> clazz) Get the domain super class for the given class, or null if no such class exists.
static Serializable	getLockFlag(Object domainObject) Gets the lock flag property of the domain object.
static boolean	hasLockFlag(Object domainObject) Test whether an object has a "lockFlag" field or not.
static boolean	isLazy(Object o) Checks if the object in question is not initialized.
static boolean	isLazy(Set<? extends Object> s) Checks if the Set in question contains un-initialized lazy objects.
static void	setLockFlag(Object domainObject, Serializable lockFlag) Sets the lock flag property on the domain object.
static <T,U extends T> U	strip(U domainObject, Class<T> domainClass, Set<String> ignore) Strips the specified domain object.
static void	stripRecursive(Object domainObject, Object parent) Strips the specified domain object recursively, i.e.

Methods inherited from class java.lang.Object

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

Method Detail

getDomainClass

public static <T,U extends T> Class<T> getDomainClass(U domainObject)

Get the "true" domain class for a given domainObject, i.e. avoid Hibernate proxy classes etc.

Type Parameters:

T - The domain object (super) class

U - The domain object type.

Parameters:

domainObject - The domain object to get the class from

Returns:

The domain object class.

getDomainClass

public static <T,U extends T> Class<T> getDomainClass(Class<U> clazz)

Get the "true" domain class for a given class, i.e. avoid Hibernate proxy classes etc.

Type Parameters:

T - The domain object super class.

U - The domain object class (possibly hibernate proxy).

Parameters:

clazz - The domain object class

Returns:

The true domain object class.

getDomainSuperClass

public static <T,U extends T> Class<T> getDomainSuperClass(Class<U> clazz)

Get the domain super class for the given class, or null if no such class exists.

Type Parameters:

T - The domain object super class

U - The domain object class

Parameters:

clazz - The domain object class

Returns:

The closest super class of the specified domain class or null if the super class is an Object.

hasLockFlag

public static boolean hasLockFlag(Object domainObject)

Test whether an object has a "lockFlag" field or not. If the g9.config.property file has a property "DomainUtil.ignoreLockFlag" with the value "true" or "1", the return value is always false.

Parameters:

domainObject - the object to test

Returns:

true if the specified object has a lock flag.

getLockFlag

public static Serializable getLockFlag(Object domainObject)

Gets the lock flag property of the domain object. If the domain object does not have a lock flag, null is returned. Gets the lock flag property of the domain object. If the domain object does not have a lock flag, null is returned.

Parameters:

domainObject - (missing javadoc)

Returns:

(missing javadoc)

setLockFlag

public static void setLockFlag(Object domainObject,
                               Serializable lockFlag)

Sets the lock flag property on the domain object. If the domain object does not have a lock flag, no action is taken. Sets the lock flag property on the domain object. If the domain object does not have a lock flag, no action is taken.

Parameters:

domainObject - (missing javadoc)

lockFlag - (missing javadoc)

equalsLockFlag

public static boolean equalsLockFlag(Serializable flag1,
                                     Serializable flag2)

Return true if two lockFlags are equal

Parameters:

flag1 - (missing javadoc)

flag2 - (missing javadoc)

Returns:

true if two lockFlags are equal

isLazy

public static boolean isLazy(Object o)

Checks if the object in question is not initialized.

Parameters:

o - the object to check

Returns:

true if the object is not initialized.

isLazy

public static boolean isLazy(Set<? extends Object> s)

Checks if the Set in question contains un-initialized lazy objects.

Parameters:

s - the Set to check

Returns:

true if the set contains un-initialized objects.

strip

public static <T,U extends T> U strip(U domainObject,
                                      Class<T> domainClass,
                                      Set<String> ignore)

Strips the specified domain object. All fields in the domain object are accessed (using reflection and a bean-style get-method, e.g. getFoo()) and tested for the following conditions:

1. The field name is not in the set of fields to ignore.
2. The field value is a (direct or indirect) sub-class of PersistentClass.

If both conditions are met, the field value is set to null (again using reflection and a bean-style set-method, e.g. setFoo(null).

Note:All exceptions that are caught as part of the reflective access to the domain object are wrapped in a G9BaseException and re-thrown.

Type Parameters:

T - The domain object (super) class

U - The domain object type

Parameters:

domainObject - the domain object to strip

domainClass - the declared domain object class

ignore - the set of relation-names to ignore when stripping.

Returns:

the striped domain object.

stripRecursive

public static void stripRecursive(Object domainObject,
                                  Object parent)

Strips the specified domain object recursively, i.e. strip the domain object and all domain objects which are referenced from this object. All fields in the domain object are accessed (using reflection and a bean-style get-method, e.g. getFoo()) and tested for the following condition:

1. The field value is a (direct or indirect) sub-class of PersistentClass.

If the condition is met, the field is accessed by invoking its get-method. If this causes a Hibernate LazyInitializationException, either directly or via an InvocationTargetException, the field value is set to null (again using reflection and a bean-style set-method, e.g. setFoo(null).

Note:All exceptions except those mentioned above that are caught as part of the reflective access to the domain object are wrapped in a G9BaseException and re-thrown.

Parameters:

domainObject - - the object to strip recursively

parent - - the parent object, avoided when traversing the object graph recursively