com.thinkaurelius.titan.diskstorage.indexing

## Class IndexQuery

- java.lang.Object
- - com.thinkaurelius.titan.graphdb.query.BaseQuery
  - - com.thinkaurelius.titan.diskstorage.indexing.IndexQuery

- All Implemented Interfaces:
    BackendQuery<IndexQuery>, Query

      public class IndexQuery
      extends BaseQuery
      implements BackendQuery<IndexQuery>

  An external index query executed on an `IndexProvider`.

  A query is comprised of the store identifier against which the query ought to be executed and a query condition which defines which entries match the query.
  Author:
    Matthias Broecheler (me@matthiasb.com)

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `IndexQuery.OrderEntry`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static com.google.common.collect.ImmutableList<IndexQuery.OrderEntry>` | `NO_ORDER`

    - ### Fields inherited from interface com.thinkaurelius.titan.graphdb.query.Query

      `NO_LIMIT`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `IndexQuery(String store, Condition condition)`
    `IndexQuery(String store, Condition condition, com.google.common.collect.ImmutableList<IndexQuery.OrderEntry> orders)`
    `IndexQuery(String store, Condition condition, com.google.common.collect.ImmutableList<IndexQuery.OrderEntry> orders, int limit)`
    `IndexQuery(String store, Condition condition, int limit)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object other)`
    `Condition<TitanElement>` | `getCondition()`
    `List<IndexQuery.OrderEntry>` | `getOrder()`
    `String` | `getStore()`
    `int` | `hashCode()`
    `IndexQuery` | `setLimit(int limit)` Sets the limit of the query if it wasn't specified in the constructor
    `String` | `toString()`
    `IndexQuery` | `updateLimit(int newLimit)` Creates a new query identical to the current one but with the specified limit.

    - ### Methods inherited from class com.thinkaurelius.titan.graphdb.query.BaseQuery

      `getLimit, hasLimit`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface com.thinkaurelius.titan.graphdb.query.Query

      `getLimit, hasLimit`

- - ### Field Detail

    - #### NO_ORDER

          public static final com.google.common.collect.ImmutableList<IndexQuery.OrderEntry> NO_ORDER

  - ### Constructor Detail

    - #### IndexQuery

          public IndexQuery(String store,
                    Condition condition,
                    com.google.common.collect.ImmutableList<IndexQuery.OrderEntry> orders,
                    int limit)

    - #### IndexQuery

          public IndexQuery(String store,
                    Condition condition,
                    com.google.common.collect.ImmutableList<IndexQuery.OrderEntry> orders)

    - #### IndexQuery

          public IndexQuery(String store,
                    Condition condition)

    - #### IndexQuery

          public IndexQuery(String store,
                    Condition condition,
                    int limit)

  - ### Method Detail

    - #### getCondition

          public Condition<TitanElement> getCondition()

    - #### getOrder

          public List<IndexQuery.OrderEntry> getOrder()

    - #### getStore

          public String getStore()

    - #### setLimit

          public IndexQuery setLimit(int limit)

      Description copied from class: `BaseQuery`
      Sets the limit of the query if it wasn't specified in the constructor
      Overrides:
        `setLimit` in class `BaseQuery`
      Returns:

    - #### updateLimit

          public IndexQuery updateLimit(int newLimit)

      Description copied from interface: `BackendQuery`
      Creates a new query identical to the current one but with the specified limit.
      Specified by:
        `updateLimit` in interface `BackendQuery<IndexQuery>`
      Returns:

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### equals

          public boolean equals(Object other)

      Overrides:
        `equals` in class `Object`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2012–2014. All rights reserved.