com.supermap.services

Class ServiceQueryParameter

  • java.lang.Object
    • com.supermap.services.ServiceQueryParameter


  • public class ServiceQueryParameter
    extends java.lang.Object
    The Service QueryParameter of iServer.
    • Constructor Detail

      • ServiceQueryParameter

        public ServiceQueryParameter()
        The default constructor for constructing a new ServiceQueryParameter object.
    • Method Detail

      • getQueryMapName

        public java.lang.String getQueryMapName()
        Gets the map name of service query.
        Returns:
        The map name to query.
      • setQueryMapName

        public void setQueryMapName(java.lang.String MapName)
        Sets the map name of query map.
        Parameters:
        MapName - The map name to set.
      • getQueryServiceName

        public java.lang.String getQueryServiceName()
        Gets the service name of service instance of current query.
        Returns:
        The default value is Rest and it is the service name of instance.
      • setQueryServiceName

        public void setQueryServiceName(java.lang.String ServiceName)
        Sets the service name of service instance of current query.
        Parameters:
        ServiceName - the service name of service instance
      • getQueryRecordStart

        public int getQueryRecordStart()
        Gets the origin location of query records.
        Returns:
        The origin location of the record.
      • setQueryRecordStart

        public void setQueryRecordStart(int RecordStart)
        Sets the origin location of query records.
        Parameters:
        RecordStart - Sets the index of the record origin location.
      • getExpectRecordCount

        public int getExpectRecordCount()
        Gets the query record number expected to return. The default is 10 records.
        Returns:
        The number of query record.
      • setExpectRecordCount

        public void setExpectRecordCount(int RecordCount)
        Sets the query record number expected to return.
        Parameters:
        RecordCount - Sets the expected query record number.
      • setQueryDistance

        public void setQueryDistance(double distance)
        Sets the query distance.
        Parameters:
        distance - set distance
      • getQueryDistance

        public double getQueryDistance()
        Returns the query distance.
        Returns:
        The query distance.
      • setQueryGeomety

        public void setQueryGeomety(Geometry geometry)
        Sets the geometry object to query.
        Parameters:
        geometry - The geometry object to be set.
      • getQueryGeomety

        public Geometry getQueryGeomety()
        Returns the geometry object to query.
        Returns:
        The geometrical object.
      • getQueryOption

        public QueryOption getQueryOption()
        Returns content type of query result.
        Returns:
        The content type of query result.
      • setQueryOption

        public void setQueryOption(QueryOption QueryOption)
        Sets the content type of query result.
        Parameters:
        QueryOption - The type constant to be set.
      • getQueryLayerName

        public java.lang.String getQueryLayerName()
        Gets the query layer name.
        Returns:
        The name of the layer.
      • setQueryLayerName

        public void setQueryLayerName(java.lang.String QueryLayerName)
        Sets the layer name of current query.
        Parameters:
        QueryLayerName - the layer name to be set
      • setQueryBounds

        public void setQueryBounds(Rectangle2D queryBounds)
        Sets the query range.
        Parameters:
        queryBounds - the query range.
      • getQueryBounds

        public Rectangle2D getQueryBounds()
        Gets query scope.
        Returns:
        Search Scope
      • toJson

        public java.lang.String toJson()
        Converts the query parameter into JSON string.
        Returns:
        The converted JSON string.
      • getSpatialQueryMode

        public SpatialQueryMode getSpatialQueryMode()
        Gets the operation mode of the spatial query
        Returns:
        The operation mode of the spatial query.
      • setSpatialQueryMode

        public void setSpatialQueryMode(SpatialQueryMode value)
        Sets the operation mode of the spatial query
        Parameters:
        value - the operation mode of the spatial query.
      • getAttributeFilter

        public java.lang.String getAttributeFilter()
        Obtains SQL conditional statement to be queried
        Returns:
        SQL conditional statement
      • setAttributeFilter

        public void setAttributeFilter(java.lang.String value)
        Sets SQL conditional statement to be queried
        Parameters:
        value - SQL conditional statement
      • getOrderBy

        public java.lang.String[] getOrderBy()
        Obtains SQL query sort clause
        Returns:
        SQL query sort clause
      • setOrderBy

        public void setOrderBy(java.lang.String[] value)
        Sets SQL query sort clause
        Parameters:
        value - SQL query sort clause
      • getGroupBy

        public java.lang.String[] getGroupBy()
        Obtains SQL query grouping conditional clause
        Returns:
        SQL query grouping conditional clause
      • setGroupBy

        public void setGroupBy(java.lang.String[] value)
        Sets SQL query grouping conditional clause
        Parameters:
        value - SQL query grouping conditional clause
      • getResultFields

        public java.lang.String[] getResultFields()
        Obtains the result field set of the query.
        Returns:
        The result field set of the query.
      • setResultFields

        public void setResultFields(java.lang.String[] value)
        Sets the result filed set of the query. if it is null, query all field.
        Parameters:
        value - The result field set of the query.