|
|||||||||
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 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 |
---|
Catalog getCatalog()
void setParamValue(int i, java.lang.Object value)
void setParamValue(java.lang.String label, java.lang.Object value)
void setParamValueRange(java.lang.String label, java.lang.Object minValue, java.lang.Object maxValue)
void setParamValue(java.lang.String label, int value)
void setParamValue(java.lang.String label, double value)
void setParamValueRange(java.lang.String label, double minValue, double maxValue)
void setParamValues(java.lang.Object[] values)
java.lang.Object getParamValue(int i)
java.lang.Object getParamValue(java.lang.String label)
label
- the parameter name or id
int getParamValueAsInt(java.lang.String label, int defaultValue)
label
- the parameter labeldefaultValue
- the default value, if the parameter was not specified
double getParamValueAsDouble(java.lang.String label, double defaultValue)
label
- the parameter labeldefaultValue
- the default value, if the parameter was not specified
java.lang.String getParamValueAsString(java.lang.String label, java.lang.String defaultValue)
label
- the parameter labeldefaultValue
- the default value, if the parameter was not specified
java.lang.String getId()
void setId(java.lang.String id)
CoordinateRadius getRegion()
void setRegion(CoordinateRadius region)
SearchCondition[] getConditions()
int getMaxRows()
void setMaxRows(int maxRows)
java.lang.String getQueryType()
void setQueryType(java.lang.String queryType)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |