org.nuiton.wikitty.search
Class Search

java.lang.Object
  org.nuiton.wikitty.search.Search

Direct Known Subclasses:

SubSearch

public class Search
extends Object

Helper to create a criteria with a restriction

Element : .[.] : search on an extension and field with specific type (optional) Criteria.ALL_EXTENSIONS.. : search on all extension and field name with specific type

specify search on field as NUMERIC, STRING, WIKITTY, BOOLEAN, DATE. Use Element.ElementType to specify type.

Nested Class Summary

static class

Search.KIND Default operator type between all search condition.

Field Summary

protected Search.KIND	kind Defaut kind to Search.KIND.AND.
protected List<Restriction>	restrictions
protected List<Search>	subSearchs

Constructor Summary

Search()

Method Summary

Search	and() And (sub query).
Search	associated(String foreignFieldName)
Search	bw(String element, String lowerValue, String upperValue) Restrict search so that the element value is between lower and upper values (it can also be equals)
Search	contains(String element, Collection<String> values) Contains.
Search	contains(String element, String value1, String... values) Contains.
Criteria	criteria() Return unnamed criteria.
Criteria	criteria(String name) Return named criteria.
protected static Element	elt(String element)
Search	eq(String element, Collection<String> values) Equals each collection elements.
Search	eq(String element, String value) Equals.
Search	ew(String element, String value) Ends with.
Search	exteq(Collection<String> values) Equals each collection elements.
Search	exteq(String value) Looking find specific extension
Search	extneq(String value) Not equals.
Search	ge(String element, String value) Greater or equals.
protected Restriction	getRestrictions()
Search	gt(String element, String value) Greater than.
Search	ideq(String value) Looking find specific id
Search	idneq(String value) Not equals.
Search	in(String element, Collection<String> values) Contains.
Search	in(String element, String value1, String... values) Contains.
Search	isNotNull(String fieldName) Is not null.
Search	isNull(String fieldName) Is null.
Search	keyword(String value) Keyword.
Search	le(String element, String value) Less or equals.
Search	like(String element, String value)
Search	like(String element, String value, Like.SearchAs searchAs) Like.
Search	lt(String element, String value) Less than.
Search	neq(String element, String value) Not equals.
Search	not() Not (sub query).
Search	notew(String element, String value) Not ends with.
Search	nsw(String element, String value) Not starts with.
Search	or() Or (sub query).
static Search	query() Create new Search object with default kind to Search.KIND.AND.
static Search	query(Criteria criteria) Create new query on existent criteria to add new constraint to existent criteria.
static Search	query(Search.KIND kind) Create new Search object with custom kind.
static Search	query(Wikitty wikitty) Create Search query with field in wikitty argument.
Search	rFalse() False.
Search	rTrue() True.
Search	sw(String element, String value) Starts with.
Search	unlike(String element, String value)
Search	unlike(String element, String value, Like.SearchAs searchAs) Unlike.

Methods inherited from class java.lang.Object

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

Field Detail

kind

protected Search.KIND kind

Defaut kind to Search.KIND.AND.

restrictions

protected List<Restriction> restrictions

subSearchs

protected List<Search> subSearchs

Constructor Detail

Search

public Search()

Method Detail

query

public static Search query(Wikitty wikitty)

Create Search query with field in wikitty argument. Null field are not used in search request.

Parameters:

wikitty - example use to create query

Returns:

query

query

public static Search query()

Create new Search object with default kind to Search.KIND.AND.

Returns:

Search helper

query

public static Search query(Search.KIND kind)

Create new Search object with custom kind.

Parameters:

kind - kind

Returns:

Search helper

query

public static Search query(Criteria criteria)

Create new query on existent criteria to add new constraint to existent criteria.

Parameters:

criteria -

Returns:

elt

protected static Element elt(String element)

contains

public Search contains(String element,
                       Collection<String> values)

Contains.

Parameters:

element -

values -

Returns:

contains

public Search contains(String element,
                       String value1,
                       String... values)

Contains.

Parameters:

element -

value1 -

values -

Returns:

in

public Search in(String element,
                 Collection<String> values)

Contains.

Parameters:

element -

values -

Returns:

in

public Search in(String element,
                 String value1,
                 String... values)

Contains.

Parameters:

element -

value1 -

values -

Returns:

eq

public Search eq(String element,
                 String value)

Equals.

Parameters:

element -

value -

Returns:

this

exteq

public Search exteq(String value)

Looking find specific extension

Parameters:

value -

Returns:

this

ideq

public Search ideq(String value)

Looking find specific id

Parameters:

value -

Returns:

this

eq

public Search eq(String element,
                 Collection<String> values)

Equals each collection elements.

Parameters:

element -

values -

Returns:

this

exteq

public Search exteq(Collection<String> values)

Equals each collection elements.

Parameters:

values -

Returns:

this

neq

public Search neq(String element,
                  String value)

Not equals.

Parameters:

element -

value -

Returns:

this

extneq

public Search extneq(String value)

Not equals.

Parameters:

value -

Returns:

this

idneq

public Search idneq(String value)

Not equals.

Parameters:

value -

Returns:

this

gt

public Search gt(String element,
                 String value)

Greater than.

Parameters:

element -

value -

Returns:

this

ge

public Search ge(String element,
                 String value)

Greater or equals.

Parameters:

element -

value -

Returns:

this

lt

public Search lt(String element,
                 String value)

Less than.

Parameters:

element -

value -

Returns:

this

le

public Search le(String element,
                 String value)

Less or equals.

Parameters:

element -

value -

Returns:

this

bw

public Search bw(String element,
                 String lowerValue,
                 String upperValue)

Restrict search so that the element value is between lower and upper values (it can also be equals)

Parameters:

element - the element you put the restriction on

lowerValue - the lower bound

upperValue - the upper bound

Returns:

this

sw

public Search sw(String element,
                 String value)

Starts with.

Parameters:

element -

value -

Returns:

this

nsw

public Search nsw(String element,
                  String value)

Not starts with.

Parameters:

element -

value -

Returns:

this

ew

public Search ew(String element,
                 String value)

Ends with.

Parameters:

element -

value -

Returns:

this

notew

public Search notew(String element,
                    String value)

Not ends with.

Parameters:

element -

value -

Returns:

this

keyword

public Search keyword(String value)

Keyword.

Parameters:

value -

Returns:

this

isNull

public Search isNull(String fieldName)

Is null.

Parameters:

fieldName -

Returns:

this

isNotNull

public Search isNotNull(String fieldName)

Is not null.

Parameters:

fieldName -

Returns:

this

rFalse

public Search rFalse()

False.

Returns:

this

rTrue

public Search rTrue()

True.

Returns:

this

like

public Search like(String element,
                   String value,
                   Like.SearchAs searchAs)

Like.

Parameters:

element -

value -

searchAs -

Returns:

this

like

public Search like(String element,
                   String value)

unlike

public Search unlike(String element,
                     String value,
                     Like.SearchAs searchAs)

Unlike.

Parameters:

element -

value -

searchAs -

Returns:

this

unlike

public Search unlike(String element,
                     String value)

not

public Search not()

Not (sub query).

Returns:

sub query

or

public Search or()

Or (sub query).

Returns:

sub query

and

public Search and()

And (sub query).

Returns:

sub query

associated

public Search associated(String foreignFieldName)

criteria

public Criteria criteria(String name)

Return named criteria.

Parameters:

name - name of criteria

Returns:

new criteria

criteria

public Criteria criteria()

Return unnamed criteria.

Returns:

new criteria

getRestrictions

protected Restriction getRestrictions()
                               throws UnsupportedOperationException

Throws:

UnsupportedOperationException