view release on metacpan or  search on metacpan

lib/Astro/Catalog/Query/Sesame.pm  view on Meta::CPAN

=head1 NAME

Astro::Catalog::Query::Sesame - Object name resolution via SIMBAD

=head1 SYNOPSIS

    my $sesame = new Astro::Catalog::Query::Sesame(Target => "EX Hya");
    my $catalog = $sesame->querydb();

=head1 DESCRIPTION

Simple wrapper object for the CDS SIMBAD Name Resolver serbice (Sesame), see
http://cdsweb.u-strasbg.fr/cdsws.gml for details of the service.

=cut

use strict;
use warnings;
use base qw/Astro::Catalog::Transport::WebService/;

use Carp;
use Data::Dumper;
use POSIX qw/ceil/;

use Astro::Coords;
use Astro::Catalog;
use Astro::Catalog::Item;

our $VERSION = '4.38';
our $DEBUG = 0;

=head1 METHODS

=head2 Constructor

=over 4

=item B<new>

Create a new instance from a hash of options

    $query = new Astro::Catalog::Query::WebService(Object => $target);

returns a reference to an query object.
=cut

=item B<querydb>

Returns an Astro::Catalog object resulting from the specific query.

    $catalog = $query->querydb();

=cut

sub querydb {
    my $self = shift;

    # clean out buffer
    $self->_set_raw("");

    my $endpoint = $self->endpoint();
    my %options = $self->_translate_options();

    # return unless we haev a target, set it otherwise
    return undef unless $self->query_options("object");

    # make sesame query
    my $service = SOAP::Lite->service($self->endpoint());

    my $ident = $self->query_options("object");
    $ident =~ s/\+/ /g;

    my $buffer;
    eval { $buffer = $service->sesame( $ident, "u" ); };
    if ($@) {
        my $status = $service->transport()->status();
        croak("Error ($status): $@");
        return;
    }

    # parse results & return
    $self->_set_raw($buffer);
    my $catalog = $self->_parse_query();
    return $catalog;
}

=back

=begin __PRIVATE_METHODS__

=head2 Private methods

These methods are for internal use only.

=over 4

=item B<_default_endpoint>

=cut

sub _default_endpoint {
    return "http://cdsws.u-strasbg.fr/axis/services/Sesame?wsdl";
}

=item B<_default_urn>

=cut

sub _default_urn {
    return undef;
}

=item B<_is_service>

=cut

sub _is_service {
    return 1;
}

=item B<_get_allowed_options>

Returns a hash with keys, being the internal options supported
by this subclass, and values being the key name actually required
by the remote system (and to be included in the query).

=cut

sub _get_allowed_options {
    my $self = shift;
    return (
        object => 'object'
    );
}

=item B<_get_supported_init>

Uses base class options.

=cut

=item B<_set_default_options>

Set the default query state.

=cut

sub _set_default_options {
    return (
        object => undef,
    );
}


=item B<_get_supported_init>

Return the list of initialization methods supported by this catalog.
This is not the same as the allowed options since some methods are
not related to options and other methods that are related to options
use different names.