Package com.apple.foundationdb.record.query.expressions

Classes implementing logical query expression.

A QueryComponent represents a boolean predicate against a record in the record store, like the WHERE clause in SQL databases. Query expressions are built using static methods on Query and then passed to setFilter.

For example,

 queryBuilder.setFilter(Query.and(
     Query.field("field1").equalsParameter("p1"),
     Query.field("field2").greaterThan(100)))
 

Interface Summary

Interface	Description
Comparisons.Comparison	A comparison between a value associated with someplace in the record (such as a field) and a value associated with the plan (such as a constant or a bound parameter).
ComponentWithChildren	A QueryComponent that has child components.
ComponentWithComparison	A QueryComponent that uses a Comparisons.Comparison on the record.
ComponentWithNoChildren	A QueryComponent that does not have any child components.
ComponentWithSingleChild	A QueryComponent with exactly one child component.
QueryComponent	Base component interface for checking whether a given record matches a query.

Class Summary

Class	Description
AndComponent	A QueryComponent that is satisfied when all of its child components are satisfied.
AndOrComponent	The common base class for Boolean And and Or query components.
BaseField	An abstract base class for field-like QueryComponents that involve predicates on one particular record field, as specified by the BaseField.fieldName member.
BaseNestedField	An abstract base class for all QueryComponents that represent a query of a nested record type.
Comparisons	Helper methods for building Comparisons.Comparisons.
Comparisons.ListComparison	A comparison with a list of values.
Comparisons.MultiColumnComparison	Comparison wrapping another one and answering true to Comparisons.MultiColumnComparison.hasMultiColumnComparand().
Comparisons.NullComparison	A unary predicate for special nullity checks, such as NULL and NOT NULL.
Comparisons.ParameterComparison	A comparison with a bound parameter, as opposed to a literal constant in the query.
Comparisons.SimpleComparison	A comparison with a constant value.
Comparisons.TextComparison	A text-style comparison, such as containing a given set of tokens.
Comparisons.TextContainsAllPrefixesComparison	A Comparisons.TextComparison that checks for all prefixes.
Comparisons.TextWithMaxDistanceComparison	A Comparisons.TextComparison that must be satisfied within a certain number of text tokens.
EmptyComparison	A comparison to determine whether a repeated field is empty (has no occurrences).
Field	Class that provides context for asserting about a field value.
FieldWithComparison	A QueryComponent that implements a Comparisons.Comparison against a field of the record.
NestedField	A QueryComponent that evaluates a nested component against a Message-valued field.
NotComponent	A QueryComponent that is satisfied when its child component is not satisfied.
OneOfThem	Class for matching any value of a repeated field.
OneOfThemWithComparison	A QueryComponent that evaluates a Comparisons.Comparison against each of the values of a repeated field and is satisfied if any of those are.
OneOfThemWithComponent	A QueryComponent that evaluates a nested component against each of the values of a repeated field and is satisfied if any of those are.
OrComponent	A QueryComponent that is satisfied when any of its child components is satisfied.
Query	Holder class for creating querying expressions.
QueryKeyExpression	Allow use of a QueryableKeyExpression in a query.
QueryKeyExpressionWithComparison	A QueryComponent that implements a Comparisons.Comparison against a QueryableKeyExpression.
QueryRecordFunction<T>	Class that provides context for asserting about a specially calculated value.
QueryRecordFunctionWithComparison	A Comparisons.Comparison whose value from the record, to be compared with the comparison's value, is the result of applying a RecordFunction to the record.
RecordTypeKeyComparison	A QueryComponent that implements checking for a given record type.
Text	Predicates that can be applied to a field that has been indexed with a full-text index.

Enum Summary

Enum	Description
Comparisons.Type	The type for a Comparisons.Comparison predicate.
Field.OneOfThemEmptyMode	How an empty / unset repeated field should be handled.

Exception Summary

Exception	Description
Comparisons.EvaluationContextRequiredException	Exception thrown when comparison evaluation needs the query context, but none was supplied.
Query.InvalidExpressionException	Exception thrown when a query expression is not valid in some context.