dochelper.URLRecord Class Reference

Inheritance diagram for dochelper.URLRecord:

[legend]

Collaboration diagram for dochelper.URLRecord:

[legend]

List of all members.

Public Member Functions
	URLRecord (String url, String name) throws InvalidValueException
	Creates a new instance of URLRecord.
ResultNode	execute (ArrayList< DocPattern > patterns)
	Renders a record using the specified Pattern list.
URI	getURL ()
String	getValue ()
	Return the string value of this record.
boolean	equals (Object record)
	Equals operation.
Protected Attributes
URI	url
	String that contains the URL represented by this record.
String	value
	The HTML souce fetched from the URL.
String	name
	Name of this record.
HashMap< String, String >	_params
	The parameters associated to this URLRecord.
Static Package Attributes
static final HttpClient	httpClient = new DefaultHttpClient()
	A Default Http Client for all instance.

---

Detailed Description

Author:

gchristen

Definition at line 28 of file URLRecord.java.

---

Constructor & Destructor Documentation

dochelper.URLRecord.URLRecord	(	String	url,
		String	name
	)			throws InvalidValueException

Creates a new instance of URLRecord.

Parameters:

fieldValues

Definition at line 49 of file URLRecord.java.

---

Member Function Documentation

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

Parameters:

patterns

The ArrayList of DocPatterns to search in this record.

Returns:

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

Implements dochelper.Record.

Definition at line 72 of file URLRecord.java.

Here is the call graph for this function:

URI dochelper.URLRecord.getURL

(

)

Definition at line 89 of file URLRecord.java.

Here is the caller graph for this function:

String dochelper.URLRecord.getValue

(

)

Return the string value of this record.

For URL Records this means fetching the source HTML or the page as returned by a request to the URL this Record represents.

Returns:

String value of the entire record.

Implements dochelper.Record.

Definition at line 100 of file URLRecord.java.

Here is the caller graph for this function:

boolean dochelper.URLRecord.equals

(

Object

record

)

Equals operation.

A record is deemed equal if the URL are equal.

Parameters:

record

The URL Record to compare to

Returns:

Whether the URLRecord may be considered equal

Definition at line 139 of file URLRecord.java.

Here is the call graph for this function:

---

Member Data Documentation

URI dochelper.URLRecord.url [protected]

String that contains the URL represented by this record.

Definition at line 32 of file URLRecord.java.

String dochelper.URLRecord.value [protected]

The HTML souce fetched from the URL.

Definition at line 35 of file URLRecord.java.

String dochelper.URLRecord.name [protected]

Name of this record.

Definition at line 38 of file URLRecord.java.

HashMap<String, String> dochelper.URLRecord._params [protected]

The parameters associated to this URLRecord.

Definition at line 41 of file URLRecord.java.

final HttpClient dochelper.URLRecord.httpClient = new DefaultHttpClient() [static, package]

A Default Http Client for all instance.

Definition at line 44 of file URLRecord.java.

---

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

• src/dochelper/URLRecord.java