com.luciad.ogc.filter.model.capabilities

LuciadLightspeedClass TLcdOGCScalarFilterCapabilities

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.ogc.filter.model.capabilities.TLcdOGCScalarFilterCapabilities

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdOGCScalarFilterCapabilities
extends TLcdDataObject

Class defining a set of scalar-based filter capabilities.

This can include logical operators, comparison operators, arithmetic operators and/or functions.

See Also:

TLcdOGCFilterCapabilities

Field Summary

Fields

Modifier and Type	Field and Description
static String	BETWEEN "PropertyIsBetween" comparison capability
static String	EQUAL_TO "PropertyIsEqualTo" comparison capability
static String	GREATER_THAN "PropertyIsGreaterThan" comparison capability
static String	GREATER_THAN_EQUAL_TO "PropertyIsGreaterThanOrEqualTo" comparison capability
static String	LESS_THAN "PropertyIsLessThan" comparison capability
static String	LESS_THAN_EQUAL_TO "PropertyIsLessThanOrEqualTo" comparison capability
static String	LIKE "PropertyIsLike" comparison capability
static String	NOT_EQUAL_TO "PropertyIsNotEqualTo" comparison capability
static String	NULL_CHECK "PropertyIsNull" comparison capability
static String	SIMPLE_ARITHMETIC Filter capability that groups all the other ones

Constructor Summary

Constructors

Constructor and Description
TLcdOGCScalarFilterCapabilities() Default constructor
TLcdOGCScalarFilterCapabilities(boolean aLogicalOperatorsSupported, String[] aComparisonOperators, String[] aArithmeticOperators, String[] aArithmeticFunctions) Constructs a scalar filter capabilities object with the right parameters.

Method Summary

Modifier and Type	Method and Description
void	addArithmeticFunction(String aFunction, int aNumberOfArguments) Adds the arithmetic function with name aFunction and number of arguments equal to aNumberOfArguments to the list of supported arithmetic functions.
void	addArithmeticOperator(String aOperator) Add the arithmetic operator aOperator to the list of supported operators.
void	addComparisonOperator(String aOperator) Add a comparison operator to the list of supported comparison operators.
String	getArithmeticFunction(int index) Returns the name of the arithmetic function at aIndex in the list of arithmetic functions that are registered.
int	getArithmeticFunctionArgumentCount(String aFunction) Returns the number of arguments of the arithmetic function with name aFunction.
int	getArithmeticFunctionCount() Returns the number of arithmetic functions that are registered.
List<String>	getArithmeticFunctions()
String	getArithmeticOperator(int index) Returns the name of the arithmetic operator at aIndex in the list of arithmetic operators that are registered.
int	getArithmeticOperatorCount() Returns the number of arithmetic operators that are registered.
List<String>	getArithmeticOperators()
String	getComparisonOperator(int index) Returns the name of the comparison operator at aIndex in the list of comparison operators that are registered.
int	getComparisonOperatorCount() Returns the number of comparison operators that are registered.
List<String>	getComparisonOperators()
boolean	isSupportLogicalOperators() Returns true if the filter capabilities indicate the possibility to use logical operators.
void	removeArithmeticFunction(String aFunction) Remove the arithmetic function with name aFunctionfrom the list of supported arithmetic functions.
void	removeArithmeticOperator(String aOperator) Remove the arithmetic operator aOperator from the list of supported operators.
void	removeComparisonOperator(String aOperator) Remove the comparison operator aOperator from the list of supported comparison operators.
void	setSupportLogicalOperators(boolean aSupportLogicalOperators) Specify whether logical operators are supported.

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE_ARITHMETIC

public static final String SIMPLE_ARITHMETIC

Filter capability that groups all the other ones

See Also:

Constant Field Values

LESS_THAN

public static final String LESS_THAN

"PropertyIsLessThan" comparison capability

See Also:

Constant Field Values

GREATER_THAN

public static final String GREATER_THAN

"PropertyIsGreaterThan" comparison capability

See Also:

Constant Field Values

LESS_THAN_EQUAL_TO

public static final String LESS_THAN_EQUAL_TO

"PropertyIsLessThanOrEqualTo" comparison capability

See Also:

Constant Field Values

GREATER_THAN_EQUAL_TO

public static final String GREATER_THAN_EQUAL_TO

"PropertyIsGreaterThanOrEqualTo" comparison capability

See Also:

Constant Field Values

EQUAL_TO

public static final String EQUAL_TO

"PropertyIsEqualTo" comparison capability

See Also:

Constant Field Values

NOT_EQUAL_TO

public static final String NOT_EQUAL_TO

"PropertyIsNotEqualTo" comparison capability

See Also:

Constant Field Values

LIKE

public static final String LIKE

"PropertyIsLike" comparison capability

See Also:

Constant Field Values

BETWEEN

public static final String BETWEEN

"PropertyIsBetween" comparison capability

See Also:

Constant Field Values

NULL_CHECK

public static final String NULL_CHECK

"PropertyIsNull" comparison capability

See Also:

Constant Field Values

Constructor Detail

TLcdOGCScalarFilterCapabilities

public TLcdOGCScalarFilterCapabilities()

Default constructor

TLcdOGCScalarFilterCapabilities

public TLcdOGCScalarFilterCapabilities(boolean aLogicalOperatorsSupported,
                                       String[] aComparisonOperators,
                                       String[] aArithmeticOperators,
                                       String[] aArithmeticFunctions)

Constructs a scalar filter capabilities object with the right parameters.

Parameters:

aLogicalOperatorsSupported -

aComparisonOperators -

aArithmeticOperators -

aArithmeticFunctions -

Method Detail

setSupportLogicalOperators

public void setSupportLogicalOperators(boolean aSupportLogicalOperators)

Specify whether logical operators are supported.

Parameters:

aSupportLogicalOperators -

isSupportLogicalOperators

public boolean isSupportLogicalOperators()

Returns true if the filter capabilities indicate the possibility to use logical operators.

Returns:

true if the filter capabilities indicate the possibility to use logical operators.

getComparisonOperatorCount

public int getComparisonOperatorCount()

Returns the number of comparison operators that are registered.

Returns:

the number of comparison operators that are registered.

getComparisonOperators

public List<String> getComparisonOperators()

getComparisonOperator

public String getComparisonOperator(int index)

Returns the name of the comparison operator at aIndex in the list of comparison operators that are registered.

Parameters:

index -

Returns:

the name of the comparison operator at aIndex in the list of comparison operators that are registered.

addComparisonOperator

public void addComparisonOperator(String aOperator)

Add a comparison operator to the list of supported comparison operators.

Parameters:

aOperator -

removeComparisonOperator

public void removeComparisonOperator(String aOperator)

Remove the comparison operator aOperator from the list of supported comparison operators.

Parameters:

aOperator -

getArithmeticOperatorCount

public int getArithmeticOperatorCount()

Returns the number of arithmetic operators that are registered.

Returns:

the number of arithmetic operators that are registered.

getArithmeticOperators

public List<String> getArithmeticOperators()

getArithmeticOperator

public String getArithmeticOperator(int index)

Returns the name of the arithmetic operator at aIndex in the list of arithmetic operators that are registered.

Parameters:

index -

Returns:

the name of the arithmetic operator at aIndex in the list of arithmetic operators that are registered.

addArithmeticOperator

public void addArithmeticOperator(String aOperator)

Add the arithmetic operator aOperator to the list of supported operators.

Parameters:

aOperator -

removeArithmeticOperator

public void removeArithmeticOperator(String aOperator)

Remove the arithmetic operator aOperator from the list of supported operators.

Parameters:

aOperator -

getArithmeticFunctionCount

public int getArithmeticFunctionCount()

Returns the number of arithmetic functions that are registered.

Returns:

the number of arithmetic functions that are registered.

getArithmeticFunctions

public List<String> getArithmeticFunctions()

getArithmeticFunction

public String getArithmeticFunction(int index)

Returns the name of the arithmetic function at aIndex in the list of arithmetic functions that are registered.

Parameters:

index -

Returns:

the name of the arithmetic function at aIndex in the list of arithmetic functions that are registered.

getArithmeticFunctionArgumentCount

public int getArithmeticFunctionArgumentCount(String aFunction)

Returns the number of arguments of the arithmetic function with name aFunction.

Parameters:

aFunction -

Returns:

the number of arguments of the arithmetic function with name aFunction.

addArithmeticFunction

public void addArithmeticFunction(String aFunction,
                                  int aNumberOfArguments)

Adds the arithmetic function with name aFunction and number of arguments equal to aNumberOfArguments to the list of supported arithmetic functions.

Parameters:

aFunction -

aNumberOfArguments -

removeArithmeticFunction

public void removeArithmeticFunction(String aFunction)

Remove the arithmetic function with name aFunctionfrom the list of supported arithmetic functions.

Parameters:

aFunction -