GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ASTRO::ADS::RESULT::PAPER (3)

.ds Aq ’

NAME

Astro::ADS::Result::Paper - A individual paper in an Astro::ADS::Result object

CONTENTS

SYNOPSIS



  $paper = new Astro::ADS::Result::Paper( Bibcode   => $bibcode,
                                          Title     => $title,
                                          Authors   => \@authors,
                                          Affil     => \@affil,
                                          Journal   => $journal_refernce,
                                          Published => $published,
                                          Keywords  => \@keywords,
                                          Origin    => $journal,
                                          Links     => \@associated_links,
                                          URL       => $abstract_url,
                                          Abstract  => \@abstract,
                                          Object    => $object,
                                          Score     => $score );

  $bibcode = $paper->bibcode();
  @authors = $paper->authors();

  $xml = $paper->summary(format => "XML");
  $text= $paper->summary(format => "TEXT", fields => \@fields);



DESCRIPTION

Stores meta-data about an individual paper in the Astro::ADS::Result object returned by an Astro::ADS::Query object.

REVISION

$Id: Paper.pm,v 1.25 2013/08/06 bjd Exp $ $Id: Paper.pm,v 1.11 2001/11/10 20:58:43 timj Exp $

METHODS

    Constructor

<B>newB> Create a new instance from a hash of options



  $paper = new Astro::ADS::Result::Paper( Bibcode   => $bibcode,
                                          Title     => $title,
                                          Authors   => \@authors,
                                          Affil     => \@affil,
                                          Journal   => $journal_refernce,
                                          Published => $published,
                                          Keywords  => \@keywords,
                                          Origin    => $journal,
                                          Links     => \@outbound_links,
                                          URL       => $abstract_url,
                                          Abstract  => \@abstract,
                                          Object    => $object,
                                          Score     => $score );



returns a reference to an ADS paper object.

    Accessor Methods

<B>bibcodeB> Return (or set) the bibcode for the paper



   $bibcode = $paper->bibcode();
   $paper->bibcode( $bibcode );



<B>titleB> Return (or set) the title for the paper



   $title = $paper->title();
   $paper->title( $title );



<B>AuthorsB> Return (or set) the authors for the paper



   @authors = $paper->authors();
   $first_author = $paper->authors();
   $paper->authors( \@authors );



if called in a scalar context it will return the first author.

<B>affilB> Return (or set) the affiliation of each author for the paper



   @institutions = $paper->affil();
   $first_author_inst = $paper->affil();
   $paper->affil( \@institutions );



if called in a scalar context it will return the affiliation of the first author.

<B>JournalB> Return (or set) the journal reference for the paper



   $journal_ref = $paper->journal();
   $paper->journal( $journal_ref );



<B>PublishedB> Return (or set) the month and year when the paper was published.



   $published = $paper->published();
   $paper->published( $published );



<B>keywordsB> Return (or set) the different keywords the paper is indexed by, could include such keys as ACCRETION DISCS, WHITE DWARFS, etc.



   @keywords = $paper->keywords();
   $paper->keywords( \@keywords );



if called in a scalar context it will return the number of keywords.

<B>originB> Return (or set) the origin of the paper in the ADS archive, this is not necessarily the journal in which the paper was published, but could be set to AUTHOR, ADS or SIMBAD for instance.



   $source = $paper->origin();
   $paper->origin( $source );



<B>linksB> Return (or set) the different type of outbounds links offered by ADS for this paper, examples include ABSTRACT, EJOURNAL, ARTICLE, REFERENCES, CITATIONS, SIMBAD objects etc.



   @outbound_links = $paper->links();
   $paper->links( \@outbound_links );



if called in a scalar context it will return the number of outbound links available.

<B>urlB> Return (or set) the URL pointing to the paper at the ADS



   $adsurl = $paper->url();
   $paper->url( $adsurl );



<B>abstractB> Return (or set) the abstract of the paper, this may be either the full text of the abstract, or a URL pointing to the scanned abstract at the ADS.



   @abstract = $paper->abstract();
   $paper->abstract( @abstract );



if called in a scalar context it will return the number of lines of text in the abstract.

<B>objectB> Return (or set) the object tag for the paper.



   $object = $paper->object();
   $paper->object( $object );



<B>scoreB> Return (or set) the score for the paper generated by the weightings of the different query criteria.



   $score = $paper->score();
   $paper->score( $score );



    Followup Queries

<B>referencesB> Returns an Astro::ADS::Result object containing the references for the paper.



   $result = $paper->references();



returns undef if this external link type is not available for this paper.

<B>citationsB> Returns an Astro::ADS::Result object containing the citations for the paper.



   $result = $paper->citations();



returns undef if this external link type is not available for this paper.

<B>alsoreadB> Returns an Astro::ADS::Result object containing papers which were ‘also read’ along with this paper.



   $result = $paper->alsoread();



returns undef if this external link type is not available for this paper.

<B>tableofcontentsB> Returns an Astro::ADS::Result object containing the table of contents of the journal or proceedings.



   $result = $paper->tableofcontents();



returns undef if this external link type is not available for this paper.

    General Methods

<B>configureB> Configures the object from multiple pieces of information.



  $paper->configure( %options );



Takes a hash as argument with the following keywords:
<B>BibcodeB> The bibcode of the paper. A complete description of the bibcode reference coding has been published as a chapter of the book Information & On-Line Data in Astronomy, 1995, D. Egret and M. A. Albrecht (Eds), Kluwer Acad. Publ.

A copy of the relevant chapter in this book is available online as a Postscript file via the CDS at http://cdsweb.u-strasbg.fr/simbad/refcode.ps

<B>TitleB> The title of the paper.
<B>AuthorsB> The authors of the paper.
<B>AffilB> Institute affiliations associated with each author.
<B>JournalB> The journal reference for the paper, e.g. MNRAS, 279, 1345-1348 (1996)
<B>PublishedB> Month and year published, e.g. 4/1996
<B>KeywordsB> Keywords for the paper, e.g. ACCRETION DISCS
<B>OriginB> Origin of citation in ADS archive, this is not necessarily the journal, the origin of the entry could be AUTHOR, or ADS or SIMBAD for instance.
<B>LinksB> Available type of links relating to the paper, e.g. SIMBAD objects mentioned in the paper, References, Citations, Table of Contents of the Journal etc.
<B>URLB> URL of the ADS page of the paper
<B>AbstractB> Either the abstract text or a URL of the scanned abstract (for older papers).
<B>ObjectB> Main object for the paper or article, not normally defined except for IAU circulars and other similar articles.
<B>ScoreB> Weighting of the paper based on query criteria, the highest weighted paper is the ‘‘most relevant’’ to your search terms.

Does nothing if these keys are not supplied.

<B>summaryB> Return a summary of the paper in either XML or ASCII tabular format.



  $summary = $paper->summary( format => "XML" );



Takes a hash as argument. The following keys are supported:
format Format of the result string. Options are XML to return an XML representation of the paper, or TEXT to return an ASCII formatted table. Default is to return TEXT.
fields Fields to include in the result. Default is to include BIBCODE, SCORE, TITLE, PUBLISHED and AUTHORS. Supplied as an array reference.

<B>stringifyB> Method called automatically when the object is printed in a string context. Simple invokes the summary() method with default arguments.

COPYRIGHT

Copyright (C) 2001 University of Exeter. All Rights Reserved.

This program was written as part of the eSTAR project and is free software; you can redistribute it and/or modify it under the terms of the GNU Public License.

AUTHORS

Alasdair Allan <aa@astro.ex.ac.uk>,
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAPER (3) 2013-10-25

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.