dochelper.Record Interface Reference

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

Inheritance diagram for dochelper.Record:

[legend]

List of all members.

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

---

Detailed Description

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

Author:

Guillermo Christen

Definition at line 21 of file Record.java.

---

Member Function Documentation

String dochelper.Record.getValue

(

)

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

Returns:

String value of the entire record.

Implemented in dochelper.FileRecord, dochelper.TableRecord, and dochelper.URLRecord.

ResultNode dochelper.Record.execute

(

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<DocPattern> 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.

Implemented in dochelper.FileRecord, dochelper.TableRecord, and dochelper.URLRecord.

---

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

• src/dochelper/Record.java