Package uk.ac.starlink.ttools.cone
Class ConeServiceType
java.lang.Object
uk.ac.starlink.ttools.cone.ConeServiceType
Characterises a simple DAL service based on sky position.
- Since:
- 10 Oct 2024
- Author:
- Mark Taylor
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ConeServiceType
Simple cone search type.static final ConeServiceType
Alias for SIA1.static final ConeServiceType
Simple Image Access v1 type.static final ConeServiceType
Simple Image Access v2 type.static final ConeServiceType
Simple Spectral Access type. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
configureRadiusParam
(uk.ac.starlink.task.Parameter<Double> srParam) Provides this object with a chance to perform custom configuration on general cone search parameters.abstract ConeSearcher
createMultiSearcher
(uk.ac.starlink.task.Environment env, ConeSearchConer conerTask, String url, boolean believeEmpty, uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.util.ContentCoding coding) Constructs a ConeSearcher instance suitable for this service type.abstract ConeSearcher
createSingleSearcher
(uk.ac.starlink.task.Environment env, TableCone coneTask, String url, uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.util.ContentCoding coding) Constructs a ConeSearcher instance suitable for single cone searches using this service type.static ConeServiceType[]
Returns a list of instances of this class that may include aliases.abstract Coverage
getCoverage
(URL url, int nside) Returns a coverage footprint for use with the service specified.abstract String
Returns XML description of this service type.static ConeServiceType[]
Returns a list of distinct instances of this class.abstract String
Returns XML documentation of the use of the format parameter for this service type.toString()
abstract boolean
Indicates whether the result table should be subjected to additional filtering to ensure that only rows in the specified search radius are included in the final output.
-
Field Details
-
CONE
Simple cone search type. -
SSA
Simple Spectral Access type. -
SIA1
Simple Image Access v1 type. -
SIA2
Simple Image Access v2 type. -
SIA
Alias for SIA1.
-
-
Constructor Details
-
ConeServiceType
Constructor.- Parameters:
name
- informal, short name
-
-
Method Details
-
getDescription
Returns XML description of this service type.- Returns:
- description
-
getFormatDescription
Returns XML documentation of the use of the format parameter for this service type.- Returns:
- formats info
-
configureRadiusParam
Provides this object with a chance to perform custom configuration on general cone search parameters.- Parameters:
srParam
- search radius parameter
-
createSingleSearcher
public abstract ConeSearcher createSingleSearcher(uk.ac.starlink.task.Environment env, TableCone coneTask, String url, uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.util.ContentCoding coding) throws uk.ac.starlink.task.TaskException Constructs a ConeSearcher instance suitable for single cone searches using this service type.- Parameters:
env
- execution environmentconeTask
- task instanceurl
- service URLtfact
- table factorycoding
- controls HTTP-level byte stream compression; implementations may choose to ignore this hint- Returns:
- cone searcher object
- Throws:
uk.ac.starlink.task.TaskException
-
createMultiSearcher
public abstract ConeSearcher createMultiSearcher(uk.ac.starlink.task.Environment env, ConeSearchConer conerTask, String url, boolean believeEmpty, uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.util.ContentCoding coding) throws uk.ac.starlink.task.TaskException Constructs a ConeSearcher instance suitable for this service type.- Parameters:
env
- execution environmentconerTask
- task instanceurl
- service URLbelieveEmpty
- whether to take seriously metadata from zero-length tablestfact
- table factorycoding
- controls HTTP-level byte stream compression; implementations may choose to ignore this hint- Returns:
- cone searcher object
- Throws:
uk.ac.starlink.task.TaskException
-
useDistanceFilter
public abstract boolean useDistanceFilter()Indicates whether the result table should be subjected to additional filtering to ensure that only rows in the specified search radius are included in the final output.- Returns:
- true iff post-query filtering on distance is to be performed
-
getCoverage
Returns a coverage footprint for use with the service specified.- Parameters:
url
- cone search service URLnside
- MOC nside parameter- Returns:
- coverage footprint, or null
-
toString
-
getDistinctTypes
Returns a list of distinct instances of this class.- Returns:
- instance list
-
getAllTypes
Returns a list of instances of this class that may include aliases.- Returns:
- instance list
-