Package com.peterphi.std.guice.restclient.jaxb.webquery

Class WQConstraint

java.lang.Object

com.peterphi.std.guice.restclient.jaxb.webquery.WQConstraintLine

com.peterphi.std.guice.restclient.jaxb.webquery.WQConstraint

public class WQConstraint
extends WQConstraintLine

Defines an individual field constraint to apply

Field Summary

Fields

Modifier and Type	Field	Description
String	field
WQFunctionType	function
String	value
String	value2	The second value (for binary functions). Should only be supplied if function is supplied and if it refers to a binary function such as WQFunctionType.RANGE
List<String>	valuelist

Constructor Summary

Constructors

Constructor	Description
WQConstraint()
WQConstraint(String field, WQFunctionType function, String value)
WQConstraint(String field, WQFunctionType function, String left, String right)
WQConstraint(String field, WQFunctionType function, List<String> values)

Method Summary

Modifier and Type	Method	Description
static WQConstraint	contains(String field, Object value)
static WQConstraint	decode(String field, String rawValue)	Produce a WebQueryConstraint from a Query String format parameter
String	encodeValue()	Encode this constraint in the query string value format
static WQConstraint	eq(String field, Object value)
static WQConstraint	eqRef(String field, String field2)
static WQConstraint	ge(String field, Object value)
static WQConstraint	geRef(String field, String field2)
static WQConstraint	gt(String field, Object value)
static WQConstraint	gtRef(String field, String field2)
static WQConstraint	in(String field, Collection<?> values)
static WQConstraint	isNotNull(String field)
static WQConstraint	isNull(String field)
static WQConstraint	le(String field, Object value)
static WQConstraint	leRef(String field, String field2)
static WQConstraint	lt(String field, Object value)
static WQConstraint	ltRef(String field, String field2)
static WQConstraint	neq(String field, Object value)
static WQConstraint	neqRef(String field, String field2)
WQConstraintLine	not()
static WQConstraint	notContains(String field, Object value)
static WQConstraint	notIn(String field, Collection<?> values)
static WQConstraint	notStartsWith(String field, Object value)
static WQConstraint	range(String field, Object from, Object to)
static WQConstraint	startsWith(String field, Object value)
void	toQueryFragment(StringBuilder sb)
String	toString()
static String	toString(Object value)

Methods inherited from class java.lang.Object

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

Field Details

field

public String field

function

public WQFunctionType function

value

public String value

valuelist

public List<String> valuelist

value2

public String value2

The second value (for binary functions).
Should only be supplied if function is supplied and if it refers to a binary function such as WQFunctionType.RANGE

Constructor Details

WQConstraint

public WQConstraint()

WQConstraint

public WQConstraint(String field,
 WQFunctionType function,
 String value)

WQConstraint

public WQConstraint(String field,
 WQFunctionType function,
 String left,
 String right)

WQConstraint

public WQConstraint(String field,
 WQFunctionType function,
 List<String> values)

Method Details

not

public WQConstraintLine not()

Overrides:

not in class WQConstraintLine

toString

public String toString()

Overrides:

toString in class Object

encodeValue

public String encodeValue()

Encode this constraint in the query string value format

Returns:

eq

public static WQConstraint eq(String field,
 Object value)

in

public static WQConstraint in(String field,
 Collection<?> values)

notIn

public static WQConstraint notIn(String field,
 Collection<?> values)

neq

public static WQConstraint neq(String field,
 Object value)

isNull

public static WQConstraint isNull(String field)

isNotNull

public static WQConstraint isNotNull(String field)

lt

public static WQConstraint lt(String field,
 Object value)

le

public static WQConstraint le(String field,
 Object value)

gt

public static WQConstraint gt(String field,
 Object value)

ge

public static WQConstraint ge(String field,
 Object value)

contains

public static WQConstraint contains(String field,
 Object value)

notContains

public static WQConstraint notContains(String field,
 Object value)

startsWith

public static WQConstraint startsWith(String field,
 Object value)

notStartsWith

public static WQConstraint notStartsWith(String field,
 Object value)

range

public static WQConstraint range(String field,
 Object from,
 Object to)

eqRef

public static WQConstraint eqRef(String field,
 String field2)

neqRef

public static WQConstraint neqRef(String field,
 String field2)

leRef

public static WQConstraint leRef(String field,
 String field2)

ltRef

public static WQConstraint ltRef(String field,
 String field2)

geRef

public static WQConstraint geRef(String field,
 String field2)

gtRef

public static WQConstraint gtRef(String field,
 String field2)

decode

public static WQConstraint decode(String field,
 String rawValue)

Produce a WebQueryConstraint from a Query String format parameter

Parameters:

field -

rawValue -

Returns:

toQueryFragment

public void toQueryFragment(StringBuilder sb)

Specified by:

toQueryFragment in class WQConstraintLine

toString

public static String toString(Object value)