uk.ac.starlink.ttools.cone
Class ConeSearchConer

java.lang.Object
  extended by uk.ac.starlink.ttools.cone.ConeSearchConer
All Implemented Interfaces:
Coner

public class ConeSearchConer
extends Object
implements Coner

Coner implementation which uses remote Cone Search services.

Since:
10 Aug 2007
Author:
Mark Taylor

Constructor Summary
ConeSearchConer()
          Constructor.
 
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 "ICRS", which is the system defined to be used by the Cone Search specification.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConeSearchConer

public ConeSearchConer()
Constructor.

Method Detail

getSkySystem

public String getSkySystem()
Returns "ICRS", which is the system defined to be used by the Cone Search specification.

Specified by:
getSkySystem in interface Coner
Returns:
ecliptic coordinate system name

getParameters

public uk.ac.starlink.task.Parameter[] getParameters()
Description copied from interface: Coner
Returns any configuration parameters associated with this object.

Specified by:
getParameters in interface Coner
Returns:
parameter array

createSearcher

public ConeSearcher createSearcher(uk.ac.starlink.task.Environment env,
                                   boolean bestOnly)
                            throws uk.ac.starlink.task.TaskException
Description copied from interface: Coner
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.

Specified by:
createSearcher in interface Coner
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.