|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Catalog.getNumParams()
,
Catalog.getParamDesc(int)
Method Summary | |
---|---|
Catalog |
getCatalog()
Return the catalog we are accesing. |
SearchCondition[] |
getConditions()
Return an array of SearchCondition objects indicating the values or range of values to search for. |
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 |
Object |
getParamValue(int i)
Get the value of the ith parameter |
Object |
getParamValue(String label)
Get the value of the named parameter |
double |
getParamValueAsDouble(String label,
double defaultValue)
Get the value of the named parameter as a double. |
int |
getParamValueAsInt(String label,
int defaultValue)
Get the value of the named parameter as an integer. |
String |
getParamValueAsString(String label,
String defaultValue)
Get the value of the named parameter as a String. |
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(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,
Object value)
Set the value for the ith parameter |
void |
setParamValue(String label,
double value)
Set the double value for the parameter with the given label |
void |
setParamValue(String label,
int value)
Set the int value for the parameter with the given label |
void |
setParamValue(String label,
Object value)
Set the value for the parameter with the given label |
void |
setParamValues(Object[] values)
Set the array of parameter values directly. |
void |
setQueryType(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 |
---|
void setParamValue(int i, Object value)
void setParamValue(String label, Object value)
void setParamValue(String label, int value)
void setParamValue(String label, double value)
void setParamValues(Object[] values)
Object getParamValue(int i)
Object getParamValue(String label)
label
- the parameter name or id
int getParamValueAsInt(String label, int defaultValue)
label
- the parameter labeldefaultValue
- the default value, if the parameter was not specified
double getParamValueAsDouble(String label, double defaultValue)
label
- the parameter labeldefaultValue
- the default value, if the parameter was not specified
String getParamValueAsString(String label, String defaultValue)
label
- the parameter labeldefaultValue
- the default value, if the parameter was not specified
String getId()
void setId(String id)
CoordinateRadius getRegion()
void setRegion(CoordinateRadius region)
Catalog getCatalog()
SearchCondition[] getConditions()
int getMaxRows()
void setMaxRows(int maxRows)
String getQueryType()
void setQueryType(String queryType)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |