Aranea::XML::RequestList
- object representing the <request_list>
of an Aranea XML object
|
The RequestList
object represents the request_list
section of an
Aranea XML object. Here is an example:
|
The RequestList
object serves as a container for a collection of
RequestEntry
s. Under normal
circumstances, the creation of a RequestList
should be handled
automatically by the Aranea::XML::Aranea
object.
new($data)
RequestList
object given parsed XML data. Note that
this method is rarely invoked manually; under typical usage patterns,
the constructor of Aranea::XML::Aranea
will
call this method automatically.
entries([$listref])
RequestEntry
s. When called with no
arguments, this method returns a listref of RequestEntry
s. When
called with a single listref, the collection of RequestEntry
s is
set to the listref.
The typical usage pattern is to iterate over each request and perform some action, e.g.,
|
entries_count()
RequestList
. Note that the
return value is similiar to that of $#
, i.e., -1 for no entries, 0
for one entry, etc.
add_default_exact_query($q)
RequestList
with default parameters.
An exact query specifies an unbound variable, e.g., execution of the
request ``?x killed Lincoln'' will return a small fragment of text that
directly preceeds the exact phrase ``killed Lincoln.''
add_default_inexact_query($q)
RequestList
with default
parameters. An inexact query does not specifies an unbound
variable; rather, the surrounding context of the matched keywords is
returned.
write_xml($writer)
RequestList
; takes an
XML::Writer
as its only argument. Note that this method is rarely
invoked manually; under typical usage patterns, the write_xml
method of Aranea::XML::Aranea
will call this
method automatically.