Scroll to navigation

WebService::Solr::Document(3pm) User Contributed Perl Documentation WebService::Solr::Document(3pm)

NAME

WebService::Solr::Document - A document object

SYNOPSIS

    my $doc = WebService::Solr::Document->new;
    $doc->add_fields( @fields );
    $doc->boost( 2.0 );
    my $id = $doc->value_for( 'id' );
    my @subjects = $doc->values_for( 'subject' );

DESCRIPTION

This class represents a basic document object, which is basically a collection of fields.

ACCESSORS

  • fields - an array of fields
  • boost - a floating-point "boost" value

METHODS

new( @fields|\@fields )

Constructs a new document object given @fields. A field can be a WebService::Solr::Field object, or a structure accepted by "WebService::Solr::Field->new".

BUILDARGS( @args )

A Moose override to allow our custom constructor.

add_fields( @fields|\@fields )

Adds @fields to the document.

field_names

Returns a list of field names that are in this document.

value_for( $name )

Returns the first value for $name.

values_for( $name )

Returns all values for $name.

to_element( )

Serializes the object to an XML::Easy::Element object.

to_xml( )

Serializes the object to xml.

AUTHORS

Brian Cassidy <bricas@cpan.org>

Kirk Beers

COPYRIGHT AND LICENSE

Copyright 2008-2016 National Adult Literacy Database

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

2017-11-01 perl v5.26.1