dochelper.RecordSet Interface Reference

The interface RecordSet defines how a class that should be used as a RecordSet within DocHelper should behave. More...

Inheritance diagram for dochelper.RecordSet:

[legend]

Collaboration diagram for dochelper.RecordSet:

[legend]

List of all members.

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

---

Detailed Description

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.

Author:

Guillermo Christen

Definition at line 23 of file RecordSet.java.

---

Member Function Documentation

ResultNode dochelper.RecordSet.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.

Exceptions:

	ResourceUnavailableException
	Exception

Implemented in dochelper.AbstractTableRecordSet, dochelper.FileRecordSet, and dochelper.URLRecordSet.

Here is the caller graph for this function:

void dochelper.RecordSet.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.

Implemented in dochelper.AbstractTableRecordSet, dochelper.FileRecordSet, and dochelper.URLRecordSet.

Here is the caller graph for this function:

void dochelper.RecordSet.clearPatterns

(

)

Clear all of the patterns.

Leaves the record set with no patterns assigned.

Implemented in dochelper.AbstractTableRecordSet, dochelper.FileRecordSet, and dochelper.URLRecordSet.

Here is the caller graph for this function:

void dochelper.RecordSet.setName

(

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

Implemented in dochelper.AbstractTableRecordSet, dochelper.FileRecordSet, and dochelper.URLRecordSet.

Here is the caller graph for this function:

---

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

• src/dochelper/RecordSet.java