public class QueryParameterSet
extends java.lang.Object
implements java.io.Serializable
${services_components_commontypes_QueryParameterSet_Title}
${services_components_commontypes_QueryParameterSet_Description}
The following codes shows how to construct a complete query parameter set object:
QueryParameterSet queryParameterSet = new QueryParameterSet(); // Expects to return only 20 counts queryParameterSet.expectCount = 20; // Used to specify the returned form of the query result, it can separately return geometry, separately return attribute and return geometry and attribute together. queryParameterSet.queryOption = QueryOption.ATTRIBUTEANDGEOMETRY; // Querying and recording start location, used to control record of the query result, returns only the qualified record object. queryParameterSet.startRecord = 0; // Sets the query parameters corresponding to the layer, multiple layers can be queried at one time queryParameterSet.queryParams = new QueryParameter[1]; QueryParameter queryParam = new QueryParameter(); // Specifies the name of the layer to be queried queryParam.name = "Capitals@World"; queryParameterSet.queryParams[0] = queryParam;
Modifier and Type | Field and Description |
---|---|
java.lang.String |
customParams
Custom parameters for extended use.
|
int |
expectCount
The returned number of result records in the query results, it is greater than 0.
|
boolean |
ignoreTotalCount
Whether the query results returns accurate totalCount When querying multi-layer, if the number of query results of some layers meets the requirements of
expectCount , to calculate the value of QueryResult.totalCount , it will continue to query the remaining layers, if the field is set as false, it will not continue to query. |
GeometryType |
networkType
Query type corresponding to network data set, divided into two types: point and line, and the default is line geometry object type, which is
GeometryType.LINE . |
PrjCoordSys |
prjCoordSys |
QueryOption |
queryOption
The query result option object, used to specify the content contained in the query result.
|
QueryParameter[] |
queryParams
${services_components_commontypes_QueryParameterSet_attribute_queryParams_Title}
|
int |
resampleExpectCount
The number of 2D coordinates pair returned after querying the expected resample of each factor, the default value is -1, indicating that it is not set.
|
int |
startRecord
${services_components_commontypes_QueryParameterSet_attribute_startRecord_Title}
|
Constructor and Description |
---|
QueryParameterSet()
${services_components_commontypes_QueryParameterSet_constructorByDefault_Title}
|
QueryParameterSet(QueryParameter queryParam) |
QueryParameterSet(QueryParameterSet queryParam)
${services_components_commontypes_QueryParameterSet_constructorByQueryParam_Title}
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares whether the specified object equals to the current
QueryParameterSet object. |
int |
hashCode()
Get the hash code value of query parameter set object.
|
void |
standardize()
${services_components_commontypes_QueryParameterSet_method_standardize_Title}
|
public QueryParameter[] queryParams
${services_components_commontypes_QueryParameterSet_attribute_queryParams_Title}
${services_components_commontypes_QueryParameterSet_attribute_queryParams_Description}
public int startRecord
${services_components_commontypes_QueryParameterSet_attribute_startRecord_Title}
${services_components_commontypes_QueryParameterSet_attribute_startRecord_Description}
public int expectCount
The returned number of result records in the query results, it is greater than 0.
When the query condition is querying distance, and the number of query results is greater than the expectedly returned result record number(expectCount), the distance query results are expectCount geometries randomly selected from the total query records.
When the query condition is querying the nearest geometry, and the number of query results is greater than the expectedly returned result record number(expectCount), the nearest geometry query results are expectCount geometries closest to the center from the total query records. the expectCount geometries are unordered.
${services_components_commontypes_QueryParameterSet_attribute_expectCount_Description}
public GeometryType networkType
Query type corresponding to network data set, divided into two types: point and line, and the default is line geometry object type, which is GeometryType.LINE
.
public java.lang.String customParams
Custom parameters for extended use. If user inputs geometry=null, geometry=null is the returned query results.
public QueryOption queryOption
The query result option object, used to specify the content contained in the query result. By default, it returns properties and geometric entities, i.e., QueryOption.ATTRIBUTEANDGEOMETRY
.
${services_components_commontypes_QueryParameterSet_attribute_queryOption_Description}
public int resampleExpectCount
The number of 2D coordinates pair returned after querying the expected resample of each factor, the default value is -1, indicating that it is not set. Actually resampling, if user can get less result than the value, the number of 2D coordinates pair is equal to the result; If user can not get less result than the value, the minimum value after resampling is still greater than that value,the number of 2D coordinates pair is equal to the minimum value after resampling;
${services_components_commontypes_QueryParameterSet_attribute_expectCount_Description}
public boolean ignoreTotalCount
Whether the query results returns accurate totalCount When querying multi-layer, if the number of query results of some layers meets the requirements of expectCount
, to calculate the value of QueryResult.totalCount
, it will continue to query the remaining layers, if the field is set as false, it will not continue to query. Default is false.
public PrjCoordSys prjCoordSys
public QueryParameterSet()
${services_components_commontypes_QueryParameterSet_constructorByDefault_Title}
${services_components_commontypes_QueryParameterSet_constructorByDefault_Description}
public QueryParameterSet(QueryParameter queryParam)
public QueryParameterSet(QueryParameterSet queryParam)
${services_components_commontypes_QueryParameterSet_constructorByQueryParam_Title}
${services_components_commontypes_QueryParameterSet_constructorByQueryParam_Description}
queryParam
- ${services_components_commontypes_QueryParameterSet_constructorByQueryParam_param_queryParam}java.lang.IllegalArgumentException
- ${services_components_commontypes_QueryParameterSet_constructorByQueryParam_exception_IllegalArgumentException}public void standardize()
${services_components_commontypes_QueryParameterSet_method_standardize_Title}
${services_components_commontypes_QueryParameterSet_method_standardize_Description}
public int hashCode()
Get the hash code value of query parameter set object.
hashCode
in class java.lang.Object
Object.hashCode()
public boolean equals(java.lang.Object obj)
Compares whether the specified object equals to the current QueryParameterSet
object.
equals
in class java.lang.Object
obj
- the object to compare with the current {@link QueryParameterSet object.Object.equals(java.lang.Object)