dochelper
Interface Record

All Known Implementing Classes:

FileRecord, TableRecord, URLRecord, XINSFunctionRecord

public interface Record

The interface Record defines the members an class must implement in order to be utlizied as a Record within DocHelper RecordSets.

See Also:

RecordSet, DocumentSection

Method Summary

ResultNode	execute(java.util.ArrayList<DocPattern> patterns) Renders a record using the specified Pattern list.
java.lang.String	getValue() Return the string value of this record that should be used to match patterns against.

Method Detail

getValue

java.lang.String getValue()

Return the string value of this record that should be used to match patterns against.

Returns:

String value of the entire record.

execute

ResultNode execute(java.util.ArrayList<DocPattern> patterns)

Renders a record using the specified Pattern list. This method will attempt to find all matches of the regular expression defined in each of the DocPatterns to the value of this record.

Parameters:

patterns - ArrayList list of pattern that should be used during the rendering process for this record.

Returns:

ResultNode containing the ResultNode sub tree created by rendering this Record given the passed in patterns.