|
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.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.CriteriaEntry
Single entry to be used when defining search criteria |
static class |
Criteria.OperationKey
|
| 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)
|
protected |
Criteria(List<Criteria> criteriaChain,
Field field)
|
protected |
Criteria(List<Criteria> criteriaChain,
String fieldname)
|
|
Criteria(String fieldname)
Creates a new Criteria for the Filed with provided name |
| Method Summary | |
|---|---|
Criteria |
and(Criteria... criterias)
Chain using AND |
Criteria |
and(Criteria criteria)
Chain using AND |
Criteria |
and(Field field)
Chain using AND |
Criteria |
and(String fieldname)
Chain using AND |
Criteria |
between(Object lowerBound,
Object upperBound)
Crates new Criteria.CriteriaEntry for RANGE [lowerBound TO upperBound] |
Criteria |
between(Object lowerBound,
Object upperBound,
boolean includeLowerBound,
boolean includeUppderBound)
Crates new Criteria.CriteriaEntry 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.CriteriaEntry 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.CriteriaEntry 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.CriteriaEntry 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.CriteriaEntry 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.CriteriaEntry 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.CriteriaEntry with leading wildcard NOTE: mind your schema and execution times as leading wildcards may not be supported. |
Criteria |
expression(String s)
Crates new Criteria.CriteriaEntry allowing native solr expressions |
Criteria |
function(Function function)
Creates Criteria.CriteriaEntry for given Function. |
Criteria |
fuzzy(String s)
Crates new Criteria.CriteriaEntry with trailing ~ |
Criteria |
fuzzy(String s,
float levenshteinDistance)
Crates new Criteria.CriteriaEntry with trailing ~ followed by levensteinDistance |
float |
getBoost()
Boost criteria value |
String |
getConjunctionOperator()
Conjunction to be used with this criteria (AND | OR) |
List<Criteria> |
getCriteriaChain()
Get the collection of criterias |
Set<Criteria.CriteriaEntry> |
getCriteriaEntries()
|
Field |
getField()
Target field |
Criteria |
greaterThan(Object lowerBound)
Crates new Criteria.CriteriaEntry for RANGE {lowerBound TO *] |
Criteria |
greaterThanEqual(Object lowerBound)
Crates new Criteria.CriteriaEntry for RANGE [lowerBound TO *] |
Criteria |
in(Iterable<?> values)
Crates new Criteria.CriteriaEntry for multiple values (arg0 arg1 arg2 ...) |
Criteria |
in(Object... values)
Crates new Criteria.CriteriaEntry for multiple values (arg0 arg1 arg2 ...) |
Criteria |
is(Iterable<?> values)
Creates new Criteria.CriteriaEntry without any wildcards for each entry |
Criteria |
is(Object... values)
Crates new Criteria.CriteriaEntry without any wildcards for each entry |
Criteria |
is(Object o)
Crates new Criteria.CriteriaEntry without any wildcards. |
boolean |
isNegating()
|
Criteria |
isNotNull()
Crates new Criteria.CriteriaEntry for {@code ! |
Criteria |
isNull()
Crates new Criteria.CriteriaEntry for null values |
Criteria |
lessThan(Object upperBound)
Crates new Criteria.CriteriaEntry for RANGE [* TO upperBound} |
Criteria |
lessThanEqual(Object upperBound)
Crates new Criteria.CriteriaEntry for RANGE [* TO upperBound] |
Criteria |
near(BoundingBox box)
Creates new Criteria.CriteriaEntry for {@code ! |
Criteria |
near(GeoLocation location,
Distance distance)
Creates new Criteria.CriteriaEntry for {@code ! |
Criteria |
not()
Negates current criteria usinng - operator |
Criteria |
or(Criteria criteria)
Chain using OR |
Criteria |
or(Field field)
Chain using OR |
Criteria |
or(String fieldname)
Chain using OR |
Criteria |
sloppy(String phrase,
int distance)
Crates new Criteria.CriteriaEntry with trailing ~ followed by distance |
Criteria |
startsWith(Iterable<String> values)
Crates new Criteria.CriteriaEntry with trailing wildcard for each entry |
Criteria |
startsWith(String... values)
Crates new Criteria.CriteriaEntry with trailing wildcard for each entry |
Criteria |
startsWith(String s)
Crates new Criteria.CriteriaEntry with trailing wildcard NOTE: Strings will not be automatically split on whitespace. |
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(GeoLocation location,
Distance distance)
Creates new Criteria.CriteriaEntry for {@code ! |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 -
protected Criteria(List<Criteria> criteriaChain,
String fieldname)
protected Criteria(List<Criteria> criteriaChain,
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 and(Field field)
AND
field - must not be null
public Criteria and(String fieldname)
AND
fieldname - must not be null
public Criteria and(Criteria criteria)
AND
criteria -
public Criteria and(Criteria... criterias)
AND
criterias -
public Criteria or(Field field)
OR
field -
public Criteria or(Criteria criteria)
OR
criteria -
public Criteria or(String fieldname)
OR
fieldname -
public Criteria is(Object o)
Criteria.CriteriaEntry without any wildcards. Strings with blanks will be escaped
"string\ with\ blank"
o -
public Criteria is(Object... values)
Criteria.CriteriaEntry without any wildcards for each entry
values -
public Criteria is(Iterable<?> values)
Criteria.CriteriaEntry without any wildcards for each entry
values -
public Criteria isNull()
Criteria.CriteriaEntry for null values
public Criteria isNotNull()
Criteria.CriteriaEntry for !null values
public Criteria contains(String s)
Criteria.CriteriaEntry with leading and trailing wildcards
s -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria contains(String... values)
Criteria.CriteriaEntry with leading and trailing wildcards for each entry
values -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria contains(Iterable<String> values)
Criteria.CriteriaEntry with leading and trailing wildcards for each entry
values -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria startsWith(String s)
Criteria.CriteriaEntry with trailing wildcard
s -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria startsWith(String... values)
Criteria.CriteriaEntry with trailing wildcard for each entry
values -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria startsWith(Iterable<String> values)
Criteria.CriteriaEntry with trailing wildcard for each entry
values -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria endsWith(String s)
Criteria.CriteriaEntry with leading wildcard
s -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria endsWith(String... values)
Criteria.CriteriaEntry with leading wildcard for each entry
values -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria endsWith(Iterable<String> values)
Criteria.CriteriaEntry with leading wildcard for each entry
values -
InvalidDataAccessApiUsageException - for strings with whitespacepublic Criteria not()
- operator
public Criteria fuzzy(String s)
Criteria.CriteriaEntry with trailing ~
s -
public Criteria fuzzy(String s,
float levenshteinDistance)
Criteria.CriteriaEntry with trailing ~ followed by levensteinDistance
s - levenshteinDistance -
public Criteria sloppy(String phrase,
int distance)
Criteria.CriteriaEntry with trailing ~ followed by distance
phrase - distance -
public Criteria expression(String s)
Criteria.CriteriaEntry allowing native solr expressions
s -
public Criteria boost(float boost)
boost -
public Criteria between(Object lowerBound,
Object upperBound)
Criteria.CriteriaEntry for RANGE [lowerBound TO upperBound]
lowerBound - upperBound -
public Criteria between(Object lowerBound,
Object upperBound,
boolean includeLowerBound,
boolean includeUppderBound)
Criteria.CriteriaEntry for RANGE [lowerBound TO upperBound]
lowerBound - upperBound - includeLowerBound - includeUppderBound -
public Criteria lessThan(Object upperBound)
Criteria.CriteriaEntry for RANGE [* TO upperBound}
upperBound -
public Criteria lessThanEqual(Object upperBound)
Criteria.CriteriaEntry for RANGE [* TO upperBound]
upperBound -
public Criteria greaterThan(Object lowerBound)
Criteria.CriteriaEntry for RANGE {lowerBound TO *]
lowerBound -
public Criteria greaterThanEqual(Object lowerBound)
Criteria.CriteriaEntry for RANGE [lowerBound TO *]
lowerBound -
public Criteria in(Object... values)
Criteria.CriteriaEntry for multiple values (arg0 arg1 arg2 ...)
values -
public Criteria in(Iterable<?> values)
Criteria.CriteriaEntry for multiple values (arg0 arg1 arg2 ...)
values - the collection containing the values to match against
public Criteria within(GeoLocation location,
Distance distance)
Criteria.CriteriaEntry for !geodist
location - GeoLocation in degreesdistance -
public Criteria near(BoundingBox box)
Criteria.CriteriaEntry for !bbox with exact coordinates
box -
public Criteria near(GeoLocation location,
Distance distance)
Criteria.CriteriaEntry for !bbox for a specified distance. The difference between this and
within is this is approximate while within is exact.
location - distance -
IllegalArgumentException - if location is null
InvalidDataAccessApiUsageException - if distance is negativepublic Criteria function(Function function)
Criteria.CriteriaEntry for given Function.
function - must not be null
IllegalArgumentException - if function is nullpublic Field getField()
public Set<Criteria.CriteriaEntry> getCriteriaEntries()
Criteria.CriteriaEntrypublic String getConjunctionOperator()
public List<Criteria> getCriteriaChain()
public boolean isNegating()
not() criteriapublic float getBoost()
Float.NaN if not set
|
Spring Data Solr | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||