dochelper.TransformDefinitionImpl Class Reference

The class RenderDefinitionImpl implements the RenderDefinition interface and is used as the simplest manner in which to render DocPattern matches. More...

Inheritance diagram for dochelper.TransformDefinitionImpl:

Inheritance graph
[legend]
Collaboration diagram for dochelper.TransformDefinitionImpl:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 TransformDefinitionImpl (String text)
 Creates a new instance of NodeDefinitionImpl.
String render (MatchResult result)
 Main method of RenderDefinition class.
String getText ()
 Retrieves the String template that will be used to render the matches.

Private Attributes

final String TEXT


Detailed Description

The class RenderDefinitionImpl implements the RenderDefinition interface and is used as the simplest manner in which to render DocPattern matches.

Author:
Guillermo Christen

Definition at line 21 of file TransformDefinitionImpl.java.


Constructor & Destructor Documentation

dochelper.TransformDefinitionImpl.TransformDefinitionImpl ( String  text  ) 

Creates a new instance of NodeDefinitionImpl.

Parameters:
text 

Definition at line 28 of file TransformDefinitionImpl.java.


Member Function Documentation

String dochelper.TransformDefinitionImpl.render ( MatchResult  result  ) 

Main method of RenderDefinition class.

This method is called to create the output content given a set of matches for a particular regular expression.

Once a DocPattern is executed, if it finds a set of matches (within the contents of the record) it will call the RenderDefinition associated with it, to render the matches.

Parameters:
result java.util.regex.MatchResult that contains the match results for a regular expression. It contains the whole match and separate groups.
Returns:
String containing the render result.

Implements dochelper.TransformDefinition.

Reimplemented in dochelper.xins.XINSCAPIPatternTransform.

Definition at line 47 of file TransformDefinitionImpl.java.

Here is the call graph for this function:

String dochelper.TransformDefinitionImpl.getText (  ) 

Retrieves the String template that will be used to render the matches.

Returns:
String containing template to be used to render matches.

Implements dochelper.TransformDefinition.

Definition at line 69 of file TransformDefinitionImpl.java.

Here is the caller graph for this function:


Member Data Documentation

Definition at line 23 of file TransformDefinitionImpl.java.


The documentation for this class was generated from the following file:

Generated on Wed Jun 17 14:22:16 2009 for DocHelper by  doxygen 1.5.6