|
Spring Data Solr | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.data.solr.core.query.Node
org.springframework.data.solr.core.query.Criteria
public class Criteria
Criteria is the central class when constructing queries. It follows more or less a fluent API style, which allows to easily chain together multiple criteria.
| Nested Class Summary | |
|---|---|
static class |
Criteria.OperationKey
|
static class |
Criteria.Predicate
Single entry to be used when defining search criteria |
| Field Summary | |
|---|---|
static String |
CRITERIA_VALUE_SEPERATOR
|
static String |
WILDCARD
|
| Constructor Summary | |
|---|---|
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 |
|
| Method Summary | |
|---|---|
Crotch |
and(Node node)
Combine two Nodes 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 |
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(org.springframework.data.geo.Box box)
Creates new Criteria.Predicate for {@code ! |
Criteria |
near(org.springframework.data.geo.Circle circle)
Creates new Criteria.Predicate for {@code ! |
Criteria |
near(org.springframework.data.geo.Point location,
org.springframework.data.geo.Distance distance)
Creates new Criteria.Predicate for {@code ! |
Criteria |
not()
Negates current criteria usinng - operator |
Crotch |
or(Node node)
Combine two Nodes 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(org.springframework.data.geo.Circle circle)
Creates new Criteria.Predicate for {@code ! |
Criteria |
within(org.springframework.data.geo.Point location,
org.springframework.data.geo.Distance distance)
Creates new Criteria.Predicate for {@code ! |
| Methods inherited from class org.springframework.data.solr.core.query.Node |
|---|
getParent, getSiblings, hasSiblings, isOr, isRoot, setParent, setPartIsOr |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String WILDCARD
public static final String CRITERIA_VALUE_SEPERATOR
| Constructor Detail |
|---|
public Criteria()
public Criteria(Function function)
function - public Criteria(String fieldname)
fieldname - public Criteria(Field field)
field - | Method Detail |
|---|
public static Criteria where(String fieldname)
fieldname - must not be null
public static Criteria where(Function function)
function - must not be null
public static Criteria where(Field field)
field - must not be null
public Criteria is(Object o)
Criteria.Predicate without any wildcards. Strings with blanks will be escaped
"string\ with\ blank"
is in class Nodeo -
public Criteria is(Object... values)
Criteria.Predicate without any wildcards for each entry
is in class Nodevalues -
public Criteria is(Iterable<?> values)
Criteria.Predicate without any wildcards for each entry
is in class Nodevalues -
public Criteria isNull()
Criteria.Predicate for null values
isNull in class Nodepublic Criteria isNotNull()
Criteria.Predicate for !null values
isNotNull in class Nodepublic Criteria contains(String s)
Criteria.Predicate with leading and trailing wildcards
contains in class Nodes -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria contains(String... values)
Criteria.Predicate with leading and trailing wildcards for each entry
contains in class Nodevalues -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria contains(Iterable<String> values)
Criteria.Predicate with leading and trailing wildcards for each entry
contains in class Nodevalues -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria startsWith(String s)
Criteria.Predicate with trailing wildcard
startsWith in class Nodes -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria startsWith(String... values)
Criteria.Predicate with trailing wildcard for each entry
startsWith in class Nodevalues -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria startsWith(Iterable<String> values)
Criteria.Predicate with trailing wildcard for each entry
startsWith in class Nodevalues -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria endsWith(String s)
Criteria.Predicate with leading wildcard
endsWith in class Nodes -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria endsWith(String... values)
Criteria.Predicate with leading wildcard for each entry
endsWith in class Nodevalues -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria endsWith(Iterable<String> values)
Criteria.Predicate with leading wildcard for each entry
endsWith in class Nodevalues -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria not()
- operator
not in class Nodepublic Criteria fuzzy(String s)
Criteria.Predicate with trailing ~
fuzzy in class Nodes -
public Criteria fuzzy(String s,
float levenshteinDistance)
Criteria.Predicate with trailing ~ followed by levensteinDistance
fuzzy in class Nodes - levenshteinDistance -
public Criteria sloppy(String phrase,
int distance)
Criteria.Predicate with trailing ~ followed by distance
sloppy in class Nodephrase - distance -
public Criteria expression(String s)
Criteria.Predicate allowing native solr expressions
expression in class Nodes -
public Criteria boost(float boost)
boost in class Nodeboost -
public Criteria between(Object lowerBound,
Object upperBound)
Criteria.Predicate for RANGE [lowerBound TO upperBound]
between in class NodelowerBound - upperBound -
public Criteria between(Object lowerBound,
Object upperBound,
boolean includeLowerBound,
boolean includeUppderBound)
Criteria.Predicate for RANGE [lowerBound TO upperBound]
between in class NodelowerBound - upperBound - includeLowerBound - includeUppderBound -
public Criteria lessThan(Object upperBound)
Criteria.Predicate for RANGE [* TO upperBound}
lessThan in class NodeupperBound -
public Criteria lessThanEqual(Object upperBound)
Criteria.Predicate for RANGE [* TO upperBound]
lessThanEqual in class NodeupperBound -
public Criteria greaterThan(Object lowerBound)
Criteria.Predicate for RANGE {lowerBound TO *]
greaterThan in class NodelowerBound -
public Criteria greaterThanEqual(Object lowerBound)
Criteria.Predicate for RANGE [lowerBound TO *]
greaterThanEqual in class NodelowerBound -
public Criteria in(Object... values)
Criteria.Predicate for multiple values (arg0 arg1 arg2 ...)
in in class Nodevalues -
public Criteria in(Iterable<?> values)
Criteria.Predicate for multiple values (arg0 arg1 arg2 ...)
in in class Nodevalues - the collection containing the values to match against
public Criteria within(org.springframework.data.geo.Point location,
org.springframework.data.geo.Distance distance)
Criteria.Predicate for !geodist
within in class Nodelocation - Point in degreesdistance -
public Criteria within(org.springframework.data.geo.Circle circle)
Criteria.Predicate for !geodist.
circle -
public Criteria near(org.springframework.data.geo.Box box)
Criteria.Predicate for !bbox with exact coordinates
near in class Nodebox -
public Criteria near(org.springframework.data.geo.Point location,
org.springframework.data.geo.Distance distance)
Criteria.Predicate for !bbox for a specified distance. The difference between this and
within is this is approximate while within is exact.
near in class Nodelocation - distance -
IllegalArgumentException - if location is null
InvalidDataAccessApiUsageException - if distance is negativepublic Criteria near(org.springframework.data.geo.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.
circle -
public Criteria function(Function function)
Criteria.Predicate for given Function.
function in class Nodefunction - must not be null
IllegalArgumentException - if function is nullpublic Field getField()
public boolean isNegating()
not() criteriapublic float getBoost()
Float.NaN if not setpublic Set<Criteria.Predicate> getPredicates()
Criteria.Predicatepublic String toString()
toString in class Objectpublic Crotch and(Node node)
NodeNodes using and.
and in class Nodepublic Crotch and(String fieldname)
NodeNode for given fieldname using and.
and in class Nodepublic Crotch or(Node node)
NodeNodes using or.
or in class Nodepublic Crotch or(String fieldname)
NodeNode for given fieldname using and.
or in class Node
|
Spring Data Solr | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||