Package ddf.catalog.filter

Interface ArgumentBuilder

public interface ArgumentBuilder

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library. Completes the fluent API to create a Filter for a function that takes N parameters.

Method Summary

Modifier and Type	Method	Description
ArgumentBuilder	attributeArg(String name)	Continues building the ArgumentBuilder based on an attribute
ArgumentBuilder	boolArg(boolean arg)	Continues building the ArgumentBuilder based on a boolean value
ArgumentBuilder	bytesArg(byte[] bytes)	Continues building the ArgumentBuilder based on byte value
ArgumentBuilder	dateArg(Date date)	Continues building the ArgumentBuilder based on a Date
ArgumentBuilder	dateRangeArg(Date begin, Date end)	Continues building the ArgumentBuilder based on a range defined by two Date instances
EqualityExpressionBuilder	equalTo()	Currently only propertyIsEqualTo(Function,val) is supported so instead supporting ExpressionBuilder is() the api just has equalTo
ArgumentBuilder	numberArg(double arg)	Continues building the ArgumentBuilder based on a double
ArgumentBuilder	numberArg(float arg)	Continues building the ArgumentBuilder based on a float
ArgumentBuilder	numberArg(int arg)	Continues building the ArgumentBuilder based on a int
ArgumentBuilder	numberArg(long arg)	Continues building the ArgumentBuilder based on a long
ArgumentBuilder	numberArg(short arg)	Continues building the ArgumentBuilder based on a short
ArgumentBuilder	objArg(Object obj)	Continues building the ArgumentBuilder based on a object value
ArgumentBuilder	textArg(String text)	Continues building the ArgumentBuilder based on a text value
ArgumentBuilder	wktArg(String wkt)	Continues building the ArgumentBuilder based on a WKT shape

Method Details

numberArg

ArgumentBuilder numberArg(float arg)

Continues building the ArgumentBuilder based on a float

Parameters:

arg - - float argument

Returns:

ArgumentBuilder

numberArg

ArgumentBuilder numberArg(double arg)

Continues building the ArgumentBuilder based on a double

Parameters:

arg - - double argument

Returns:

ArgumentBuilder

numberArg

ArgumentBuilder numberArg(int arg)

Continues building the ArgumentBuilder based on a int

Parameters:

arg - - int argument

Returns:

ArgumentBuilder

numberArg

ArgumentBuilder numberArg(short arg)

Continues building the ArgumentBuilder based on a short

Parameters:

arg - - short argument

Returns:

ArgumentBuilder

numberArg

ArgumentBuilder numberArg(long arg)

Continues building the ArgumentBuilder based on a long

Parameters:

arg - - long argument

Returns:

ArgumentBuilder

wktArg

ArgumentBuilder wktArg(String wkt)

Continues building the ArgumentBuilder based on a WKT shape

Parameters:

wkt - - WKT-defined shape (2D)

Returns:

ArgumentBuilder

dateArg

ArgumentBuilder dateArg(Date date)

Continues building the ArgumentBuilder based on a Date

Parameters:

date - - Date

Returns:

ArgumentBuilder

dateRangeArg

ArgumentBuilder dateRangeArg(Date begin,
 Date end)

Continues building the ArgumentBuilder based on a range defined by two Date instances

Parameters:

begin - - Date defining beginning of the range

end - - Date defining end of the range

Returns:

ArgumentBuilder

boolArg

ArgumentBuilder boolArg(boolean arg)

Continues building the ArgumentBuilder based on a boolean value

Parameters:

arg - - boolean argument

Returns:

ArgumentBuilder

bytesArg

ArgumentBuilder bytesArg(byte[] bytes)

Continues building the ArgumentBuilder based on byte value

Parameters:

bytes - byte array

Returns:

ArgumentBuilder

textArg

ArgumentBuilder textArg(String text)

Continues building the ArgumentBuilder based on a text value

Parameters:

text - - String argument to ArgumentBuilder on

Returns:

ArgumentBuilder

objArg

ArgumentBuilder objArg(Object obj)

Continues building the ArgumentBuilder based on a object value

Parameters:

obj - - Object argument to ArgumentBuilder on

Returns:

ArgumentBuilder

attributeArg

ArgumentBuilder attributeArg(String name)

Continues building the ArgumentBuilder based on an attribute

Parameters:

name - - String argument to ArgumentBuilder on

Returns:

ArgumentBuilder

equalTo

EqualityExpressionBuilder equalTo()

Currently only propertyIsEqualTo(Function,val) is supported so instead supporting ExpressionBuilder is() the api just has equalTo

Continue building a Filter with the "equal to" operator ( PropertyIsEqualTo)

Returns:

EqualityExpressionBuilder to continue building the Filter