public class QueryParameter
extends java.lang.Object
implements java.io.Serializable
${services_components_commontypes_QueryParameter_Title}
${services_components_commontypes_QueryParameter_Description}
The following codes show how to construct an ordinary query parameter object of a layer, the corresponding data information in world map of the sample data :
QueryParameter queryParam = new QueryParameter(); // Queries the capital city with a population of more than 10 million // Specifies the name of the layer to be queried queryParam.name = "Capitals@World"; // Sets spl query condition for layer element queryParam.attributeFilter = "Cap_Pop > 10000000"; // Sets returned field info queryParam.fields = new String[]{"Cap_pop"}; // Group according to the fields below // queryParam.groupBy = "SMID"; // Matches and queries according to SMID fields, combines with attributeFilter // queryParam.ids = new int[]{1,2,3,4}; // Sorts according to SMID fields // queryParam.orderBy = "SMID"; queryParameterSet.queryParams[0] = queryParam;
The following codes show how to construct an query parameter join the foreign, the corresponding data information in world map of the sample data :
QueryParameter queryParam = new QueryParameter(); // Specifies the name of the layer to be queried queryParam.name = "Capitals@World"; // Sets returned field info, the following sets are the fields joining to the foreign queryParam.fields = new String[]{"Pop_1994"}; // Sets join item JoinItem joinItem = new JoinItem(); // Join foreign table name joinItem.foreignTableName = "Countries"; // Join query sentence joinItem.joinFilter = "Capitals.Country=Countries.Country"; // Join type joinItem.joinType = JoinType.INNERJOIN; queryParam.joinItems = new JoinItem[]{joinItem};
QueryParameterSet
, DatasetInfo
, Serialized FormModifier and Type | Field and Description |
---|---|
java.lang.String |
attributeFilter
The attributes filter condition.
|
java.lang.String[] |
fields
${services_components_commontypes_QueryParameter_attribute_returnFields_Title}
|
java.lang.String |
groupBy
The fields of results grouping conditions in SQL query.
|
int[] |
ids
${services_components_commontypes_QueryParameter_attribute_ids_Title}
|
JoinItem[] |
joinItems
Join query item array
|
LinkItem[] |
linkItems
Join info of foreign table.
|
java.lang.String |
name
Data set name, or layer name, depending on the actual functions.
|
java.lang.String |
orderBy
The field of results sorting in SQL query and spatial query .
|
Constructor and Description |
---|
QueryParameter()
${services_components_commontypes_QueryParameter_constructorByDefault_Title}
|
QueryParameter(QueryParameter queryParam)
${services_components_commontypes_QueryParameter_constructorByQueryParam_Title}
|
QueryParameter(java.lang.String name)
${services_components_commontypes_QueryParameter_constructorByName_Title}
|
QueryParameter(java.lang.String name, java.lang.String attributeFilter)
${services_components_commontypes_QueryParameter_constructorByNameAndWhereClause_Title}
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares whether the specified object equals to the current
QueryParameter object. |
int |
hashCode()
Gets the hash code value of
QueryParameter object. |
public java.lang.String name
Data set name, or layer name, depending on the actual functions.
In general the field is the data set name, but when operating the function related to the map, needs to set name for layer (layer name format: data set name @ data alias). Because a map layer may be from data sets of different data sources, and different data sources may exist the same data sets, using the data set name the data sets cannot be uniquely determined, so when operating the function related to the map, needs to set the value as the layer name.
Querying CAD data sets and CAD layers is not currently supported
public JoinItem[] joinItems
Join query item array
Valid when querying SQL.
public LinkItem[] linkItems
Join info of foreign table.
Valid when querying SQL.
public int[] ids
${services_components_commontypes_QueryParameter_attribute_ids_Title}
${services_components_commontypes_QueryParameter_attribute_ids_Description}
public java.lang.String attributeFilter
The attributes filter condition.
The format of WHERE clause of SQL sentence is WHERE < Condition expression >,attributeFilter that is "condition expression".
The use of this field is attributeFilter = "filter condition".
For example, to query a record which is less than 100 of fieldValue fields, sets attributeFilter = "fieldValue < 100"; To query a record of fields whose value is "hotel", sets attributeFilter = "name like "%hotel%",and so on.
public java.lang.String orderBy
The field of results sorting in SQL query and spatial query . The fields used for sorting must be numeric.
The format of ORDER BY clause of SQL sentence is ORDER BY < Or ORDER BY < Column name sorting rules >. The column name is the name of each column in the attribute table, column can also be called attribute, named as field in SuperMap, sets orderBy as field name. Sorting rules are to sort in ascending or descending order of field, asc represents ascending order, desc represents descending order, if does not specify the sorting rules, sorts by ascending order.
When sorting single field, the use of this field is orderBy ="field name", ascending order is orderBy = "field name asc"; descending order is orderBy = "field name dec"; When sorting multiple fields, the fields are separated by commas, the use is orderBy = "field name 1, field name 2 asc, field name 2 desc".
For example, in a national data set, there are two fields and the field names are respectively “SmArea” and “pop_1994”, the area of the country and the population of each country in 1994 are expressed respectively. If the records are sorted according to the population of each country, sets orderBy = "pop_1994"; If you want to sort in area descending and population ascending order, set orderBy = "SmArea desc, pop_1994 asc".
Valid when querying SQL and space.
public java.lang.String groupBy
The fields of results grouping conditions in SQL query.
The format of GROUP BY clause of SQL sentence is GROUP BY < Column name >,the column name is the name of each column in the attribute table, column can also be called attribute, named as field in SuperMap, sets groupBy as field name.
When grouping single field, the use of this field is groupBy ="field name", When grouping multiple fields, the fields are separated by commas, the use is groupBy = "field name 1, field name 2".
For example, there is a global cities data set that has two fields, the field names are respectively “Continent” and “Country”, State and country that a city belongs to can be expressed respectively, ;if global cities are grouped according to the countries, sets groupBy = "Country"; if cities are grouped according to the states and countries, sets groupBy = "Continent, Country".
Valid when querying SQL. Note: Spatial query does not support groupBy field, otherwise, the result of the spatial query may not be correct.
public java.lang.String[] fields
${services_components_commontypes_QueryParameter_attribute_returnFields_Title}
${services_components_commontypes_QueryParameter_attribute_returnFields_Description}
public QueryParameter()
${services_components_commontypes_QueryParameter_constructorByDefault_Title}
${services_components_commontypes_QueryParameter_constructorByDefault_Description}
public QueryParameter(QueryParameter queryParam)
${services_components_commontypes_QueryParameter_constructorByQueryParam_Title}
${services_components_commontypes_QueryParameter_constructorByQueryParam_Description}
queryParam
- ${services_components_commontypes_QueryParameter_constructorByQueryParam_param_queryParam}java.lang.IllegalArgumentException
- ${services_components_commontypes_QueryParameter_constructorByQueryParam_exception_IllegalArgumentException}public QueryParameter(java.lang.String name)
${services_components_commontypes_QueryParameter_constructorByName_Title}
${services_components_commontypes_QueryParameter_constructorByName_Description}
name
- ${services_components_commontypes_QueryParameter_constructorByName_param_name}public QueryParameter(java.lang.String name, java.lang.String attributeFilter)
${services_components_commontypes_QueryParameter_constructorByNameAndWhereClause_Title}
${services_components_commontypes_QueryParameter_constructorByNameAndWhereClause_Description}
name
- ${services_components_commontypes_QueryParameter_constructorByNameAndWhereClause_param_name}attributeFilter
- ${services_components_commontypes_QueryParameter_constructorByNameAndWhereClause_param_whereClause}public int hashCode()
Gets the hash code value of QueryParameter
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 QueryParameter
object.
equals
in class java.lang.Object
obj
- the object to compare with the current QueryParameter
object.Object.equals(java.lang.Object)