org.astrogrid.acr.ivoa.resource
Class SsapCapability

java.lang.Object
  extended by org.astrogrid.acr.ivoa.resource.Capability
      extended by org.astrogrid.acr.ivoa.resource.SsapCapability
All Implemented Interfaces:
Serializable

public class SsapCapability
extends Capability

The capability to perform a Simple Spectral Access (SSAP) query.

See Also:
SsapService, Ssap, Serialized Form

Nested Class Summary
static class SsapCapability.PosParam
          The central coordinate of the spatial region to be searched.
static class SsapCapability.Query
          A test query for a SSAP service.
 
Method Summary
 String getComplianceLevel()
          the level at which a service instance complies with the SSA standard.
 String[] getCreationTypes()
          the process used to create this dataset
 String[] getDataSources()
          The defined categories that specify where the spectral data originally came from.
 int getDefaultMaxRecords()
          The largest number of records that the service will return when the MAXREC parameter not specified in the query input.
 double getMaxAperture()
          The largest aperture that can be supported upon request via the APERTURE input parameter by a service that supports the special extraction creation method.
 int getMaxFileSize()
          The maximum image file size in bytes.
 int getMaxRecords()
          The hard limit on the largest number of records that the query operation will return in a single response
 double getMaxSearchRadius()
          The largest search radius, in degrees, that will be accepted by the service without returning an error condition.
 String[] getSupportedFrames()
          An identifier for a world coordinate system frame supported by this service.
 SsapCapability.Query getTestQuery()
          A test query for this service.
 
Methods inherited from class org.astrogrid.acr.ivoa.resource.Capability
getDescription, getInterfaces, getStandardID, getType, getValidationLevel
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getComplianceLevel

public String getComplianceLevel()
the level at which a service instance complies with the SSA standard.

Returns:
One of minimal,query,full

getDataSources

public String[] getDataSources()
The defined categories that specify where the spectral data originally came from.

Returns:
One of survey,pointed,custom,theory,artificial

getCreationTypes

public final String[] getCreationTypes()
the process used to create this dataset

Returns:
one of archival,cutout,filtered,mosaic,projection,specialExtraction,catalogExtraction

getMaxSearchRadius

public final double getMaxSearchRadius()
The largest search radius, in degrees, that will be accepted by the service without returning an error condition.

Returns:
the maximum search radius

getMaxRecords

public final int getMaxRecords()
The hard limit on the largest number of records that the query operation will return in a single response


getDefaultMaxRecords

public final int getDefaultMaxRecords()
The largest number of records that the service will return when the MAXREC parameter not specified in the query input.


getMaxAperture

public final double getMaxAperture()
The largest aperture that can be supported upon request via the APERTURE input parameter by a service that supports the special extraction creation method.


getSupportedFrames

public final String[] getSupportedFrames()
An identifier for a world coordinate system frame supported by this service.


getMaxFileSize

public final int getMaxFileSize()
The maximum image file size in bytes.


getTestQuery

public final SsapCapability.Query getTestQuery()
A test query for this service.

Returns:
a set of query parameters that is expected to produce at least one matched record


Copyright © 2002-2010 AstroGrid. All Rights Reserved.