dochelper.TableRecord Class Reference

Inheritance diagram for dochelper.TableRecord:

Inheritance graph
[legend]
Collaboration diagram for dochelper.TableRecord:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 TableRecord (HashMap fieldValues)
 Creates a new instance of TableRecord.
 TableRecord (HashMap fieldValues, HashMap fullFieldValues, String name)
 Creates a New Instance of a Table Record, given a set of values and a Document Section.
ResultNode execute (ArrayList< DocPattern > patterns)
 Renders a record using the specified Pattern list.
String getValue ()
 Return the string value of this record.

Protected Attributes

HashMap _fieldValues
 HashMap containing each field within this Record (Row) and its value.
HashMap _fullFieldValues
 HashMap containing each field within this Record (Row) and its value.
String _name
 HashMap containing each field within this Record (Row) and its value.


Detailed Description

Author:
gchristen

Definition at line 20 of file TableRecord.java.


Constructor & Destructor Documentation

dochelper.TableRecord.TableRecord ( HashMap  fieldValues  ) 

Creates a new instance of TableRecord.

Parameters:
fieldValues 

Definition at line 37 of file TableRecord.java.

dochelper.TableRecord.TableRecord ( HashMap  fieldValues,
HashMap  fullFieldValues,
String  name 
)

Creates a New Instance of a Table Record, given a set of values and a Document Section.

Parameters:
fieldValues hashMap containing field names and field values for Searched Fields
fullFieldValues HashMap containing all field names and its values
name 

Definition at line 52 of file TableRecord.java.


Member Function Documentation

ResultNode dochelper.TableRecord.execute ( ArrayList< DocPattern patterns  ) 

Renders a record using the specified Pattern list.

This method will iterate through all patterns passed in if any, and execute the pattern passing the contents of the row this record represents.

In this case the value of the record will not be fetched using getValue. It will be fetched directly from the fieldValues has map.

Returns:
String containing the contents of the pattern rendering and the encapsulation.

Implements dochelper.Record.

Definition at line 72 of file TableRecord.java.

Here is the call graph for this function:

String dochelper.TableRecord.getValue (  ) 

Return the string value of this record.

For table record sets this value is not used as the string to search against. Each field in a row is checked indiidually.

Returns:
String value of the entire record.

Implements dochelper.Record.

Definition at line 98 of file TableRecord.java.


Member Data Documentation

HashMap containing each field within this Record (Row) and its value.

Definition at line 25 of file TableRecord.java.

HashMap containing each field within this Record (Row) and its value.

Definition at line 28 of file TableRecord.java.

String dochelper.TableRecord._name [protected]

HashMap containing each field within this Record (Row) and its value.

Definition at line 31 of file TableRecord.java.


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

Generated on Wed Jun 17 14:22:15 2009 for DocHelper by  doxygen 1.5.6