com.dslplatform.client

Class GenericSearchBuilder<T extends Searchable>

java.lang.Object

com.dslplatform.client.GenericSearchBuilder<T>

Type Parameters:

T - type of domain object

public class GenericSearchBuilder<T extends Searchable>
extends java.lang.Object

In case when specification is not defined on the server, client side generic search builder can be used. It should be used for testing and in rare cases when server can't be updated.

It is preferable to use server side specification.

Constructor Summary

Constructors

Constructor and Description
GenericSearchBuilder(java.lang.Class<T> manifest, ServiceLocator locator) Create new instance of generic search builder by providing domain object type and locator

Method Summary

Methods

Modifier and Type	Method and Description
GenericSearchBuilder<T>	ascending(java.lang.String property) Order results ascending by specified property.
GenericSearchBuilder<T>	descending(java.lang.String property) Order results descending by specified property.
GenericSearchBuilder<T>	doesntStartsWith(java.lang.String property, java.lang.String value) Define !startsWith [ not property.startsWith(value) ] condition for specification.
GenericSearchBuilder<T>	doesntStartsWith(java.lang.String property, java.lang.String value, boolean ignoreCase) Define !startsWith and case sensitivity [ not property.startsWith(value, case sensitivity) ] condition for specification.
GenericSearchBuilder<T>	equal(java.lang.String property, java.lang.Object value) Define equal (=) condition for specification.
GenericSearchBuilder<T>	greaterThen(java.lang.String property, java.lang.Object value) Define greater then (>) condition for specification.
GenericSearchBuilder<T>	greaterThenOrEqual(java.lang.String property, java.lang.Object value) Define greater then or equal (>=) condition for specification.
GenericSearchBuilder<T>	in(java.lang.String property, java.lang.Object value) Define in ( value in collection property ) condition for specification.
GenericSearchBuilder<T>	inValue(java.lang.String property, java.lang.Object value) Define in [ property in collection value ] condition for specification.
GenericSearchBuilder<T>	lessThen(java.lang.String property, java.lang.Object value) Define less then (<) condition for specification.
GenericSearchBuilder<T>	lessThenOrEqual(java.lang.String property, java.lang.Object value) Define less then or equal (<=) condition for specification.
GenericSearchBuilder<T>	limit(int limit) Limit the number of results which will be performed.
GenericSearchBuilder<T>	nonEqual(java.lang.String property, java.lang.Object value) Define not equal (!=) condition for specification.
GenericSearchBuilder<T>	notIn(java.lang.String property, java.lang.Object value) Define not in ( not value in collection property ) condition for specification.
GenericSearchBuilder<T>	notInValue(java.lang.String property, java.lang.Object value) Define in [ not property in collection value ] condition for specification.
GenericSearchBuilder<T>	offset(int offset) Skip initial number of results.
java.util.concurrent.Future<java.util.List<T>>	search() Ask server to provide domain objects which satisfy defined conditions in requested order if custom order was provided.
GenericSearchBuilder<T>	skip(int offset) Skip initial number of results.
GenericSearchBuilder<T>	startsWith(java.lang.String property, java.lang.String value) Define startsWith [ property.startsWith(value) ] condition for specification.
GenericSearchBuilder<T>	startsWith(java.lang.String property, java.lang.String value, boolean ignoreCase) Define startsWith and case sensitivity [ property.startsWith(value, case sensitivity) ] condition for specification.
GenericSearchBuilder<T>	take(int limit) Limit the number of results which will be performed.
GenericSearchBuilder<T>	valueDoesntStartsWith(java.lang.String property, java.lang.String value) Define !startsWith [ not value.startsWith(property) ] condition for specification.
GenericSearchBuilder<T>	valueDoesntStartsWith(java.lang.String property, java.lang.String value, boolean ignoreCase) Define !startsWith and case sensitivity [ not value.startsWith(property, case sensitivity) ] condition for specification.
GenericSearchBuilder<T>	valueStartsWith(java.lang.String property, java.lang.String value) Define startsWith [ value.startsWith(property) ] condition for specification.
GenericSearchBuilder<T>	valueStartsWith(java.lang.String property, java.lang.String value, boolean ignoreCase) Define startsWith and case sensitivity [ value.startsWith(property, case sensitivity) ] condition for specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericSearchBuilder

public GenericSearchBuilder(java.lang.Class<T> manifest,
                    ServiceLocator locator)

Create new instance of generic search builder by providing domain object type and locator

Parameters:

manifest - domain object type

locator - service locator with registered services

Method Detail

take

public GenericSearchBuilder<T> take(int limit)

Limit the number of results which will be performed.

Parameters:

limit - maximum number of results

Returns:

itself

limit

public GenericSearchBuilder<T> limit(int limit)

Limit the number of results which will be performed.

Parameters:

limit - maximum number of results

Returns:

itself

skip

public GenericSearchBuilder<T> skip(int offset)

Skip initial number of results.

Parameters:

offset - number of skipped results

Returns:

itself

offset

public GenericSearchBuilder<T> offset(int offset)

Skip initial number of results.

Parameters:

offset - number of skipped results

Returns:

itself

search

public java.util.concurrent.Future<java.util.List<T>> search()

Ask server to provide domain objects which satisfy defined conditions in requested order if custom order was provided. Limit and offset will be applied on results if provided.

Returns:

future to list of found domain object

ascending

public GenericSearchBuilder<T> ascending(java.lang.String property)

Order results ascending by specified property.

Parameters:

property - name of property

Returns:

itself

descending

public GenericSearchBuilder<T> descending(java.lang.String property)

Order results descending by specified property.

Parameters:

property - name of property

Returns:

itself

equal

public GenericSearchBuilder<T> equal(java.lang.String property,
                            java.lang.Object value)
                                                 throws java.io.IOException

Define equal (=) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to compare

value - check equality with provided value

Returns:

itself

Throws:

java.io.IOException

nonEqual

public GenericSearchBuilder<T> nonEqual(java.lang.String property,
                               java.lang.Object value)
                                                    throws java.io.IOException

Define not equal (!=) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to compare

value - check equality with provided value

Returns:

itself

Throws:

java.io.IOException

lessThen

public GenericSearchBuilder<T> lessThen(java.lang.String property,
                               java.lang.Object value)
                                                    throws java.io.IOException

Define less then (<) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to compare

value - check ordering with provided value

Returns:

itself

Throws:

java.io.IOException

lessThenOrEqual

public GenericSearchBuilder<T> lessThenOrEqual(java.lang.String property,
                                      java.lang.Object value)
                                                           throws java.io.IOException

Define less then or equal (<=) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to compare

value - check ordering and equality with provided value

Returns:

itself

Throws:

java.io.IOException

greaterThen

public GenericSearchBuilder<T> greaterThen(java.lang.String property,
                                  java.lang.Object value)
                                                       throws java.io.IOException

Define greater then (>) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to compare

value - check ordering with provided value

Returns:

itself

Throws:

java.io.IOException

greaterThenOrEqual

public GenericSearchBuilder<T> greaterThenOrEqual(java.lang.String property,
                                         java.lang.Object value)
                                                              throws java.io.IOException

Define greater then or equal (>=) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to compare

value - check ordering and equality with provided value

Returns:

itself

Throws:

java.io.IOException

in

public GenericSearchBuilder<T> in(java.lang.String property,
                         java.lang.Object value)
                                              throws java.io.IOException

Define in ( value in collection property ) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - check collection for provided value

Returns:

itself

Throws:

java.io.IOException

notIn

public GenericSearchBuilder<T> notIn(java.lang.String property,
                            java.lang.Object value)
                                                 throws java.io.IOException

Define not in ( not value in collection property ) condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - check collection for provided value

Returns:

itself

Throws:

java.io.IOException

inValue

public GenericSearchBuilder<T> inValue(java.lang.String property,
                              java.lang.Object value)
                                                   throws java.io.IOException

Define in [ property in collection value ] condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of collection property to check

value - check if property is in provided collection value

Returns:

itself

Throws:

java.io.IOException

notInValue

public GenericSearchBuilder<T> notInValue(java.lang.String property,
                                 java.lang.Object value)
                                                      throws java.io.IOException

Define in [ not property in collection value ] condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of collection property to check

value - check if property is not in provided collection value

Returns:

itself

Throws:

java.io.IOException

startsWith

public GenericSearchBuilder<T> startsWith(java.lang.String property,
                                 java.lang.String value)
                                                      throws java.io.IOException

Define startsWith [ property.startsWith(value) ] condition for specification. Case sensitive comparison will be performed. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

Returns:

itself

Throws:

java.io.IOException

startsWith

public GenericSearchBuilder<T> startsWith(java.lang.String property,
                                 java.lang.String value,
                                 boolean ignoreCase)
                                                      throws java.io.IOException

Define startsWith and case sensitivity [ property.startsWith(value, case sensitivity) ] condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

ignoreCase - should string comparison ignore casing

Returns:

itself

Throws:

java.io.IOException

doesntStartsWith

public GenericSearchBuilder<T> doesntStartsWith(java.lang.String property,
                                       java.lang.String value)
                                                            throws java.io.IOException

Define !startsWith [ not property.startsWith(value) ] condition for specification. Case sensitive comparison will be performed. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

Returns:

itself

Throws:

java.io.IOException

doesntStartsWith

public GenericSearchBuilder<T> doesntStartsWith(java.lang.String property,
                                       java.lang.String value,
                                       boolean ignoreCase)
                                                            throws java.io.IOException

Define !startsWith and case sensitivity [ not property.startsWith(value, case sensitivity) ] condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

ignoreCase - should string comparison ignore casing

Returns:

itself

Throws:

java.io.IOException

valueStartsWith

public GenericSearchBuilder<T> valueStartsWith(java.lang.String property,
                                      java.lang.String value)
                                                           throws java.io.IOException

Define startsWith [ value.startsWith(property) ] condition for specification. Case sensitive comparison will be performed. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

Returns:

itself

Throws:

java.io.IOException

valueStartsWith

public GenericSearchBuilder<T> valueStartsWith(java.lang.String property,
                                      java.lang.String value,
                                      boolean ignoreCase)
                                                           throws java.io.IOException

Define startsWith and case sensitivity [ value.startsWith(property, case sensitivity) ] condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

ignoreCase - should string comparison ignore casing

Returns:

itself

Throws:

java.io.IOException

valueDoesntStartsWith

public GenericSearchBuilder<T> valueDoesntStartsWith(java.lang.String property,
                                            java.lang.String value)
                                                                 throws java.io.IOException

Define !startsWith [ not value.startsWith(property) ] condition for specification. Case sensitive comparison will be performed. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

Returns:

itself

Throws:

java.io.IOException

valueDoesntStartsWith

public GenericSearchBuilder<T> valueDoesntStartsWith(java.lang.String property,
                                            java.lang.String value,
                                            boolean ignoreCase)
                                                                 throws java.io.IOException

Define !startsWith and case sensitivity [ not value.startsWith(property, case sensitivity) ] condition for specification. Server will return only results that satisfy this and every other specified condition.

Parameters:

property - name of property to check

value - comparison value

ignoreCase - should string comparison ignore casing

Returns:

itself

Throws:

java.io.IOException