• DESCRIPTION
• METHODS
  • new
  • $summariser->summarise($obj,$file)

Generic summariser class - acts a base class for all other summarisers. Should not be called directly, but other summarisers should inherit methods from it.

The constructor - any arguments to the summariser are passed in as arguments to this class

The summarise function - should summarise the contents of $file, into the soif area of $obj.

$obj is a Harvest::Object $file is the filename that contains the data to be summarised.

All changes should be made directly to $obj, rather than to a copy.

The summariser should return one of

($obj) ($obj,$type) ($obj,$type,$newfile)

where

$obj is identical to the value of $obj passed into the summariser $type is the MIME type for which a summariser should be invoked, with the output of this summariser. $newfile is the file containing the output of this summariser which a a summariser of type $type should be invoked upon. Please be careful to avoid races when creating this file.