org.pf.tools.cda.xpi
Class AModelObjectVisitor

java.lang.Object
  extended by org.pf.tools.cda.xpi.AModelObjectVisitor
Direct Known Subclasses:
AModelExporter

public abstract class AModelObjectVisitor
extends java.lang.Object

Abstract definition of an object that gets called for all elements of the object model hierarchy.

Version:
1.1
Author:
M.Duchrow

Constructor Summary
AModelObjectVisitor()
          Initialize the new instance with default values.
 
Method Summary
 boolean finishContainer(IContainer container)
          Will be called when process of the specified container can be finished.
 boolean finishContext(IExplorationContext context)
          Will be called when process of the specified context can be finished.
 boolean finishModelObject(IExplorationModelObject modelObject)
          Will be called when the object model visiting is finished.
 boolean finishNamespace(INamespace namespace)
          Will be called when process of the specified namespace can be finished.
 boolean finishType(IType type)
          Will be called when process of the specified type can be finished.
 boolean startContainer(IContainer container)
          Will be called to process the specified container.
 boolean startContext(IExplorationContext context)
          Will be called to process the specified context.
 boolean startModelObject(IExplorationModelObject modelObject)
          Will be called to process the specified model object.
 boolean startNamespace(INamespace namespace)
          Will be called to process the specified namespace.
 boolean startType(IType type)
          Will be called to process the specified type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AModelObjectVisitor

public AModelObjectVisitor()
Initialize the new instance with default values.

Method Detail

startContext

public boolean startContext(IExplorationContext context)
Will be called to process the specified context. After processing all children of the context eventually finishContext() gets called.

Parameters:
context - The context to process
Returns:
true if processing may continue otherwise false
See Also:
finishContext(IExplorationContext)

finishContext

public boolean finishContext(IExplorationContext context)
Will be called when process of the specified context can be finished. This method always corresponds to a formerly called startContext().

Parameters:
context - The context that was processed
Returns:
true if processing may continue otherwise false
See Also:
startContext(IExplorationContext)

startContainer

public boolean startContainer(IContainer container)
Will be called to process the specified container. After processing all children of the container eventually finishContainer() gets called.

Parameters:
container - The container to process
Returns:
true if processing may continue otherwise false
See Also:
finishContainer(IContainer)

finishContainer

public boolean finishContainer(IContainer container)
Will be called when process of the specified container can be finished. This method always corresponds to a formerly called startContainer().

Parameters:
container - The container that was processed
Returns:
true if processing may continue otherwise false
See Also:
startContainer(IContainer)

startNamespace

public boolean startNamespace(INamespace namespace)
Will be called to process the specified namespace. After processing all children of the namespace eventually finishNamespace() gets called.

Parameters:
namespace - The namespace to process
Returns:
true if processing may continue otherwise false
See Also:
finishNamespace(INamespace)

finishNamespace

public boolean finishNamespace(INamespace namespace)
Will be called when process of the specified namespace can be finished. This method always corresponds to a formerly called startNamespace().

Parameters:
namespace - The namespace that was processed
Returns:
true if processing may continue otherwise false
See Also:
startNamespace(INamespace)

startType

public boolean startType(IType type)
Will be called to process the specified type. After processing all children of the type eventually finishType() gets called.

Parameters:
type - The type to process
Returns:
true if processing may continue otherwise false
See Also:
finishType(IType)

finishType

public boolean finishType(IType type)
Will be called when process of the specified type can be finished. This method always corresponds to a formerly called startType().

Parameters:
type - The class that was processed
Returns:
true if processing may continue otherwise false
See Also:
startType(IType)

startModelObject

public boolean startModelObject(IExplorationModelObject modelObject)
Will be called to process the specified model object. Actually this is just a dispatcher method that delegates processing to the appropriate startXXXX() method according to the given model object's class.

Parameters:
modelObject - The model object to process
Returns:
true if processing may continue otherwise false

finishModelObject

public boolean finishModelObject(IExplorationModelObject modelObject)
Will be called when the object model visiting is finished. This method identifies the type of the given object and dispatches then to one of the typed methods (e.g. finishWorkset() or finishClass()).

Parameters:
modelObject - The model object to identify and to dispatch to the appropriate method
Returns:
true if visiting may continue, otherwise false