org.geomajas.layer.feature

Class SearchCriterion

java.lang.Object

org.geomajas.layer.feature.SearchCriterion

All Implemented Interfaces:

Serializable

@Api(allMethods=true)
public class SearchCriterion
extends Object
implements Serializable

A single criterion DTO that can be used to set up filters and search for features by their alpha numerical attributes.

Since:

1.6.0

Author:

Pieter De Graef

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchCriterion() Default constructor - does nothing.
SearchCriterion(String attributeName, String operator, String value) Constructor that initializes all fields with their values.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeName() Get the name of the alpha numerical attribute on which this criterion operates.
String	getOperator() Return the operator used in the criterion such as '=', '>', ...
String	getValue() Get the value for this criterion as a formatted string.
void	setAttributeName(String attributeName) Set the name of the alpha numerical attribute on which this criterion operates.
void	setOperator(String operator) Set the operator used in the criterion such as '=', '>', ...
void	setValue(String value) Set the value for this criterion as a formatted string.
String	toString() Convert to human readable form.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCriterion

public SearchCriterion()

Default constructor - does nothing.

SearchCriterion

public SearchCriterion(String attributeName,
               String operator,
               String value)

Constructor that initializes all fields with their values.

Parameters:

attributeName - Set the name of the alpha numerical attribute on which this criterion operates. This attribute name is one of the attributes from the vector layer configuration.

operator - The operator used in the criterion such as '=', '>', ...

value - The value for this criterion as a formatted string.

Method Detail

toString

public String toString()

Convert to human readable form.

Overrides:

toString in class Object

Returns:

human readable form

getOperator

public String getOperator()

Return the operator used in the criterion such as '=', '>', ...

Returns:

operator

setOperator

public void setOperator(String operator)

Set the operator used in the criterion such as '=', '>', ...

Parameters:

operator - The criterion operator.

getAttributeName

public String getAttributeName()

Get the name of the alpha numerical attribute on which this criterion operates. This attribute name is one of the attributes from the vector layer configuration.

Returns:

attribute name

setAttributeName

public void setAttributeName(String attributeName)

Set the name of the alpha numerical attribute on which this criterion operates. This attribute name is one of the attributes from the vector layer configuration.

Parameters:

attributeName - The name of the alpha numerical attribute.

getValue

public String getValue()

Get the value for this criterion as a formatted string.

Returns:

value for comparison

setValue

public void setValue(String value)

Set the value for this criterion as a formatted string.

Parameters:

value - The value for the attribute.