public class Criteria extends Node
Modifier and Type | Class and Description |
---|---|
static class |
Criteria.OperationKey |
static class |
Criteria.Predicate
Single entry to be used when defining search criteria
|
Modifier and Type | Field and Description |
---|---|
static String |
CRITERIA_VALUE_SEPERATOR |
static String |
WILDCARD |
Constructor and Description |
---|
Criteria() |
Criteria(Field field)
Creates a new Criteria for the given field
|
Criteria(Function function) |
Criteria(String fieldname)
Creates a new Criteria for the Filed with provided name
|
Modifier and Type | Method and Description |
---|---|
Crotch |
and(Node node)
Combine two
Node s using and. |
Crotch |
and(String fieldname)
Combine node with new
Node for given fieldname using and. |
Criteria |
between(Object lowerBound,
Object upperBound)
Crates new
Criteria.Predicate for RANGE [lowerBound TO upperBound] |
Criteria |
between(Object lowerBound,
Object upperBound,
boolean includeLowerBound,
boolean includeUppderBound)
Crates new
Criteria.Predicate for RANGE [lowerBound TO upperBound] |
Criteria |
boost(float boost)
Boost positive hit with given factor. eg. ^2.3
|
Criteria |
connect()
Explicitly connect
Criteria with another one allows to create explicit bracketing. |
Criteria |
contains(Iterable<String> values)
Crates new
Criteria.Predicate with leading and trailing wildcards for each entryNOTE: mind your schema as leading wildcards may not be supported and/or execution might be slow. |
Criteria |
contains(String... values)
Crates new
Criteria.Predicate with leading and trailing wildcards for each entryNOTE: mind your schema as leading wildcards may not be supported and/or execution might be slow. |
Criteria |
contains(String s)
Crates new
Criteria.Predicate with leading and trailing wildcards NOTE: mind your schema as leading wildcards may not be supported and/or execution might be slow. |
Criteria |
endsWith(Iterable<String> values)
Crates new
Criteria.Predicate with leading wildcard for each entryNOTE: mind your schema and execution times as leading wildcards may not be supported. |
Criteria |
endsWith(String... values)
Crates new
Criteria.Predicate with leading wildcard for each entryNOTE: mind your schema and execution times as leading wildcards may not be supported. |
Criteria |
endsWith(String s)
Crates new
Criteria.Predicate with leading wildcard NOTE: mind your schema and execution times as leading wildcards may not be supported. |
Criteria |
expression(String s)
Crates new
Criteria.Predicate allowing native solr expressions |
Criteria |
function(Function function)
Creates
Criteria.Predicate for given Function . |
Criteria |
fuzzy(String s)
Crates new
Criteria.Predicate with trailing ~ |
Criteria |
fuzzy(String s,
float levenshteinDistance)
Crates new
Criteria.Predicate with trailing ~ followed by levensteinDistance |
float |
getBoost()
Boost criteria value
|
Field |
getField()
Target field
|
Set<Criteria.Predicate> |
getPredicates() |
Criteria |
greaterThan(Object lowerBound)
Crates new
Criteria.Predicate for RANGE {lowerBound TO *] |
Criteria |
greaterThanEqual(Object lowerBound)
Crates new
Criteria.Predicate for RANGE [lowerBound TO *] |
Criteria |
in(Iterable<?> values)
Crates new
Criteria.Predicate for multiple values (arg0 arg1 arg2 ...) |
Criteria |
in(Object... values)
Crates new
Criteria.Predicate for multiple values (arg0 arg1 arg2 ...) |
Criteria |
is(Iterable<?> values)
Creates new
Criteria.Predicate without any wildcards for each entry |
Criteria |
is(Object... values)
Crates new
Criteria.Predicate without any wildcards for each entry |
Criteria |
is(Object o)
Crates new
Criteria.Predicate without any wildcards. |
boolean |
isNegating() |
Criteria |
isNotNull()
Crates new
Criteria.Predicate for {@code ! |
Criteria |
isNull()
Crates new
Criteria.Predicate for null values |
Criteria |
lessThan(Object upperBound)
Crates new
Criteria.Predicate for RANGE [* TO upperBound} |
Criteria |
lessThanEqual(Object upperBound)
Crates new
Criteria.Predicate for RANGE [* TO upperBound] |
Criteria |
near(Box box)
Creates new
Criteria.Predicate for {@code ! |
Criteria |
near(Circle circle)
Creates new
Criteria.Predicate for {@code ! |
Criteria |
near(Point location,
Distance distance)
Creates new
Criteria.Predicate for {@code ! |
Criteria |
not()
Negates current criteria usinng
- operator |
Criteria |
notOperator()
Explicitly wrap
Criteria inside not operation. |
Crotch |
or(Node node)
Combine two
Node s using or. |
Crotch |
or(String fieldname)
Combine node with new
Node for given fieldname using and. |
Criteria |
sloppy(String phrase,
int distance)
Crates new
Criteria.Predicate with trailing ~ followed by distance |
Criteria |
startsWith(Iterable<String> values)
Crates new
Criteria.Predicate with trailing wildcard for each entry |
Criteria |
startsWith(String... values)
Crates new
Criteria.Predicate with trailing wildcard for each entry |
Criteria |
startsWith(String s)
Crates new
Criteria.Predicate with trailing wildcard NOTE: Strings will not be automatically split on whitespace. |
String |
toString() |
static Criteria |
where(Field field)
Static factory method to create a new Criteria for provided field
|
static Criteria |
where(Function function)
Static factory method to create a new Criteria for function
|
static Criteria |
where(String fieldname)
Static factory method to create a new Criteria for field with given name
|
Criteria |
within(Circle circle)
Creates new
Criteria.Predicate for {@code ! |
Criteria |
within(Point location,
Distance distance)
Creates new
Criteria.Predicate for {@code ! |
getParent, getSiblings, hasSiblings, isOr, isRoot, setNegating, setParent, setPartIsOr
public static final String WILDCARD
public static final String CRITERIA_VALUE_SEPERATOR
public Criteria()
public Criteria(Function function)
function
- public Criteria(String fieldname)
fieldname
- public Criteria(Field field)
field
- public static Criteria where(String fieldname)
fieldname
- must not be nullpublic static Criteria where(Function function)
function
- must not be nullpublic static Criteria where(Field field)
field
- must not be nullpublic Criteria is(@Nullable Object o)
Criteria.Predicate
without any wildcards. Strings with blanks will be escaped
"string\ with\ blank"
public Criteria is(Object... values)
Criteria.Predicate
without any wildcards for each entrypublic Criteria is(Iterable<?> values)
Criteria.Predicate
without any wildcards for each entrypublic Criteria isNull()
Criteria.Predicate
for null
valuespublic Criteria isNotNull()
Criteria.Predicate
for !null
valuespublic Criteria contains(String s)
Criteria.Predicate
with leading and trailing wildcards contains
in class Node
s
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria contains(String... values)
Criteria.Predicate
with leading and trailing wildcards for each entrycontains
in class Node
values
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria contains(Iterable<String> values)
Criteria.Predicate
with leading and trailing wildcards for each entrycontains
in class Node
values
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria startsWith(String s)
Criteria.Predicate
with trailing wildcard startsWith
in class Node
s
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria startsWith(String... values)
Criteria.Predicate
with trailing wildcard for each entrystartsWith
in class Node
values
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria startsWith(Iterable<String> values)
Criteria.Predicate
with trailing wildcard for each entrystartsWith
in class Node
values
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria endsWith(String s)
Criteria.Predicate
with leading wildcard endsWith
in class Node
s
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria endsWith(String... values)
Criteria.Predicate
with leading wildcard for each entryendsWith
in class Node
values
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria endsWith(Iterable<String> values)
Criteria.Predicate
with leading wildcard for each entryendsWith
in class Node
values
- InvalidDataAccessApiUsageException
- for strings with whitespacepublic Criteria not()
-
operatorpublic Criteria notOperator()
Criteria
inside not operation.public Criteria fuzzy(String s)
Criteria.Predicate
with trailing ~
public Criteria fuzzy(String s, float levenshteinDistance)
Criteria.Predicate
with trailing ~
followed by levensteinDistancepublic Criteria sloppy(String phrase, int distance)
Criteria.Predicate
with trailing ~
followed by distancepublic Criteria expression(String s)
Criteria.Predicate
allowing native solr expressionsexpression
in class Node
s
- public Criteria boost(float boost)
public Criteria between(@Nullable Object lowerBound, @Nullable Object upperBound)
Criteria.Predicate
for RANGE [lowerBound TO upperBound]
public Criteria between(@Nullable Object lowerBound, @Nullable Object upperBound, boolean includeLowerBound, boolean includeUppderBound)
Criteria.Predicate
for RANGE [lowerBound TO upperBound]
public Criteria lessThan(Object upperBound)
Criteria.Predicate
for RANGE [* TO upperBound}
public Criteria lessThanEqual(Object upperBound)
Criteria.Predicate
for RANGE [* TO upperBound]
lessThanEqual
in class Node
upperBound
- public Criteria greaterThan(Object lowerBound)
Criteria.Predicate
for RANGE {lowerBound TO *]
greaterThan
in class Node
lowerBound
- public Criteria greaterThanEqual(Object lowerBound)
Criteria.Predicate
for RANGE [lowerBound TO *]
greaterThanEqual
in class Node
lowerBound
- public Criteria in(Object... values)
Criteria.Predicate
for multiple values (arg0 arg1 arg2 ...)
public Criteria in(Iterable<?> values)
Criteria.Predicate
for multiple values (arg0 arg1 arg2 ...)
public Criteria within(Point location, @Nullable Distance distance)
Criteria.Predicate
for !getfilt
. neutral
metric
to set
the local score
property for the function.public Criteria within(Circle circle)
Criteria.Predicate
for !getfilt
.circle
- public Criteria near(Box box)
Criteria.Predicate
for !bbox
with exact coordinates.public Criteria near(Point location, @Nullable Distance distance)
Criteria.Predicate
for !bbox
for a specified distance. The difference between this and
within
is this is approximate while within
is exact. neutral
metric
to set
the local score
property for the function.near
in class Node
location
- distance
- IllegalArgumentException
- if location is nullInvalidDataAccessApiUsageException
- if distance is negativepublic Criteria near(Circle circle)
Criteria.Predicate
for !circle
for a specified distance. The difference between this and
within(Circle)
is this is approximate while within
is exact. neutral
metric
to set
the local score
property for the function.circle
- public Criteria function(Function function)
Criteria.Predicate
for given Function
.function
in class Node
function
- must not be nullIllegalArgumentException
- if function is nullpublic boolean isNegating()
isNegating
in class Node
not()
criteriapublic float getBoost()
Float.NaN
if not setpublic Set<Criteria.Predicate> getPredicates()
Criteria.Predicate
public Criteria connect()
Criteria
with another one allows to create explicit bracketing.public Crotch and(String fieldname)
Node
Node
for given fieldname using and.Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.