Harvest::Controller::GenericFilterNoState - generic filter class which doesn't have persisent state | |
| |
DESCRIPTION | |
Generic filter class - acts as a base class for all filter classes which don't require state to be stored across gatherer runs
| |
| $filter=new Filter::GenericFilterNoState $config | |
Create a new instance of the Generic filter. This should be used by filters which don't require the storage of state information. Filters taking arguments should override the constructor.
| |
| $newobjs=$filter->check($object) | |
Check to see if a given object can be fetched. The method returns a list of objects (which may, or may not include the original object) which it will allow fetches of. The Generic class provides a simple check rule which always allows the url passed to be fetched. This should be overridden by a derived class as appropriate for each filter.
| |
| $filter->update($object) | |
This method is called to tell the filter that the given object has been OK'd by all filters, and that it will be fetched. A filter can use this information to update any relevant internal counts. This method should be overridden by subclasses as neccessary. It has a null action in the Generic class.
| |
| $filter->result($object) | |
This method is used to return the result of an object fetch requested by a filter (filters may perform object fetches by returning an object from the check method with a rootnode of ``FILTER'') This method should be overridden by subclasses as neccessary. It has a null action in the Generic class. | |