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

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

All Implemented Interfaces:

QueryCriteria, java.io.Serializable

public class TextCriteria
extends java.lang.Object
implements QueryCriteria, java.io.Serializable

Defines an attribute search. QueryHandler will search all the search fields for the given text.

See Also:

Serialized Form

Field Summary

static java.lang.String

CRITERIA_TYPE The criteria type: "Text"

Constructor Summary

TextCriteria()
Instantiates an empty object of TextCriteria.

TextCriteria(java.lang.String searchText, boolean contains, java.util.List<java.lang.String> searchFields)
Instantiates an object of TextCriteria.

Method Summary

java.lang.String	getCriteriaType() A String representing the query type e.g.
java.lang.String	getDisplayFieldName() Gets the field name which can be used in the query result as a result node title.
java.util.List<? extends LayerDefinition>	getLayerDefinitions() Returns the list of LayerDefinition associated with this query.
int	getMaxRecordCount() Gets the maximum number of returning records in one query.
java.util.List<java.lang.String>	getReturnFields() Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.getReturnFields()
java.util.List<java.lang.String>	getSearchFields() Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.getSearchFields()
java.lang.String	getSearchText() Sets the text to search.
boolean	isContains() Returns true if the search text can be part of the field value.
boolean	isFetchResultDetails() Returns true if all the feature details e.g.
void	setContains(boolean contains) Sets to true if the search text can be part of the field value.
void	setDisplayFieldName(java.lang.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(java.util.List<? extends LayerDefinition> layerDefinitions) Sets the list of LayerDefinition objects associated with this query.
void	setMaxRecordCount(int maxRecordCount) Sets the maximum number of returning records in one query.
void	setReturnFields(java.util.List<java.lang.String> returnFields) Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.setReturnFields(List)
void	setSearchFields(java.util.List<java.lang.String> searchFields) Deprecated. As of ArcGIS Java Server 9.3, instead use LayerDefinition.setSearchFields(List)
void	setSearchText(java.lang.String findText) Gets the search target.
java.lang.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 java.lang.String CRITERIA_TYPE

The criteria type: "Text"

See Also:

Constant Field Values

Constructor Detail

TextCriteria

public TextCriteria()

Instantiates an empty object of TextCriteria.

TextCriteria

public TextCriteria(java.lang.String searchText,
                    boolean contains,
                    java.util.List<java.lang.String> searchFields)

Instantiates an object of TextCriteria.

Parameters:

searchText - the text for search.

contains - set to true if the text can be part of the field value.

searchFields - the field to search with.

Method Detail

getCriteriaType

public java.lang.String getCriteriaType()

Description copied from interface: QueryCriteria

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

Specified by:

getCriteriaType in interface QueryCriteria

getDisplayFieldName

public java.lang.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(java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.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()

Description copied from interface: QueryCriteria

Gets the maximum number of returning records in one query.

Specified by:

getMaxRecordCount in interface QueryCriteria

Returns:

the maximum number of returning records.

setMaxRecordCount

public void setMaxRecordCount(int maxRecordCount)

Description copied from interface: QueryCriteria

Sets the maximum number of returning records in one query.

Specified by:

setMaxRecordCount in interface QueryCriteria

Parameters:

maxRecordCount - the new value.

isContains

public boolean isContains()

Returns true if the search text can be part of the field value.

setContains

public void setContains(boolean contains)

Sets to true if the search text can be part of the field value.

Parameters:

contains -

getSearchText

public java.lang.String getSearchText()

Sets the text to search.

setSearchText

public void setSearchText(java.lang.String findText)

Gets the search target.

getSearchFields

@Deprecated
public java.util.List<java.lang.String> getSearchFields()

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

Returns the list of search field names.

setSearchFields

@Deprecated
public void setSearchFields(java.util.List<java.lang.String> searchFields)

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

Sets the list of search field names. Spatial operation is performed based on the specified return fields.

getReturnFields

@Deprecated
public java.util.List<java.lang.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(java.util.List<java.lang.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(java.util.List<? extends LayerDefinition> layerDefinitions)

Sets the list of LayerDefinition objects associated with this query.

Parameters:

layerDefinitions - the list of layer definition objects

getLayerDefinitions

public java.util.List<? extends LayerDefinition> getLayerDefinitions()

Returns the list of LayerDefinition associated with this query.

Returns:

the list of layer definition objects