uk.ac.starlink.ttools.cone
Interface Coner

All Known Implementing Classes:
ConeSearchConer, JdbcConer

public interface Coner

Defines a service which can perform cone search-like operations.

Since:
10 Aug 2007
Author:
Mark Taylor

Method Summary
 ConeSearcher createSearcher(uk.ac.starlink.task.Environment env, boolean bestOnly)
          Returns a searcher object which can perform the actual cone searches as configured by this object's parameters.
 uk.ac.starlink.task.Parameter[] getParameters()
          Returns any configuration parameters associated with this object.
 String getSkySystem()
          Returns the name of the coordinate system used by this Coner.
 

Method Detail

getParameters

uk.ac.starlink.task.Parameter[] getParameters()
Returns any configuration parameters associated with this object.

Returns:
parameter array

getSkySystem

String getSkySystem()
Returns the name of the coordinate system used by this Coner. Spatial matching is done using Right Ascension and Declination in degrees but the exact coordinate system is up to this object. This method should return a string such as "ICRS" which specifies the ecliptic system in use. It may return the empty string if no assumption is made.

This string is used only for documentation purposes, for instance in prompt strings issued to the user.

Returns:
ecliptic coordinate system name

createSearcher

ConeSearcher createSearcher(uk.ac.starlink.task.Environment env,
                            boolean bestOnly)
                            throws uk.ac.starlink.task.TaskException
Returns a searcher object which can perform the actual cone searches as configured by this object's parameters. If the bestOnly flag is set, then only the best match is required. The implementation may use this as a hint if it helps efficiency, but is not obliged to return single-row tables, since extraneous rows will be filtered out later. Similarly any rows which do not actually match the given criteria will be filtered out later, so it is not an error to return too many rows.

Parameters:
env - execution environment
bestOnly - true iff only the best match will be used
Throws:
uk.ac.starlink.task.TaskException


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.