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

com.gentleware.poseidon.generator

Class PreparedElement


public abstract class PreparedElement

Represents the object that prepares the template code generation.
See also:
OtherClasses


 Method Summary
public Map   callElementMethod(String method , Map parameters )
Calls a method on the content element. 
public String   check()
Does a test on the validity of the element. 
protected String   checkName()
Does a test on the validity of the element's name. 
public String   getDocs()
Returns the documentation for the prepared element. 
public Object   getElement()
Returns the element related to this prepared element. 
public String   getNameAsString(String prefix , String postfix )
Returns the customized name of the related element. 
public static String   getNameAsString(String name )
Returns the name of the related element. 
public String   getNameAsString()
Returns the name of the related element. 
public String   getNameOfElementAsString(Object element )
Returns a string with the element's name, ready for insertion into generated code. 
public String   getNameWithUpperCaseBegin()
Returns the name of the related element with the first character converted to upper case. 
public String   getParsedDocs()
Returns the documentation for the prepared element. 
public String   getPath(boolean includeModel , boolean includeSelf , String fileSeparator )
Builds and returns the file system path to a file representing the element related to this prepared element. 
public String   getPathAsString(boolean includeModel , boolean includeSelf )
Builds and returns the file system path to a file representing the element related to this prepared element. 
protected ElementPreparator   getPreparator()
Returns the preparator used to handle this prepared element. 
public PreparedElement   getPreparedParent()
Returns the parent element of this. 
public void   setElement(Object element )
Sets the element related to this prepared element. 
protected void   setPreparator( ElementPreparator preparator )
Sets the preparator used to handle this prepared element. 
arrow_up
 

 

 Method Detail

callElementMethod

public Map callElementMethod(String method , Map parameters )

Calls a method on the content element. Used for passing on getter methods from the context.
Parameters:
method - The name of the method to call on the content object.
parameters - The parameters of the method call, mapping from parameter classes to values.
Returns:
A Map with 0 or 1 entry mapping the type of the return value to the return value.
 
arrow_up
 
 

check

public String check()

Does a test on the validity of the element.
Returns:
Concatenation of messages occuring while testing this prepared element.
 
arrow_up
 
 

checkName

protected String checkName()

Does a test on the validity of the element's name.
Returns:
Concatenation of message occuring while testing the element's name.
 
arrow_up
 
 

getDocs

public String getDocs()

Returns the documentation for the prepared element.
Returns:
The complete documentation for the related element as one string.
 
arrow_up
 
 

getElement

public Object getElement()

Returns the element related to this prepared element.
Returns:
The element, this prepared element is related to.
 
arrow_up
 
 

getNameAsString

public String getNameAsString(String prefix , String postfix )

Returns the customized name of the related element.
Parameters:
prefix - A string to be used as prefix to the element's name.
postfix - A string to be used as postfix to the element's name.
Returns:
The customized name of the element with prefix+getNameofElementAsString+postfix.
 
arrow_up
 
 

getNameAsString

public static String getNameAsString(String name )

Returns the name of the related element. Appearances of whitespaces will be replaced by "_".
Parameters:
name - A String that you would like to have formatted.
Returns:
The parameter with leading and trailing blanks removed, spaces replaces by underscores.
 
arrow_up
 
 

getNameAsString

public String getNameAsString()

Returns the name of the related element. return The name of the element. 
arrow_up
 
 

getNameOfElementAsString

public String getNameOfElementAsString(Object element )

Returns a string with the element's name, ready for insertion into generated code.
Parameters:
element - The element, the name should be returned for.
Returns:
The insertion ready name of the element.
 
arrow_up
 
 

getNameWithUpperCaseBegin

public String getNameWithUpperCaseBegin()

Returns the name of the related element with the first character converted to upper case.
Returns:
The name of the related element beginning with an upper case character.
 
arrow_up
 
 

getParsedDocs

public String getParsedDocs()

Returns the documentation for the prepared element.
Returns:
The complete documentation for the related element as one string.
 
arrow_up
 
 

getPath

public String getPath(boolean includeModel , boolean includeSelf , String fileSeparator )

Builds and returns the file system path to a file representing the element related to this prepared element.
Parameters:
includeModel - Should the name of the model itself be part of this path.
includeSelf - Should the name of the element itself be part of this path.
fileSeparator - The string that should be used as separator for this path.
Returns:
The complete path to the file.
 
arrow_up
 
 

getPathAsString

public String getPathAsString(boolean includeModel , boolean includeSelf )

Builds and returns the file system path to a file representing the element related to this prepared element. The os-dependent default setting for the file separator is used.
Parameters:
includeModel - Should the name of the model itself be part of this path.
includeSelf - Should the name of the element itself be part of this path.
Returns:
The complete path to the file.
 
arrow_up
 
 

getPreparator

protected ElementPreparator getPreparator()

Returns the preparator used to handle this prepared element.
Returns:
The preparator handling this prepared element.
 
arrow_up
 
 

getPreparedParent

public PreparedElement getPreparedParent()

Returns the parent element of this.
Returns:
The prepared element representing the parent.
 
arrow_up
 
 

setElement

public void setElement(Object element )

Sets the element related to this prepared element.
Parameters:
element - The element, this prepared element should be related to.
 
arrow_up
 
 

setPreparator

protected void setPreparator( ElementPreparator preparator )

Sets the preparator used to handle this prepared element.
Parameters:
preparator - The preparator handling this prepared element.
 
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.