QueryCriteria (Spring Data Couchbase 4.4.15 API)

java.lang.Object
- org.springframework.data.couchbase.core.query.QueryCriteria

All Implemented Interfaces:

QueryCriteriaDefinition
```
public class QueryCriteria
extends Object
implements QueryCriteriaDefinition
```
Author:

Michael Nitschinger, Michael Reiche, Mauro Monti

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryCriteria.ChainOperator

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryCriteria.ChainOperator`

Constructor Summary

Constructors
Constructor and Description
`QueryCriteria(LinkedList<QueryCriteria> chain, N1QLExpression key, Object[] value, QueryCriteria.ChainOperator chainOperator)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryCriteria`	`and(N1QLExpression key)`
`QueryCriteria`	`and(QueryCriteria criteria)`
`QueryCriteria`	`and(String key)`
`QueryCriteria`	`arrayContaining(boolean ignoreCase, Object o)`
`QueryCriteria`	`arrayContaining(Object o)`
`QueryCriteria`	`between(boolean ignoreCase, Object o1, Object o2)`
`QueryCriteria`	`between(Object o1, Object o2)`
`QueryCriteria`	`containing(boolean ignoreCase, Object o)`
`QueryCriteria`	`containing(Object o)`
`QueryCriteria`	`endingWith(boolean ignoreCase, Object o)`
`QueryCriteria`	`endingWith(Object o)`
`QueryCriteria`	`eq(boolean ignoreCase, Object o)`
`QueryCriteria`	`eq(Object o)`
`String`	`export()` Export the query criteria to a string without using positional or named parameters.
`String`	`export(int[] paramIndexPtr, com.couchbase.client.java.json.JsonValue parameters, CouchbaseConverter converter)` This exports the query criteria chain into a string to be appended to the beginning of an N1QL statement
`QueryCriteria`	`FALSE()`
`QueryCriteria`	`gt(boolean ignoreCase, Object o)`
`QueryCriteria`	`gt(Object o)`
`QueryCriteria`	`gte(boolean ignoreCase, Object o)`
`QueryCriteria`	`gte(Object o)`
`QueryCriteria`	`in(boolean ignoreCase, Object... o)`
`QueryCriteria`	`in(Object... o)`
`QueryCriteria`	`is(boolean ignoreCase, Object o)`
`QueryCriteria`	`is(Object o)`
`QueryCriteria`	`isMissing()`
`QueryCriteria`	`isNotMissing()`
`QueryCriteria`	`isNotNull()`
`QueryCriteria`	`isNotValued()`
`QueryCriteria`	`isNull()`
`QueryCriteria`	`isValued()`
`QueryCriteria`	`like(boolean ignoreCase, Object o)`
`QueryCriteria`	`like(Object o)`
`QueryCriteria`	`lower()`
`QueryCriteria`	`lt(boolean ignoreCase, Object o)`
`QueryCriteria`	`lt(Object o)`
`QueryCriteria`	`lte(boolean ignoreCase, Object o)`
`QueryCriteria`	`lte(Object o)`
`QueryCriteria`	`ne(boolean ignoreCase, Object o)`
`QueryCriteria`	`ne(Object o)`
`QueryCriteria`	`negate()`
`QueryCriteria`	`notContaining(boolean ignoreCase, Object o)`
`QueryCriteria`	`notContaining(Object o)`
`QueryCriteria`	`notIn(boolean ignoreCase, Object... o)`
`QueryCriteria`	`notIn(Object... o)`
`QueryCriteria`	`notLike(boolean ignoreCase, Object o)`
`QueryCriteria`	`notLike(Object o)`
`QueryCriteria`	`or(N1QLExpression key)`
`QueryCriteria`	`or(QueryCriteria criteria)`
`QueryCriteria`	`or(String key)`
`QueryCriteria`	`plus(Object o)`
`QueryCriteria`	`regex(Object o)`
`void`	`setChainOperator(QueryCriteria.ChainOperator chainOperator)`
`QueryCriteria`	`size()`
`QueryCriteria`	`startingWith(boolean ignoreCase, Object o)`
`QueryCriteria`	`startingWith(Object o)`
`String`	`toString()`
`QueryCriteria`	`TRUE()`
`QueryCriteria`	`upper()`
`static QueryCriteria`	`where(N1QLExpression key)` Static factory method to create a Criteria using the provided N1QLExpression key.
`static QueryCriteria`	`where(String key)` Static factory method to create a Criteria using the provided String key.
`QueryCriteria`	`within(boolean ignoreCase, Object o)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryCriteria

public QueryCriteria(LinkedList<QueryCriteria> chain,
                     N1QLExpression key,
                     Object[] value,
                     QueryCriteria.ChainOperator chainOperator)

Method Detail

where
```
public static QueryCriteria where(String key)
```
Static factory method to create a Criteria using the provided String key.

where
```
public static QueryCriteria where(N1QLExpression key)
```
Static factory method to create a Criteria using the provided N1QLExpression key.

and
```
public QueryCriteria and(String key)
```

and

public QueryCriteria and(N1QLExpression key)

and

public QueryCriteria and(QueryCriteria criteria)

upper
```
public QueryCriteria upper()
```

lower
```
public QueryCriteria lower()
```

or
```
public QueryCriteria or(String key)
```

or

public QueryCriteria or(N1QLExpression key)

or

public QueryCriteria or(QueryCriteria criteria)

eq

public QueryCriteria eq(@Nullable
                        Object o)

eq

public QueryCriteria eq(boolean ignoreCase,
                        @Nullable
                        Object o)

is

public QueryCriteria is(@Nullable
                        Object o)

is

public QueryCriteria is(boolean ignoreCase,
                        @Nullable
                        Object o)

ne

public QueryCriteria ne(@Nullable
                        Object o)

ne

public QueryCriteria ne(boolean ignoreCase,
                        @Nullable
                        Object o)

lt

public QueryCriteria lt(@Nullable
                        Object o)

lt

public QueryCriteria lt(boolean ignoreCase,
                        @Nullable
                        Object o)

lte

public QueryCriteria lte(@Nullable
                         Object o)

lte

public QueryCriteria lte(boolean ignoreCase,
                         @Nullable
                         Object o)

gt

public QueryCriteria gt(@Nullable
                        Object o)

gt

public QueryCriteria gt(boolean ignoreCase,
                        @Nullable
                        Object o)

gte

public QueryCriteria gte(@Nullable
                         Object o)

gte

public QueryCriteria gte(boolean ignoreCase,
                         @Nullable
                         Object o)

startingWith

public QueryCriteria startingWith(@Nullable
                                  Object o)

startingWith

public QueryCriteria startingWith(boolean ignoreCase,
                                  @Nullable
                                  Object o)

plus

public QueryCriteria plus(@Nullable
                          Object o)

endingWith

public QueryCriteria endingWith(@Nullable
                                Object o)

endingWith

public QueryCriteria endingWith(boolean ignoreCase,
                                @Nullable
                                Object o)

regex

public QueryCriteria regex(@Nullable
                           Object o)

containing

public QueryCriteria containing(@Nullable
                                Object o)

containing

public QueryCriteria containing(boolean ignoreCase,
                                @Nullable
                                Object o)

arrayContaining

public QueryCriteria arrayContaining(@Nullable
                                     Object o)

arrayContaining

public QueryCriteria arrayContaining(boolean ignoreCase,
                                     @Nullable
                                     Object o)

notContaining

public QueryCriteria notContaining(@Nullable
                                   Object o)

notContaining

public QueryCriteria notContaining(boolean ignoreCase,
                                   @Nullable
                                   Object o)

negate
```
public QueryCriteria negate()
```

size
```
public QueryCriteria size()
```

like

public QueryCriteria like(@Nullable
                          Object o)

like

public QueryCriteria like(boolean ignoreCase,
                          @Nullable
                          Object o)

notLike

public QueryCriteria notLike(@Nullable
                             Object o)

notLike

public QueryCriteria notLike(boolean ignoreCase,
                             @Nullable
                             Object o)

isNull
```
public QueryCriteria isNull()
```

isNotNull
```
public QueryCriteria isNotNull()
```

isMissing
```
public QueryCriteria isMissing()
```

isNotMissing
```
public QueryCriteria isNotMissing()
```

isValued
```
public QueryCriteria isValued()
```

isNotValued
```
public QueryCriteria isNotValued()
```

within

public QueryCriteria within(boolean ignoreCase,
                            @Nullable
                            Object o)

between

public QueryCriteria between(@Nullable
                             Object o1,
                             @Nullable
                             Object o2)

between

public QueryCriteria between(boolean ignoreCase,
                             @Nullable
                             Object o1,
                             @Nullable
                             Object o2)

in

public QueryCriteria in(@Nullable
                        Object... o)

in

public QueryCriteria in(boolean ignoreCase,
                        @Nullable
                        Object... o)

notIn

public QueryCriteria notIn(@Nullable
                           Object... o)

notIn

public QueryCriteria notIn(boolean ignoreCase,
                           @Nullable
                           Object... o)

TRUE
```
public QueryCriteria TRUE()
```

FALSE
```
public QueryCriteria FALSE()
```

export
```
public String export(int[] paramIndexPtr,
                     com.couchbase.client.java.json.JsonValue parameters,
                     CouchbaseConverter converter)
```
This exports the query criteria chain into a string to be appended to the beginning of an N1QL statement

Specified by:

export in interface QueryCriteriaDefinition

Parameters:

paramIndexPtr - - this is a reference to the parameter index to be used for positional parameters There may already be positional parameters in the beginning of the statement, so it may not always start at 1. If it has the value -1, the query is using named parameters. If the pointer is null, the query is not using parameters.

parameters - - parameters of the query. If operands are parameterized, their values are added to parameters

converter - - converter to use for converting criteria values

Returns:

string containing part of N1QL query

export
```
public String export()
```
Export the query criteria to a string without using positional or named parameters.

Specified by:

export in interface QueryCriteriaDefinition

Returns:

string containing part of N1QL query

setChainOperator
```
public void setChainOperator(QueryCriteria.ChainOperator chainOperator)
```
Specified by:

setChainOperator in interface QueryCriteriaDefinition

toString
```
public String toString()
```
Overrides:

toString in class Object

Class QueryCriteria

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryCriteria

Method Detail

where

where

and

and

and

upper

lower

or

or

or

eq

eq

is

is

ne

ne

lt

lt

lte

lte

gt

gt

gte

gte

startingWith

startingWith

plus

endingWith

endingWith

regex

containing

containing

arrayContaining

arrayContaining

notContaining

notContaining

negate

size

like

like

notLike

notLike

isNull

isNotNull

isMissing

isNotMissing

isValued

isNotValued

within

between

between

in

in

notIn

notIn

TRUE

FALSE

export

export

setChainOperator

toString