edu.ucdavis.cstars.client.tasks

Class RelationshipQuery

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.RelationshipQuery

public class RelationshipQuery
extends com.google.gwt.core.client.JavaScriptObject

Define query parameters for the feature layer's queryRelateFeatures method.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static RelationshipQuery	create() Create a new RelationshipQuery object
void	returnGeometry(boolean returnGeometry) Should the returned FeatureSet include geometry.
void	setDefinitionExpression(java.lang.String expression) Set the definition expression for this query
void	setMaxAllowableOffset(int maxOffset) Set the max allowable offset for this query
void	setObjectIds(int[] ids) Set the object ids for this query
void	setOutfields(java.lang.String[] outfields) Set the outfields for this query
void	setOutSpatialReference(SpatialReference outSpatialReference) Set the spatial reference for the returned geometry
void	setRelationshipId(int relationshipId) Set the relationship id for this query

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static RelationshipQuery create()

Create a new RelationshipQuery object

Returns:

RelationshipQuery

setDefinitionExpression

public final void setDefinitionExpression(java.lang.String expression)

Set the definition expression for this query

Parameters:

expression - - The definition expression to be applied to the related table or layer. Only records that fit the definition expression and are in the list of ObjectIds will be returned.

setMaxAllowableOffset

public final void setMaxAllowableOffset(int maxOffset)

Set the max allowable offset for this query

Parameters:

maxOffset - - The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.

setObjectIds

public final void setObjectIds(int[] ids)

Set the object ids for this query

Parameters:

ids - - Int array of objectIds for the features in the layer/table that you want to query.

setOutfields

public final void setOutfields(java.lang.String[] outfields)

Set the outfields for this query

Parameters:

outfields - - fields to include in the FeatureSet. Fields must exist in the map layer. You must list the actual field names rather than the alias names. Returned fields are also the actual field names. However, you are able to use the alias names when you display the results. You can set field alias names in the map document. When you specify the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the faster the response will be. Each query must have access to the Shape and Objectid fields for a layer, but your list of fields does not need to include these two fields.

setOutSpatialReference

public final void setOutSpatialReference(SpatialReference outSpatialReference)

Set the spatial reference for the returned geometry

Parameters:

outSpatialReference - - The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map.

setRelationshipId

public final void setRelationshipId(int relationshipId)

Set the relationship id for this query

Parameters:

relationshipId - - The ID of the relationship to test. The ids for the relationships the table or layer particpates in are listed in the the ArcGIS Services directory.

returnGeometry

public final void returnGeometry(boolean returnGeometry)

Should the returned FeatureSet include geometry.

Parameters:

returnGeometry - - If "true", each feature in the FeatureSet includes the geometry. Set to "false" (default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.