org.geomajas.command.dto
Class SearchFeatureRequest

java.lang.Object
  org.geomajas.command.LayerIdCommandRequest
      org.geomajas.command.dto.SearchFeatureRequest

All Implemented Interfaces:

Serializable, CommandRequest

@Api(allMethods=true)
public class SearchFeatureRequest
extends LayerIdCommandRequest

Request object for SearchFeatureCommand.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:

Serialized Form

Field Summary

static String	COMMAND Command name for this request.
static String	ID_ATTRIBUTE Field ID to use to always get the id field.
static int	MAX_UNLIMITED Use this number as maximum to indicate that all results should be returned.

Constructor Summary

SearchFeatureRequest()

Method Summary

String	getBooleanOperator() Get boolean operator for combining the different search criteria.
SearchCriterion[]	getCriteria() Get the list of search criteria.
String	getCrs() Get the coordinate reference space which should be used for the returned geometries.
int	getFeatureIncludes() Get which data should be included in the features.
String	getFilter() Get the filter expression which should be applied on the layer.
int	getMax() Get the maximum number of features which may be returned.
int	getOffSet() Get the index of the first feature to be returned.
void	setBooleanOperator(String booleanOperator) Set boolean operator for combining the different search criteria.
void	setCriteria(SearchCriterion[] criteria) Set the list of search criteria.
void	setCrs(String crs) Set the coordinate reference space which should be used for the returned geometries.
void	setFeatureIncludes(int featureIncludes) Set the data to include in the features which are returned.
void	setFilter(String filter) Set the filter expression which should be applied on the layer.
void	setMax(int max) Set the maximum number of features which may be returned.
void	setOffSet(int offSet) Set the index of the first feature to be returned.
String	toString()

Methods inherited from class org.geomajas.command.LayerIdCommandRequest

getLayerId, setLayerId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMAND

public static final String COMMAND

Command name for this request.

Since:

1.9.0

See Also:

Constant Field Values

MAX_UNLIMITED

public static final int MAX_UNLIMITED

Use this number as maximum to indicate that all results should be returned.

See Also:

Constant Field Values

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

Field ID to use to always get the id field.

See Also:

Constant Field Values

Constructor Detail

SearchFeatureRequest

public SearchFeatureRequest()

Method Detail

getMax

public int getMax()

Get the maximum number of features which may be returned.

The default value is to have unlimited of features returned.

Returns:

max number of features to return of MAX_UNLIMITED (0) for unlimited.

setMax

public void setMax(int max)

Set the maximum number of features which may be returned.

Parameters:

max - max number of features to return, or MAX_UNLIMITED (0) for unlimited.

getOffSet

public int getOffSet()

Get the index of the first feature to be returned. This is useful for layers that support paging.

Returns:

the offset

Since:

1.10.0

setOffSet

public void setOffSet(int offSet)

Set the index of the first feature to be returned. This is useful for layers that support paging.

Parameters:

offSet - the offset

Since:

1.10.0

getBooleanOperator

public String getBooleanOperator()

Get boolean operator for combining the different search criteria.

Returns:

boolean operator, possible values include "and" and "or"

setBooleanOperator

public void setBooleanOperator(String booleanOperator)

Set boolean operator for combining the different search criteria.

Parameters:

booleanOperator - boolean operator, possible values include "and" and "or"

getCriteria

public SearchCriterion[] getCriteria()

Get the list of search criteria.

Returns:

list of search criteria

setCriteria

public void setCriteria(SearchCriterion[] criteria)

Set the list of search criteria.

Parameters:

criteria - list of criteria

getFilter

public String getFilter()

Get the filter expression which should be applied on the layer.

If the filter contains a geometry, then this needs to be in layer CRS, it is not converted!

Returns:

filter expression

setFilter

public void setFilter(String filter)

Set the filter expression which should be applied on the layer.

If the filter contains a geometry, then this needs to be in layer CRS, it is not converted!

Parameters:

filter - filter expression

getCrs

public String getCrs()

Get the coordinate reference space which should be used for the returned geometries.

Returns:

crs

setCrs

public void setCrs(String crs)

Set the coordinate reference space which should be used for the returned geometries.

Parameters:

crs - crs

getFeatureIncludes

public int getFeatureIncludes()

Get which data should be included in the features. For possible values, see VectorLayerService.

Returns:

what to include

setFeatureIncludes

public void setFeatureIncludes(int featureIncludes)

Set the data to include in the features which are returned. For possible values, see VectorLayerService.

Parameters:

featureIncludes - what the include

toString

public String toString()

Overrides:

toString in class Object