Package uk.ac.starlink.ttools.cone

Class ServiceConeSearcher

java.lang.Object
uk.ac.starlink.ttools.cone.DalConeSearcher
uk.ac.starlink.ttools.cone.ServiceConeSearcher
All Implemented Interfaces:
ConeSearcher
public class ServiceConeSearcher extends DalConeSearcher implements ConeSearcher
ConeSearcher implementation using a VO Cone Search service.
Since:
17 Apr 2009
Author:
Mark Taylor

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServiceConeSearcher(uk.ac.starlink.vo.ConeSearch csearch, int verb, boolean believeEmpty, uk.ac.starlink.table.StarTableFactory tfact)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Called when this searcher is no longer required.
    int
    getDecIndex(uk.ac.starlink.table.StarTable result)
    Returns the index of a column giving the declination in the returned table.
    int
    getRaIndex(uk.ac.starlink.table.StarTable result)
    Returns the index of a column giving the right ascension in the returned table.
    uk.ac.starlink.table.StarTable
    performSearch(double ra, double dec, double sr)
    Returns a table consisting of all the objects within a given search radius of a specified point on the sky.

    Methods inherited from class uk.ac.starlink.ttools.cone.DalConeSearcher

    getConsistentTable, getInconsistentEmptyAdvice, getUcd1DecIndex, getUcd1RaIndex

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ServiceConeSearcher

      public ServiceConeSearcher(uk.ac.starlink.vo.ConeSearch csearch, int verb, boolean believeEmpty, uk.ac.starlink.table.StarTableFactory tfact)
      Constructor.
      Parameters:
      csearch - cone search service specification object
      verb - verbosity parameter
      believeEmpty - whether empty tables are considered to contain correct metadata
      tfact - table factory

  • Method Details

    • performSearch

      public uk.ac.starlink.table.StarTable performSearch(double ra, double dec, double sr) throws IOException
      Description copied from interface: ConeSearcher
      Returns a table consisting of all the objects within a given search radius of a specified point on the sky. If no matching objects are found, then it is preferable to return an empty table with the correct columns. However, if this cannot be done, it is permissible to return null. For every table returned, the columns should be the same.
      Specified by:
      performSearch in interface ConeSearcher
      Parameters:
      ra - right ascension in degrees of search region centre
      dec - declination in degrees of search region centre
      sr - search radius in degrees
      Returns:
      table containing records in the given cone, or possibly null if no records are found
      Throws:
      IOException

    • getRaIndex

      public int getRaIndex(uk.ac.starlink.table.StarTable result)
      Description copied from interface: ConeSearcher
      Returns the index of a column giving the right ascension in the returned table. This should be the same quantity which is used for the match assessment.
      Specified by:
      getRaIndex in interface ConeSearcher
      Parameters:
      result - table returned by performSearch
      Returns:
      index of RA column, or -1 if it can't be found

    • getDecIndex

      public int getDecIndex(uk.ac.starlink.table.StarTable result)
      Description copied from interface: ConeSearcher
      Returns the index of a column giving the declination in the returned table. This should be the same quantity which is used for the match assessment.
      Specified by:
      getDecIndex in interface ConeSearcher
      Parameters:
      result - table returned by performSearch
      Returns:
      index of dec column, or -1 if it can't be found

    • close

      public void close()
      Description copied from interface: ConeSearcher
      Called when this searcher is no longer required.
      Specified by:
      close in interface ConeSearcher