jsky.catalog
Interface QueryArgs

All Known Implementing Classes:
BasicQueryArgs

public interface QueryArgs

An interface representing the values of the arguments to a catalog query. The values correspond one to one with a given catalog's parameters, as returned by the Catalog.getParamDesc(index) method.

See Also:
Catalog.getNumParams(), Catalog.getParamDesc(int)

Method Summary
 Catalog getCatalog()
          Return the catalog associated with this object
 SearchCondition[] getConditions()
          Return an array of SearchCondition objects indicating the values or range of values to search for.
 java.lang.String getId()
          Return the object id being searched for, or null if none was defined.
 int getMaxRows()
          Returns the max number of rows to be returned from a table query
 java.lang.Object getParamValue(int i)
          Get the value of the ith parameter
 java.lang.Object getParamValue(java.lang.String label)
          Get the value of the named parameter
 double getParamValueAsDouble(java.lang.String label, double defaultValue)
          Get the value of the named parameter as a double.
 int getParamValueAsInt(java.lang.String label, int defaultValue)
          Get the value of the named parameter as an integer.
 java.lang.String getParamValueAsString(java.lang.String label, java.lang.String defaultValue)
          Get the value of the named parameter as a String.
 java.lang.String getQueryType()
          Returns the query type (an optional string, which may be interpreted by some catalogs)
 CoordinateRadius getRegion()
          Return an object describing the query region (center position and radius range), or null if none was defined.
 void setId(java.lang.String id)
          Set the object id to search for.
 void setMaxRows(int maxRows)
          Set the max number of rows to be returned from a table query
 void setParamValue(int i, java.lang.Object value)
          Set the value for the ith parameter
 void setParamValue(java.lang.String label, double value)
          Set the double value for the parameter with the given label
 void setParamValue(java.lang.String label, int value)
          Set the int value for the parameter with the given label
 void setParamValue(java.lang.String label, java.lang.Object value)
          Set the value for the parameter with the given label
 void setParamValueRange(java.lang.String label, double minValue, double maxValue)
          Set the double value for the parameter with the given label
 void setParamValueRange(java.lang.String label, java.lang.Object minValue, java.lang.Object maxValue)
          Set the min and max values for the parameter with the given label
 void setParamValues(java.lang.Object[] values)
          Set the array of parameter values directly.
 void setQueryType(java.lang.String queryType)
          Set the query type (an optional string, which may be interpreted by some catalogs)
 void setRegion(CoordinateRadius region)
          Set the query region (center position and radius range) for the search.
 

Method Detail

getCatalog

Catalog getCatalog()
Return the catalog associated with this object


setParamValue

void setParamValue(int i,
                   java.lang.Object value)
Set the value for the ith parameter


setParamValue

void setParamValue(java.lang.String label,
                   java.lang.Object value)
Set the value for the parameter with the given label


setParamValueRange

void setParamValueRange(java.lang.String label,
                        java.lang.Object minValue,
                        java.lang.Object maxValue)
Set the min and max values for the parameter with the given label


setParamValue

void setParamValue(java.lang.String label,
                   int value)
Set the int value for the parameter with the given label


setParamValue

void setParamValue(java.lang.String label,
                   double value)
Set the double value for the parameter with the given label


setParamValueRange

void setParamValueRange(java.lang.String label,
                        double minValue,
                        double maxValue)
Set the double value for the parameter with the given label


setParamValues

void setParamValues(java.lang.Object[] values)
Set the array of parameter values directly.


getParamValue

java.lang.Object getParamValue(int i)
Get the value of the ith parameter


getParamValue

java.lang.Object getParamValue(java.lang.String label)
Get the value of the named parameter

Parameters:
label - the parameter name or id
Returns:
the value of the parameter, or null if not specified

getParamValueAsInt

int getParamValueAsInt(java.lang.String label,
                       int defaultValue)
Get the value of the named parameter as an integer.

Parameters:
label - the parameter label
defaultValue - the default value, if the parameter was not specified
Returns:
the value of the parameter

getParamValueAsDouble

double getParamValueAsDouble(java.lang.String label,
                             double defaultValue)
Get the value of the named parameter as a double.

Parameters:
label - the parameter label
defaultValue - the default value, if the parameter was not specified
Returns:
the value of the parameter

getParamValueAsString

java.lang.String getParamValueAsString(java.lang.String label,
                                       java.lang.String defaultValue)
Get the value of the named parameter as a String.

Parameters:
label - the parameter label
defaultValue - the default value, if the parameter was not specified
Returns:
the value of the parameter

getId

java.lang.String getId()
Return the object id being searched for, or null if none was defined.


setId

void setId(java.lang.String id)
Set the object id to search for.


getRegion

CoordinateRadius getRegion()
Return an object describing the query region (center position and radius range), or null if none was defined.


setRegion

void setRegion(CoordinateRadius region)
Set the query region (center position and radius range) for the search.


getConditions

SearchCondition[] getConditions()
Return an array of SearchCondition objects indicating the values or range of values to search for.


getMaxRows

int getMaxRows()
Returns the max number of rows to be returned from a table query


setMaxRows

void setMaxRows(int maxRows)
Set the max number of rows to be returned from a table query


getQueryType

java.lang.String getQueryType()
Returns the query type (an optional string, which may be interpreted by some catalogs)


setQueryType

void setQueryType(java.lang.String queryType)
Set the query type (an optional string, which may be interpreted by some catalogs)