dochelper
Interface TransformDefinition

All Known Implementing Classes:

DocPattern, EscapedMatchTransformDefinition, FileTransformDefinition, TransformDefinitionImpl, XINSCAPIPatternTransform

public interface TransformDefinition

The interface RenderDefinition defines how classes that are going to be utilized to Render DocPattern matches should behave.

Method Summary

java.lang.String	getText() Retrieves the String template that will be used to render the matches.
java.lang.String	render(java.util.regex.MatchResult result) Main method of RenderDefinition interface.

Method Detail

render

java.lang.String render(java.util.regex.MatchResult result)

Main method of RenderDefinition interface. This method is called for all RenderDefinitions 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.

getText

java.lang.String getText()

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

Returns:

String containing template to be used to render matches.