com.esri.adf.web.data.query
Class PredefinedQueryCriteria

java.lang.Object
  com.esri.adf.web.data.query.PredefinedQueryCriteria

All Implemented Interfaces:

QueryCriteria, Serializable

public class PredefinedQueryCriteria
extends Object
implements QueryCriteria, Serializable

PredefinedQueryCriteria defines a where clause query. Some of resources support query by where clause, but the format of it may be vary from resource to resource.

See QueryAttributesTask and SearchAttributesTask for details.

See Also:

Serialized Form

Field Summary

static String	CRITERIA_TYPE Criteria type constant: "PredefinedQuery";
protected String	whereClause Where clause of the query.

Constructor Summary

PredefinedQueryCriteria()

Method Summary

String	getCriteriaType() A String representing the query type e.g.
String	getDisplayFieldName() Gets the field name which can be used in the query result as a result node title.
List<? extends LayerDefinition>	getLayerDefinitions() Returns the list of LayerDefinition.
int	getMaxRecordCount() Returns the number of records that will be returned for the query operation.
List<String>	getReturnFields() Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.getReturnFields()
String	getWhereClause() Gets the where clause of the query.
boolean	isFetchResultDetails() Returns true if all the feature details e.g.
void	setDisplayFieldName(String displayFieldName) Sets the field name which can be used in the query result as a result node title.
void	setFetchResultDetails(boolean fetchResultDetails) Sets to true to return all the feature details e.g.
void	setLayerDefinitions(List<? extends LayerDefinition> layerDefinitions) Sets the list of LayerDefinition objects.
void	setMaxRecordCount(int maxRecordCount) Sets the number of records to be returned for the query operation.
void	setReturnFields(List<String> returnFields) Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.setReturnFields(List)
void	setWhereClause(String findText) Sets the where clause of the query.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CRITERIA_TYPE

public static final String CRITERIA_TYPE

Criteria type constant: "PredefinedQuery";

See Also:

Constant Field Values

whereClause

protected String whereClause

Where clause of the query.

Constructor Detail

PredefinedQueryCriteria

public PredefinedQueryCriteria()

Method Detail

getCriteriaType

public String getCriteriaType()

Description copied from interface: QueryCriteria

A String representing the query type e.g. "Identify"

Specified by:

getCriteriaType in interface QueryCriteria

getDisplayFieldName

public String getDisplayFieldName()

Description copied from interface: QueryCriteria

Gets the field name which can be used in the query result as a result node title.

Specified by:

getDisplayFieldName in interface QueryCriteria

Returns:

the field name.

setDisplayFieldName

public void setDisplayFieldName(String displayFieldName)

Description copied from interface: QueryCriteria

Sets the field name which can be used in the query result as a result node title.

Specified by:

setDisplayFieldName in interface QueryCriteria

toString

public String toString()

Overrides:

toString in class Object

isFetchResultDetails

public boolean isFetchResultDetails()

Description copied from interface: QueryCriteria

Returns true if all the feature details e.g. fields should be returned.

Specified by:

isFetchResultDetails in interface QueryCriteria

setFetchResultDetails

public void setFetchResultDetails(boolean fetchResultDetails)

Description copied from interface: QueryCriteria

Sets to true to return all the feature details e.g. fields.

Specified by:

setFetchResultDetails in interface QueryCriteria

getMaxRecordCount

public int getMaxRecordCount()

Returns the number of records that will be returned for the query operation. The default value is -1 which will return all records.

Specified by:

getMaxRecordCount in interface QueryCriteria

Returns:

the record limit

setMaxRecordCount

public void setMaxRecordCount(int maxRecordCount)

Sets the number of records to be returned for the query operation.

Specified by:

setMaxRecordCount in interface QueryCriteria

Parameters:

maxRecordCount - the record limit

getWhereClause

public String getWhereClause()

Gets the where clause of the query. The format of the where clause may be vary from resource to resource. See QueryAttributesTask and SearchAttributesTask for details.

Returns:

the where clause string.

setWhereClause

public void setWhereClause(String findText)

Sets the where clause of the query. The format of the where clause may be vary from resource to resource. See QueryAttributesTask and SearchAttributesTask for details.

Parameters:

findText -

getReturnFields

@Deprecated
public List<String> getReturnFields()

Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.getReturnFields()

Returns the list of return field names.

setReturnFields

@Deprecated
public void setReturnFields(List<String> returnFields)

Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.setReturnFields(List)

Sets the list of return field names. Only the field names in the list will be returned in QueryResult.getDetails().

setLayerDefinitions

public void setLayerDefinitions(List<? extends LayerDefinition> layerDefinitions)

Sets the list of LayerDefinition objects.

Parameters:

layerDefinitions - the list of layer definition objects

getLayerDefinitions

public List<? extends LayerDefinition> getLayerDefinitions()

Returns the list of LayerDefinition.

Returns:

the list of layer definition objects