Poseidon for UMLTM
  UMLdoc
 PREV      NEXT       FRAMES    NO FRAMES      

com.gentleware.poseidon.generator

Interface ElementPreparator


public interface ElementPreparator
has stereotype << interface >>

Defines the interface for a preparator of element information. The preparator uses element preparation classes to prepare and check the information contained in the element. The preparation eases the use of element information from the template. It move navigation and manipulation logic from the the templates or macros to the element preparation classes.
See also:
PreparedElement
ElementPreparatorImpl


 Association Summary
public PreparedElement  preparedElement
 
arrow_up
 

 Method Summary
public void   addExternalElementClasses(String origin , Map elementClasses )
Adds a map of externally known element preparation classes associated to their origin. 
public void   addPreparedElement(Object element , PreparedElement prepared )
Adds a prepared element and maps it to the element it is created for. 
public void   addPreparedElementClass(Class elementClass , Class preparationClass )
Adds a new entry to the list of element preparation classes. 
public String   check(Object element )
Checks the prepared information for the given element for consistency. 
public boolean   checkEnabled()
Tests if checking the prepared element information is enabled for this ElementPreparator instance. 
public PreparedElement   getPreparedElement(Object element )
Returns the prepared element for the given element. 
public Class   getPreparedElementClass(Class elementClass )
Returns the element preparation classes associated with the given element class. 
public Map   getPreparedElementClassMap()
Returns the map of known element preparation classes. 
public PreparedElement   getPreparedElementInstance(Class elementClass )
Returns a new instance of the element preparation classes associated with the given element class. 
public Map   getPreparedElements()
Returns all prepared elements prepared by this ElementPreparator instance. 
public void   init()
Initializes the ElementPreparator instance. 
public PreparedElement   prepare(Object element )
Starts preparation of an element. 
public void   reloadPreparedElementClasses()
Forces the reinitialization of the list of element preparation classes. 
public void   removeExternalElementClasses(String origin )
Removes the map of externally known element preparation classes associated to the given origin. 
public void   setCheckEnabled(boolean value )
Sets the checking state of this ElementPreparator isntance. 
public void   setExternalPreparationClassStrategy( ExternalEntryStrategy strategy )
Set the strategy used to decide how to handle external element preparation classes. 
arrow_up
 

 

 Association Detail

preparedElement

public PreparedElement preparedElement

 
arrow_up
 

 Method Detail

addExternalElementClasses

public void addExternalElementClasses(String origin , Map elementClasses )

Adds a map of externally known element preparation classes associated to their origin. The element preparation classes arre associated to element classes, while the resulting map is associated to the adding plugin.
Parameters:
origin - Name of the adding plugin.
elementClasses - Map of element preparation classes associated with element classes.
 
arrow_up
 
 

addPreparedElement

public void addPreparedElement(Object element , PreparedElement prepared )

Adds a prepared element and maps it to the element it is created for.
Parameters:
element - The element, the prepared element is created for.
prepared - The prepared element created for the given element.
 
arrow_up
 
 

addPreparedElementClass

public void addPreparedElementClass(Class elementClass , Class preparationClass )

Adds a new entry to the list of element preparation classes.
Parameters:
elementClass - Element class the new entry should be valid for.
preparatorClass - Element preparator class to be used.
 
arrow_up
 
 

check

public String check(Object element )

Checks the prepared information for the given element for consistency.
Parameters:
element - The element to be checked.
Returns:
Concatenation of message occuring while checking the information.
 
arrow_up
 
 

checkEnabled

public boolean checkEnabled()

Tests if checking the prepared element information is enabled for this ElementPreparator instance.
Returns:
True, if checking is enabled, otherwise false.
 
arrow_up
 
 

getPreparedElement

public PreparedElement getPreparedElement(Object element )

Returns the prepared element for the given element.
Parameters:
element - The element, the prepared element should be returned for.
Returns:
The prepared element created for the given element.
 
arrow_up
 
 

getPreparedElementClass

public Class getPreparedElementClass(Class elementClass )

Returns the element preparation classes associated with the given element class.
Parameters:
elementClass - Element class to return the prepared element class for.
Returns:
The element preparation classes associated with the given element classes.
 
arrow_up
 
 

getPreparedElementClassMap

public Map getPreparedElementClassMap()

Returns the map of known element preparation classes. Each element preparation class is mapped the element class it is intended for.
Returns:
The map of element preparation classes mapped to element classes.
 
arrow_up
 
 

getPreparedElementInstance

public PreparedElement getPreparedElementInstance(Class elementClass )

Returns a new instance of the element preparation classes associated with the given element class.
Parameters:
elementClass - Element class to create a new prepared element instance for.
Returns:
The instance of element preparation classes associated with the given element classes.
 
arrow_up
 
 

getPreparedElements

public Map getPreparedElements()

Returns all prepared elements prepared by this ElementPreparator instance. The prepared elements are mapped to their information providing elements.
Returns:
Map containing all prepared elements with their information providing elements as key.
 
arrow_up
 
 

init

public void init()

Initializes the ElementPreparator instance. 
arrow_up
 
 

prepare

public PreparedElement prepare(Object element )

Starts preparation of an element. It looks for the appropriate element preparation class and creates an instance of it. The returned PreparedElement instance contains the already prepared information about the given element.
Parameters:
element - Elment to be prepared
Returns:
PreparedElement instance that holds the prepared information.
 
arrow_up
 
 

reloadPreparedElementClasses

public void reloadPreparedElementClasses()

Forces the reinitialization of the list of element preparation classes. 
arrow_up
 
 

removeExternalElementClasses

public void removeExternalElementClasses(String origin )

Removes the map of externally known element preparation classes associated to the given origin.
Parameters:
origin - Name of the adding plugin.
 
arrow_up
 
 

setCheckEnabled

public void setCheckEnabled(boolean value )

Sets the checking state of this ElementPreparator isntance.
Parameters:
value - The new state to be set.
 
arrow_up
 
 

setExternalPreparationClassStrategy

public void setExternalPreparationClassStrategy( ExternalEntryStrategy strategy )

Set the strategy used to decide how to handle external element preparation classes.
Parameters:
strategy - The strategy containing the decision implementation.
 
arrow_up
 

Created  2003 - 3 - 4

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2001 Gentleware AG, Vogt-Kölln-Str.30, 22527 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.