jadex.commons.transformation.traverser

Class Traverser

java.lang.Object

jadex.commons.transformation.traverser.Traverser

public class Traverser
extends java.lang.Object

The traverser allows to traverse an object graph deeply. Traversal processors can be used to perform specific actions on traversed object, e.g. object modifications. Does currently not allow transforming objects to other objects of another type (replacements), because objects have to be saved in the graph itself (no extra table for exchanged objects). The traverser can be used as a cloner when processors always return copies of the original objects. todo: introduce classloaders to allows for creating objects with other classloaders (e.g. convert a parameter from a sender to a receiver resource id).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	IGNORE_RESULT
protected static Traverser	instance The default cloner.
protected java.util.Map<java.lang.Class<?>,ITraverseProcessor>	processorcache
protected static java.util.List<ITraverseProcessor>	processors The default traversal processors with no special actions.

Constructor Summary

Constructors

Constructor and Description
Traverser()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	doTraverse(java.lang.Object object, java.lang.reflect.Type type, java.util.Map<java.lang.Object,java.lang.Object> traversed, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.ClassLoader targetcl, java.lang.Object context) Traverse an object.
protected java.lang.Class<?>	findClazz(java.lang.Object object, java.lang.ClassLoader cl) Find the class of an object.
static java.util.List<ITraverseProcessor>	getDefaultProcessors() Get the default traversal processors.
static Traverser	getInstance() Get the default cloner instance.
void	handleDuplicate(java.lang.Object object, java.lang.Class<?> clazz, java.lang.Object match, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.Object context) Special handling for duplicate objects.
java.lang.Object	handleNull(java.lang.Class<?> clazz, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.Object context) Special handling for null objects.
java.lang.Object	traverse(java.lang.Object object, java.lang.Class<?> clazz, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.ClassLoader targetcl, java.lang.Object context) Traverse an object.
java.lang.Object	traverse(java.lang.Object object, java.lang.Class<?> clazz, java.util.List<ITraverseProcessor> processors, java.lang.ClassLoader targetcl, java.lang.Object context) Traverse an object.
java.lang.Object	traverse(java.lang.Object object, java.lang.reflect.Type clazz, java.util.Map<java.lang.Object,java.lang.Object> traversed, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.ClassLoader targetcl, java.lang.Object context) Traverse an object.
static java.lang.Object	traverseObject(java.lang.Object object, java.lang.Class<?> clazz, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.ClassLoader targetcl, java.lang.Object context) Traverse an object.
static java.lang.Object	traverseObject(java.lang.Object object, java.lang.Class<?> clazz, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.Object context) Traverse an object.
static java.lang.Object	traverseObject(java.lang.Object object, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.ClassLoader targetcl, java.lang.Object context) Traverse an object.
static java.lang.Object	traverseObject(java.lang.Object object, java.util.List<ITraverseProcessor> processors, boolean clone, java.lang.Object context) Traverse an object.

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_RESULT

public static final java.lang.Object IGNORE_RESULT

instance

protected static volatile Traverser instance

The default cloner.

processors

protected static final java.util.List<ITraverseProcessor> processors

The default traversal processors with no special actions.

processorcache

protected java.util.Map<java.lang.Class<?>,ITraverseProcessor> processorcache

Constructor Detail

Traverser

public Traverser()

Method Detail

getDefaultProcessors

public static java.util.List<ITraverseProcessor> getDefaultProcessors()

Get the default traversal processors.

Returns:

The traversal processors.

getInstance

public static Traverser getInstance()

Get the default cloner instance.

traverseObject

public static java.lang.Object traverseObject(java.lang.Object object,
                                              java.util.List<ITraverseProcessor> processors,
                                              boolean clone,
                                              java.lang.Object context)

Traverse an object.

Parameters:

object - The object to traverse.

processors - The lists of processors.

Returns:

The traversed (or modified) object.

traverseObject

public static java.lang.Object traverseObject(java.lang.Object object,
                                              java.util.List<ITraverseProcessor> processors,
                                              boolean clone,
                                              java.lang.ClassLoader targetcl,
                                              java.lang.Object context)

Traverse an object.

Parameters:

object - The object to traverse.

processors - The lists of processors.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The traversed (or modified) object.

traverseObject

public static java.lang.Object traverseObject(java.lang.Object object,
                                              java.lang.Class<?> clazz,
                                              java.util.List<ITraverseProcessor> processors,
                                              boolean clone,
                                              java.lang.Object context)

Traverse an object.

Parameters:

object - The object to traverse.

processors - The lists of processors.

Returns:

The traversed (or modified) object.

traverseObject

public static java.lang.Object traverseObject(java.lang.Object object,
                                              java.lang.Class<?> clazz,
                                              java.util.List<ITraverseProcessor> processors,
                                              boolean clone,
                                              java.lang.ClassLoader targetcl,
                                              java.lang.Object context)

Traverse an object.

Parameters:

object - The object to traverse.

processors - The lists of processors.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The traversed (or modified) object.

traverse

public java.lang.Object traverse(java.lang.Object object,
                                 java.lang.Class<?> clazz,
                                 java.util.List<ITraverseProcessor> processors,
                                 java.lang.ClassLoader targetcl,
                                 java.lang.Object context)

Traverse an object.

Parameters:

object - The object.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The processed object.

traverse

public java.lang.Object traverse(java.lang.Object object,
                                 java.lang.Class<?> clazz,
                                 java.util.List<ITraverseProcessor> processors,
                                 boolean clone,
                                 java.lang.ClassLoader targetcl,
                                 java.lang.Object context)

Traverse an object.

Parameters:

object - The object.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The processed object.

traverse

public java.lang.Object traverse(java.lang.Object object,
                                 java.lang.reflect.Type clazz,
                                 java.util.Map<java.lang.Object,java.lang.Object> traversed,
                                 java.util.List<ITraverseProcessor> processors,
                                 boolean clone,
                                 java.lang.ClassLoader targetcl,
                                 java.lang.Object context)

Traverse an object.

Parameters:

object - The object.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The processed object.

doTraverse

public java.lang.Object doTraverse(java.lang.Object object,
                                   java.lang.reflect.Type type,
                                   java.util.Map<java.lang.Object,java.lang.Object> traversed,
                                   java.util.List<ITraverseProcessor> processors,
                                   boolean clone,
                                   java.lang.ClassLoader targetcl,
                                   java.lang.Object context)

Traverse an object.

Parameters:

object - The object.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The processed object.

findClazz

protected java.lang.Class<?> findClazz(java.lang.Object object,
                                       java.lang.ClassLoader cl)

Find the class of an object.

Parameters:

object - The object.

cl - The classloader.

Returns:

The objects class.

handleDuplicate

public void handleDuplicate(java.lang.Object object,
                            java.lang.Class<?> clazz,
                            java.lang.Object match,
                            java.util.List<ITraverseProcessor> processors,
                            boolean clone,
                            java.lang.Object context)

Special handling for duplicate objects.

handleNull

public java.lang.Object handleNull(java.lang.Class<?> clazz,
                                   java.util.List<ITraverseProcessor> processors,
                                   boolean clone,
                                   java.lang.Object context)

Special handling for null objects.