SRU::Response::Term(3pm)				User Contributed Perl Documentation				  SRU::Response::Term(3pm)

NAME

       SRU::Response::Term - A class for representing terms in a Scan response

SYNOPSIS

DESCRIPTION

       A SRU::Response::Term object bundles up information about a single term contained in a SRU::Response::Scan object. A scan object can
       contain multiple term objects.

METHODS

   new()
       THe constructor which you must at least pass the value parameter:

	   my $term = SRU::Response::Term->new( term => "Foo Fighter" );

       In addition you can pass the numberOfRecords, displayTerm, whereInList, and extraTermData parameters, or set them separately with their
       accessors.

   value()
       The term exactly as it appears in the index. This term should be able to be sent in a query as is to retrieve the records it derives from.

   numberOfRecords()
       The number of records which would be matched if the index in the request's scanClause was searched with the term in the 'value' field.

   displayTerm()
       A string to display to the end user in place of the term itself. For example this might add back in stopwords which do not appear in the
       index, or diacritics which have been normalised.

   whereInList()
       A flag to indicate the position of the term within the complete term list. It must be one of the following values: 'first' (the first
       term), 'last' (the last term), 'only' (the only term) or 'inner' (any other term).

   extraTermData()
       Additional profile specific information. More details are available in the extensions section.

   asXML()
perl v5.12.4							    2009-11-20						  SRU::Response::Term(3pm)