Package io.objectbox.query

Class QueryBuilder<T>

  • Type Parameters:
    T - Entity class for which the Query is built.
    public class QueryBuilder<T>
extends java.lang.Object
    Builds a Query using conditions which can then be used to return a list of matching Objects.

    A simple example: 

     userBox.query()
     .equal(User_.firstName, "Joe", StringOrder.CASE_SENSITIVE)
     .order(User_.lastName)
     .build()
     .find()

    To add a condition use the appropriate method, for example equal(Property, String, StringOrder) or isNull(Property). To order results use order(Property) and its related methods.

    Use build() to create a Query object, which is used to actually get the results.

    Note: by default Query returns full Objects. To return only values or an aggregate value for a single Property, use Query.property(Property).

    See the Queries documentation for details.

    • Field Detail

      • DESCENDING

        public static final int DESCENDING
        Reverts the order from ascending (default) to descending.
        See Also:
        Constant Field Values

      • CASE_SENSITIVE

        public static final int CASE_SENSITIVE
        Makes upper case letters (e.g. "Z") be sorted before lower case letters (e.g. "a"). If not specified, the default is case insensitive for ASCII characters.
        See Also:
        Constant Field Values

      • NULLS_LAST

        public static final int NULLS_LAST
        null values will be put last. If not specified, by default null values will be put first.
        See Also:
        Constant Field Values

      • NULLS_ZERO

        public static final int NULLS_ZERO
        null values should be treated equal to zero (scalars only).
        See Also:
        Constant Field Values

      • UNSIGNED

        public static final int UNSIGNED
        For scalars only: changes the comparison to unsigned (default is signed).
        See Also:
        Constant Field Values

    • Constructor Detail

      • QueryBuilder

        @Internal
public QueryBuilder​(Box<T> box,
                    long storeHandle,
                    java.lang.String entityName)

    • Method Detail

      • finalize

        protected void finalize()
                 throws java.lang.Throwable
        Typically build() is called on this which calls close() and avoids expensive finalization here.

        If build() is not called, make sure to explicitly call close().

        Overrides:
        finalize in class java.lang.Object
        Throws:
        java.lang.Throwable

      • close

        public void close()
        Close this query builder and free used resources.

        This is not required when calling build().

      • build

        public Query<T> build()
        Builds the query and closes this QueryBuilder.

      • apply

        @Experimental
public QueryBuilder<T> apply​(QueryCondition<T> queryCondition)
        Experimental. This API might change or be removed in the future based on user feedback.

        Applies the given query conditions and returns the builder for further customization, such as result order. Build the condition using the properties from your entity underscore classes.

        An example with a nested OR condition: 

         # Java
 builder.apply(User_.name.equal("Jane")
         .and(User_.age.less(12)
                 .or(User_.status.equal("child"))));

 # Kotlin
 builder.apply(User_.name.equal("Jane")
         and (User_.age.less(12)
         or User_.status.equal("child")))
        Use Box.query(QueryCondition) as a shortcut for this method.

      • order

        public QueryBuilder<T> order​(Property<T> property,
                             int flags)
        Defines the order with which the results are ordered (default: none). You can chain multiple order conditions. The first applied order condition will be the most relevant. Order conditions applied afterwards are only relevant if the preceding ones resulted in value equality.

        Example:

        queryBuilder.order(Name).orderDesc(YearOfBirth);

        Here, "Name" defines the primary sort order. The secondary sort order "YearOfBirth" is only used to compare entries with the same "Name" values.

        Parameters:
        property - the property defining the order
        flags - Bit flags that can be combined using the binary OR operator (|). Available flags are DESCENDING, CASE_SENSITIVE, NULLS_LAST, NULLS_ZERO, and UNSIGNED.
        See Also:
        order(Property), orderDesc(Property)

      • sort

        public QueryBuilder<T> sort​(java.util.Comparator<T> comparator)

      • parameterAlias

        public QueryBuilder<T> parameterAlias​(java.lang.String alias)
        Assigns the given alias to the previous condition.
        Parameters:
        alias - The string alias for use with setParameter(s) methods.

      • link

        public <TARGET> QueryBuilder<TARGET> link​(RelationInfo<?,​TARGET> relationInfo)
        Creates a link to another entity, for which you also can describe conditions using the returned builder.

        Note: in relational databases you would use a "join" for this.

        Type Parameters:
        TARGET - The target entity. For parent/tree like relations, it can be the same type.
        Parameters:
        relationInfo - Relation meta info (generated)
        Returns:
        A builder to define query conditions at the target entity side.

      • backlink

        public <TARGET> QueryBuilder<TARGET> backlink​(RelationInfo<TARGET,​?> relationInfo)
        Creates a backlink (reversed link) to another entity, for which you also can describe conditions using the returned builder.

        Note: only use this method over link(RelationInfo), if you did not define @Backlink in the entity already.

        Note: in relational databases you would use a "join" for this.

        Type Parameters:
        TARGET - The target entity. For parent/tree like relations, it can be the same type.
        Parameters:
        relationInfo - Relation meta info (generated) of the original relation (reverse direction)
        Returns:
        A builder to define query conditions at the target entity side.

      • eager

        public QueryBuilder<T> eager​(RelationInfo relationInfo,
                             RelationInfo... more)
        Specifies relations that should be resolved eagerly. This prepares the given relation objects to be preloaded (cached) avoiding further get operations from the db. A common use case is prealoading all
        Parameters:
        relationInfo - The relation as found in the generated meta info class ("EntityName_") of class T.
        more - Supply further relations to be eagerly loaded.

      • eager

        public QueryBuilder<T> eager​(int limit,
                             RelationInfo relationInfo,
                             @Nullable
                             RelationInfo... more)
        Like eager(RelationInfo, RelationInfo[]), but limits eager loading to the given count.
        Parameters:
        limit - Count of entities to be eager loaded.
        relationInfo - The relation as found in the generated meta info class ("EntityName_") of class T.
        more - Supply further relations to be eagerly loaded.

      • filter

        public QueryBuilder<T> filter​(QueryFilter<T> filter)
        Sets a filter that executes on primary query results (returned from the db core) on a Java level. For efficiency reasons, you should always prefer primary criteria like equal(Property, long) if possible. A filter requires to instantiate full Java objects beforehand, which is less efficient.

        The upside of filters is that they allow any complex operation including traversing object graphs, and that filtering is executed along with the query (preferably in a background thread). Use filtering wisely ;-).

        Also note, that a filter may only be used along with Query.find() and Query.forEach(QueryConsumer) at this point. Other find methods will throw a exception and aggregate functions will silently ignore the filter.

      • or

        public QueryBuilder<T> or()
        Combines the previous condition with the following condition with a logical OR.

        Example (querying t-shirts): 

        
 queryBuilder.equal(color, "blue").or().less(price, 30).build() // color is blue OR price < 30

      • and

        public QueryBuilder<T> and()
        And AND changes how conditions are combined using a following OR. By default, all query conditions are already combined using AND. Do not use this method if all your query conditions must match (AND for all, this is the default).

        However, this method change the precedence with other combinations such as or(). This is best explained by example.

        Example (querying t-shirts): 

        
 // Case (1): OR has precedence
 queryBuilder.equal(color, "blue").equal(size, "XL").or().less(price, 30).build()

 // Case (2): AND has precedence
 queryBuilder.equal(color, "blue").and().equal(size, "XL").or().less(price, 30).build()

        Rule: Explicit AND / OR combination have precedence.

        That's why (1) is evaluated like "must be blue and is either of size XL or costs less than 30", or more formally: blue AND (size XL OR price less than 30).

        Rule: Conditions are applied from left to right (in the order they are called).

        That's why in (2) the AND is evaluated before the OR. Thus, (2) evaluates to "either must be blue and of size XL, or costs less than 30", or, more formally: (blue AND size XL) OR price less than 30.

      • between

        public QueryBuilder<T> between​(Property<T> property,
                               long value1,
                               long value2)
        Finds objects with property value between and including the first and second value.

      • lessOrEqual

        public QueryBuilder<T> lessOrEqual​(Property<T> property,
                                   java.util.Date value)
        Throws:
        java.lang.NullPointerException - if given value is null. Use isNull(Property) instead.

      • greaterOrEqual

        public QueryBuilder<T> greaterOrEqual​(Property<T> property,
                                      java.util.Date value)
        Throws:
        java.lang.NullPointerException - if given value is null. Use isNull(Property) instead.

      • between

        public QueryBuilder<T> between​(Property<T> property,
                               java.util.Date value1,
                               java.util.Date value2)
        Finds objects with property value between and including the first and second value.
        Throws:
        java.lang.NullPointerException - if one of the given values is null.

      • containsElement

        public QueryBuilder<T> containsElement​(Property<T> property,
                                       java.lang.String value,
                                       QueryBuilder.StringOrder order)
        For a String array, list or String-key map property, matches if at least one element equals the given value.

      • containsKeyValue

        public QueryBuilder<T> containsKeyValue​(Property<T> property,
                                        java.lang.String key,
                                        java.lang.String value,
                                        QueryBuilder.StringOrder order)
        For a String-key map property, matches if at least one key and value combination equals the given values.

      • between

        public QueryBuilder<T> between​(Property<T> property,
                               double value1,
                               double value2)
        Finds objects with property value between and including the first and second value.