NAME

InfoSys::FreeDB::Response::Query - FreeDB query response

SYNOPSIS

 require InfoSys::FreeDB;
 require InfoSys::FreeDB::Entry;
 
 # Read entry from the default CD device
 my $entry = InfoSys::FreeDB::Entry->new_from_cdparanoia();
 
 # Create a HTTP connection
 my $fact = InfoSys::FreeDB->new();
 my $conn = $fact->create_connection( {
     client_name => 'testing-InfoSys::FreeDB',
     client_version => $InfoSys::FreeDB::VERSION,
 } );
 
 # Query FreeDB
 my $res_q = $conn->query( $entry );
 scalar( $res_q->get_match() ) ||
     die 'no matches found for the disck in the default CD-Rom drive';
 
 # Read the first match
 my $res_r = $conn->read( ( $res_q->get_match() )[0] );
 
 # Write the entry to STDERR
 use IO::Handle;
 my $fh = IO::Handle->new_from_fd( fileno(STDERR), 'w' );
 $res_r->get_entry()->write_fh( $fh );

ABSTRACT

FreeDB query response

DESCRIPTION

InfoSys::FreeDB::Response::Query contains information about FreeDB query responses.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new InfoSys::FreeDB::Response::Query object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

exact_match

Passed to set_exact_match().

match

Passed to set_match(). Must be an ARRAY reference.

Options for OPT_HASH_REF inherited through package InfoSys::FreeDB::Response may include:

code

Passed to set_code(). Mandatory option.

error

Passed to set_error().

result

Passed to set_result(). Mandatory option.

new_from_content_ref(CONTENT_REF)

Creates a new InfoSys::FreeDB::Response::Query object from the specified content reference. CONTENT_REF is a string reference. On error an exception Error::Simple is thrown.

METHODS

exists_match(ARRAY)

Returns the count of items in ARRAY that are in the match list.

get_code()

This method is inherited from package InfoSys::FreeDB::Response. Returns the response code.

get_match( [ INDEX_ARRAY ] )

Returns an ARRAY containing the match list. INDEX_ARRAY is an optional list of indexes which when specified causes only the indexed elements in the ordered list to be returned. If not specified, all elements are returned.

get_result()

This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.

is_error()

This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.

is_exact_match()

Returns whether the query found an exact match or not.

pop_match()

Pop and return an element off the match list. On error an exception Error::Simple is thrown.

push_match(ARRAY)

Push additional values on the match list. ARRAY is the list value. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

InfoSys::FreeDB::Match

set_code(VALUE)

This method is inherited from package InfoSys::FreeDB::Response. Set the response code. VALUE is the value. On error an exception Error::Simple is thrown.

set_error(VALUE)

This method is inherited from package InfoSys::FreeDB::Response. State that the response has an error. VALUE is the value. On error an exception Error::Simple is thrown.

set_exact_match(VALUE)

State that the query found an exact match. VALUE is the value. On error an exception Error::Simple is thrown.

set_idx_match( INDEX, VALUE )

Set value in the match list. INDEX is the integer index which is greater than or equal to 0. VALUE is the value.

The values in ARRAY must be a (sub)class of:

InfoSys::FreeDB::Match

set_match(ARRAY)

Set the match list absolutely. ARRAY is the list value. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

InfoSys::FreeDB::Match

set_num_match( NUMBER, VALUE )

Set value in the match list. NUMBER is the integer index which is greater than 0. VALUE is the value.

The values in ARRAY must be a (sub)class of:

InfoSys::FreeDB::Match

set_result(VALUE)

This method is inherited from package InfoSys::FreeDB::Response. Set the response result text. VALUE is the value. On error an exception Error::Simple is thrown.

shift_match()

Shift and return an element off the match list. On error an exception Error::Simple is thrown.

unshift_match(ARRAY)

Unshift additional values on the match list. ARRAY is the list value. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

InfoSys::FreeDB::Match

SEE ALSO

InfoSys::FreeDB, InfoSys::FreeDB::Connection, InfoSys::FreeDB::Connection::CDDBP, InfoSys::FreeDB::Connection::HTTP, InfoSys::FreeDB::Entry, InfoSys::FreeDB::Entry::Track, InfoSys::FreeDB::Match, InfoSys::FreeDB::Response, InfoSys::FreeDB::Response::DiscId, InfoSys::FreeDB::Response::Hello, InfoSys::FreeDB::Response::LsCat, InfoSys::FreeDB::Response::Motd, InfoSys::FreeDB::Response::Proto, InfoSys::FreeDB::Response::Quit, InfoSys::FreeDB::Response::Read, InfoSys::FreeDB::Response::SignOn, InfoSys::FreeDB::Response::Sites, InfoSys::FreeDB::Response::Stat, InfoSys::FreeDB::Response::Ver, InfoSys::FreeDB::Response::Whom, InfoSys::FreeDB::Response::Write::1, InfoSys::FreeDB::Response::Write::2, InfoSys::FreeDB::Site

BUGS

None known (yet.)

HISTORY

First development: September 2003 Last update: December 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the InfoSys::FreeDB module hierarchy for Perl by Vincenzo Zocca.

The InfoSys::FreeDB module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The InfoSys::FreeDB module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the InfoSys::FreeDB module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA