dalclient
Class SiapQuery

java.lang.Object
  extended bydalclient.DALQuery
      extended bydalclient.SiapQuery

public class SiapQuery
extends DALQuery

SIAP query. Provides methods to build up and execute a query against a pre-established connection.

The SIAP interface elements used in the client API are slightly abstracted from the names used in the wire protocol (i.e., in the query response VOTable) for simplicity and in order to provide some isolation from the details of the underlying protocol. The mappings are as follows, with the API keywords at the left:

     "Title"			"VOX:Image_Title"
     "RA"			"POS_EQ_RA_MAIN"
     "DEC"			"POS_EQ_DEC_MAIN"
     "Instrument"		"INST_ID"
     "MJDateObs"		"VOX:Image_MJDateObs"
     "Naxes"			"VOX:Image_Naxes"
     "Naxis"			"VOX:Image_Naxis"
     "Scale"			"VOX:Image_Scale"
     "Format"			"VOX:Image_Format"
 
     "CoordRefFrame"		"VOX:STC_CoordRefFrame"
     "CoordEquinox"		"VOX:STC_CoordEquinox"
     "CoordProjection"		"VOX:STC_CoordProjection"
     "CoordRefPixel"		"VOX:STC_CoordRefPixel"
     "CoordRefValue"		"VOX:STC_CoordRefValue"
     "CDMatrix"			"VOX:STC_CDMatrix"
 
     "BandPass_ID"		"VOX:BandPass_ID"
     "BandPass_Unit"		"VOX:BandPass_Unit"
     "BandPass_RefValue"	"VOX:BandPass_RefValue"
     "BandPass_HiLimit"		"VOX:BandPass_HiLimit"
     "BandPass_LoLimit"		"VOX:BandPass_LoLimit"
 
     "PixFlags"			"VOX:Image_PixFlags"
     "AccessReference"		"VOX:Image_AccessReference"
     "AccessRefTTL"		"VOX:Image_AccessRefTTL"
     "Filesize"			"VOX:Image_FileSize"
 

It is the SIA V1.0 keywords which are shown here. The data model will change quite a bit in V1.1, however if possible the keywords shown here will still be recognized to provide some backwards compatibility.


Method Summary
 QueryResponse execute()
          Execute query and process the resultant VOTable into a SIAP query response class.
 void executeCSV(java.io.PrintStream out)
          Execute query and write to the given output stream in CSV format.
 
Methods inherited from class dalclient.DALQuery
addParameter, executeCSV, executeCSV, executeRaw, executeRaw, executeVOTable, executeVOTable, getQueryString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

executeCSV

public void executeCSV(java.io.PrintStream out)
                throws java.lang.Exception
Execute query and write to the given output stream in CSV format. For images the column labels are the SIA data model attribute names rather than UCDs.

Overrides:
executeCSV in class DALQuery
Parameters:
out - The output stream to be written to.
Throws:
java.lang.Exception

execute

public QueryResponse execute()
                      throws java.lang.Exception
Execute query and process the resultant VOTable into a SIAP query response class. To do this we have to extact the elements of the SIAP data model into attributes in SiapQuery. Note this version does not yet support querying multiple services and merging the results.

Throws:
java.lang.Exception