dochelper
Interface RecordSet

All Superinterfaces:

Configurable

All Known Implementing Classes:

AbstractTableRecordSet, FileRecordSet, JdbcTableRecordSet, URLRecordSet, XINSFunctionRecordSet

public interface RecordSet
extends Configurable

The interface RecordSet defines how a class that should be used as a RecordSet within DocHelper should behave. The generated Main.java file that drives the Documentation process depends on RecordSets heavily.

Method Summary

void	addPattern(DocPattern pattern) Add a pattern to be matched to the RecordSet.
void	clearPatterns() Clear all of the patterns.
ResultNode	execute(ResultNode doc) Main method of RecordSet.
void	setName(java.lang.String name) Set the name of this Record Set.

Methods inherited from interface dochelper.Configurable

checkParams, init, setParam

Method Detail

execute

ResultNode execute(ResultNode doc)
                   throws ResourceUnavailableException

Main method of RecordSet. This method should append to the document the output generated by interpreting this RecordSet. If the record set implementations may also implement the DocumentSection interface, if so the implementor should use the getSTART and getEND methods to encapsulate results. The results should be obtained by matching each pattern (n number of times )within value returned by Record getValue(). This should happen for each record in the RecordSet.

Parameters:

doc - The document onto which the results of running this record set should be appended to.

Returns:

The document with the results of the matches and rendering appended to it.

Throws:

ResourceUnavailableException

java.lang.Exception

addPattern

void addPattern(DocPattern pattern)

Add a pattern to be matched to the RecordSet.

Parameters:

pattern - Pattern that contains the regular expression and the Render Definition to process input into output.

clearPatterns

void clearPatterns()

Clear all of the patterns. Leaves the record set with no patterns assigned.

setName

void setName(java.lang.String name)

Set the name of this Record Set. The name of the Record Set is used in conjunction with items that use the name to fetch the appropriate part of the result tree. This includes renderers.

Parameters:

name -