dochelper.FileTransformDefinition Class Reference

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

Inheritance diagram for dochelper.FileTransformDefinition:

[legend]

Collaboration diagram for dochelper.FileTransformDefinition:

[legend]

List of all members.

Public Member Functions
	FileTransformDefinition (File file) throws InitializationException
	Creates a new instance of FileRenderDefinition.
	FileTransformDefinition (String path) throws InitializationException
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 FileRenderDefinition implements the RenderDefinition interface and is used as the simplest manner in which to render DocPattern matches.

Author:

Guillermo Christen

Definition at line 25 of file FileTransformDefinition.java.

---

Constructor & Destructor Documentation

dochelper.FileTransformDefinition.FileTransformDefinition

(

File

file

)

throws InitializationException

Creates a new instance of FileRenderDefinition.

Parameters:

file

Exceptions:

InitializationException

Definition at line 33 of file FileTransformDefinition.java.

dochelper.FileTransformDefinition.FileTransformDefinition

(

String

path

)

throws InitializationException

Parameters:

path

Exceptions:

dochelper.exceptions.InitializationException

Definition at line 47 of file FileTransformDefinition.java.

---

Member Function Documentation

String dochelper.FileTransformDefinition.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.

Definition at line 72 of file FileTransformDefinition.java.

Here is the call graph for this function:

String dochelper.FileTransformDefinition.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 94 of file FileTransformDefinition.java.

Here is the caller graph for this function:

---

Member Data Documentation

final String dochelper.FileTransformDefinition.TEXT [private]

Definition at line 27 of file FileTransformDefinition.java.

---

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

• src/dochelper/FileTransformDefinition.java