org.nuiton.topia.persistence

Class DepthEntityVisitor

java.lang.Object

org.nuiton.topia.persistence.DepthEntityVisitor

All Implemented Interfaces:

TopiaEntityVisitor

Direct Known Subclasses:

Collector.CollectorVisitor

public class DepthEntityVisitor
extends Object
implements TopiaEntityVisitor

Visitor to run through the entity graph by depth.

Author:

Éric Chatellier - chatellier@codelutin.com, Tony Chemit - tchemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<TopiaEntity>	alreadyExplored Cache of already explored entities.
protected TopiaEntityVisitor	delegateVisitor The business visitor (optional)

Constructor Summary

Constructors

Constructor and Description
DepthEntityVisitor()
DepthEntityVisitor(TopiaEntityVisitor delegateVisitor)

Method Summary

Modifier and Type	Method and Description
void	clear() Reset all states of the visitor.
void	end(TopiaEntity e) Ends the visit of the given entity.
void	start(TopiaEntity e) Start the visit of the given entity.
void	visit(TopiaEntity e, String propertyName, Class<?> collectionType, Class<?> type, int index, Object value) Visit a indexed value from a collection property for the given entity.
void	visit(TopiaEntity e, String propertyName, Class<?> collectionType, Class<?> type, Object value) Visit a collection property for the given entity.
void	visit(TopiaEntity e, String propertyName, Class<?> type, Object value) Visit a none indexed property for the given entity.

Methods inherited from class java.lang.Object

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

Field Detail

alreadyExplored

protected Collection<TopiaEntity> alreadyExplored

Cache of already explored entities.

delegateVisitor

protected TopiaEntityVisitor delegateVisitor

The business visitor (optional)

Constructor Detail

DepthEntityVisitor

public DepthEntityVisitor()

DepthEntityVisitor

public DepthEntityVisitor(TopiaEntityVisitor delegateVisitor)

Method Detail

start

public void start(TopiaEntity e)

Description copied from interface: TopiaEntityVisitor

Start the visit of the given entity.

Specified by:

start in interface TopiaEntityVisitor

Parameters:

e - the visited entity

visit

public void visit(TopiaEntity e,
                  String propertyName,
                  Class<?> type,
                  Object value)

Description copied from interface: TopiaEntityVisitor

Visit a none indexed property for the given entity. The property visited is defined by the other parameters.

Specified by:

visit in interface TopiaEntityVisitor

Parameters:

e - the visited entity

propertyName - the name of the visited property

type - the type of the visited property

value - the value of the visited property

visit

public void visit(TopiaEntity e,
                  String propertyName,
                  Class<?> collectionType,
                  Class<?> type,
                  Object value)

Description copied from interface: TopiaEntityVisitor

Visit a collection property for the given entity. The property visited is defined by the other parameters.

Specified by:

visit in interface TopiaEntityVisitor

Parameters:

e - the visited entity

propertyName - the name of the visited property

collectionType - the type of the visited collection

type - the type of the visited property

value - the value of the visited property

visit

public void visit(TopiaEntity e,
                  String propertyName,
                  Class<?> collectionType,
                  Class<?> type,
                  int index,
                  Object value)

Description copied from interface: TopiaEntityVisitor

Visit a indexed value from a collection property for the given entity. The property visited is defined by the other parameters.

Specified by:

visit in interface TopiaEntityVisitor

Parameters:

e - the visited entity

propertyName - the name of the visited property

collectionType - the type of the container of the visited property

type - the type of the visited property

index - the index of the visited property in his container

value - the value of the visited property

end

public void end(TopiaEntity e)

Description copied from interface: TopiaEntityVisitor

Ends the visit of the given entity.

Specified by:

end in interface TopiaEntityVisitor

Parameters:

e - the visited entity

clear

public void clear()

Description copied from interface: TopiaEntityVisitor

Reset all states of the visitor. If you use internal states inside the visitor, this method should clean all of them. This method should be invoked after usage of the visitor.

Specified by:

clear in interface TopiaEntityVisitor