Query (BigConnect: Common: Core 4.2.1 API)

All Known Subinterfaces:

GraphQuery, MultiVertexQuery, SimilarToGraphQuery, VertexQuery

All Known Implementing Classes:

DefaultExtendedDataQuery, DefaultGraphQuery, DefaultMultiVertexQuery, DefaultVertexQuery, EmptyResultsGraphQuery, GraphQueryBase, QueryBase, VertexQueryBase
```
public interface Query
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Query`	`addAggregation(Aggregation aggregation)` Add an aggregation to the query
`QueryResultsIterable<String>`	`edgeIds()` Execute the query and return the ids of all matching edges.
`QueryResultsIterable<String>`	`edgeIds(EnumSet<IdFetchHint> fetchHints)` Execute the query and return the ids of all matching edges.
`QueryResultsIterable<Edge>`	`edges()`
`QueryResultsIterable<Edge>`	`edges(FetchHints fetchHints)`
`QueryResultsIterable<Edge>`	`edges(String label)` Deprecated.
`QueryResultsIterable<Edge>`	`edges(String label, FetchHints fetchHints)` Deprecated.
`QueryResultsIterable<String>`	`elementIds()` Execute the query and return the ids of all matching elements.
`QueryResultsIterable<String>`	`elementIds(EnumSet<IdFetchHint> fetchHints)` Execute the query and return the ids of all matching elements.
`QueryResultsIterable<Element>`	`elements()`
`QueryResultsIterable<Element>`	`elements(FetchHints fetchHints)`
`QueryResultsIterable<ExtendedDataRowId>`	`extendedDataRowIds()` Execute the query and return the ids of all matching extended data rows.
`QueryResultsIterable<ExtendedDataRowId>`	`extendedDataRowIds(EnumSet<IdFetchHint> fetchHints)` Execute the query and return the ids of all matching extended data rows.
`QueryResultsIterable<ExtendedDataRow>`	`extendedDataRows()`
`QueryResultsIterable<ExtendedDataRow>`	`extendedDataRows(FetchHints fetchHints)`
`Iterable<Aggregation>`	`getAggregations()` Gets the added aggregations
`<T extends Value> Query`	`has(Class<T> dataType)` Adds a has filter to the query.
`<T extends Value,K extends Value> Query`	`has(Class<T> dataType, Predicate predicate, K value)` Adds a filter to the query.
`<T> Query`	`has(Iterable<String> propertyNames)` Adds a filter to the query.
`<T extends Value> Query`	`has(Iterable<String> propertyNames, Predicate predicate, T value)` Adds a filter to the query.
`Query`	`has(String propertyName)` Adds a has filter to the query.
`<T extends Value> Query`	`has(String propertyName, Predicate predicate, Conjunction conjunction, T value)` Adds a filter to the query.
`<T extends Value> Query`	`has(String propertyName, Predicate predicate, T value)` Adds a filter to the query.
`<T extends Value> Query`	`has(String propertyName, T value)` Adds an `Compare.EQUAL` filter to the query.
`Query`	`hasAuthorization(Iterable<String> authorizations)` Adds an authorization filter to the query.
`Query`	`hasAuthorization(String... authorizations)` Adds an authorization filter to the query.
`Query`	`hasConceptType(Collection<String> conceptTypes)`
`Query`	`hasConceptType(String... conceptTypes)`
`Query`	`hasEdgeLabel(Collection<String> edgeLabels)` Adds a edge label filter to the query.
`Query`	`hasEdgeLabel(String... edgeLabels)` Adds a edge label filter to the query.
`Query`	`hasExtendedData(ElementType elementType, String elementId)` Adds a extended data element filter to the query.
`Query`	`hasExtendedData(ElementType elementType, String elementId, String tableName)` Adds a extended data element filter to the query.
`Query`	`hasExtendedData(Iterable<HasExtendedDataFilter> filters)` Adds a multiple extended data element filter to the query.
`Query`	`hasExtendedData(String tableName)` Adds a extended data table filter to the query.
`Query`	`hasId(Iterable<String> ids)` Adds an id filter to the query.
`Query`	`hasId(String... ids)` Adds an id filter to the query.
`<T extends Value> Query`	`hasNot(Class<T> dataType)` Adds a hasNot filter to the query.
`<T> Query`	`hasNot(Iterable<String> propertyNames)` Adds a filter to the query.
`Query`	`hasNot(String propertyName)` Adds a hasNot filter to the query.
`<T extends Value> Query`	`hasNot(String propertyName, T value)` Adds an `Contains.NOT_IN` filter to the query.
`boolean`	`isAggregationSupported(Aggregation aggregation)` Test to see if aggregation is supported.
`Query`	`limit(Integer count)` Limits the number of items returned.
`Query`	`limit(Long count)` Limits the number of items returned.
`Query`	`minScore(double score)` Minimum score to return
`<T extends Value> Query`	`range(String propertyName, T startValue, boolean inclusiveStartValue, T endValue, boolean inclusiveEndValue)` Queries for properties in the given range.
`<T extends Value> Query`	`range(String propertyName, T startValue, T endValue)` Queries for properties in the given range.
`Query`	`scoringStrategy(ScoringStrategy scoringStrategy)` Sets the scoring strategy for this query
`QueryResultsIterable<? extends GeObject>`	`search()`
`QueryResultsIterable<? extends GeObject>`	`search(EnumSet<GeObjectType> objectTypes, FetchHints fetchHints)`
`Query`	`setShard(String shardId)`
`Query`	`skip(int count)` Skips the given number of items.
`Query`	`sort(SortingStrategy sortingStrategy, SortDirection direction)` Sort the results by the given `SortingStrategy`.
`Query`	`sort(String propertyName, SortDirection direction)` Sort the results by the given property name.
`QueryResultsIterable<String>`	`vertexIds()` Execute the query and return the ids of all matching vertices.
`QueryResultsIterable<String>`	`vertexIds(EnumSet<IdFetchHint> fetchHints)` Execute the query and return the ids of all matching vertices.
`QueryResultsIterable<Vertex>`	`vertices()`
`QueryResultsIterable<Vertex>`	`vertices(FetchHints fetchHints)`

- Method Detail
  - vertices
```
QueryResultsIterable<Vertex> vertices()
```
  - vertices
```
QueryResultsIterable<Vertex> vertices(FetchHints fetchHints)
```
  - vertexIds
```
QueryResultsIterable<String> vertexIds()
```
    Execute the query and return the ids of all matching vertices. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching vertices. Hidden vertices are not included in the results.
    
    Returns:
    
    The ids of vertices that match this query.
  - vertexIds
```
QueryResultsIterable<String> vertexIds(EnumSet<IdFetchHint> fetchHints)
```
    Execute the query and return the ids of all matching vertices. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching vertices.
    
    Parameters:
    
    fetchHints - Details about which data to fetch.
    
    Returns:
    
    The ids of vertices that match this query.
  - edges
```
QueryResultsIterable<Edge> edges()
```
  - edges
```
QueryResultsIterable<Edge> edges(FetchHints fetchHints)
```
  - edgeIds
```
QueryResultsIterable<String> edgeIds()
```
    Execute the query and return the ids of all matching edges. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching edges. Hidden edges are not included in the results.
    
    Returns:
    
    The ids of edges that match this query.
  - edgeIds
```
QueryResultsIterable<String> edgeIds(EnumSet<IdFetchHint> fetchHints)
```
    Execute the query and return the ids of all matching edges. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching edges. Hidden edges are not included in the results.
    
    Parameters:
    
    fetchHints - Details about which data to fetch.
    
    Returns:
    
    The ids of edges that match this query.
  - extendedDataRows
```
QueryResultsIterable<ExtendedDataRow> extendedDataRows()
```
  - extendedDataRows
```
QueryResultsIterable<ExtendedDataRow> extendedDataRows(FetchHints fetchHints)
```
  - extendedDataRowIds
```
QueryResultsIterable<ExtendedDataRowId> extendedDataRowIds()
```
    Execute the query and return the ids of all matching extended data rows. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching extended data rows. Hidden extended data rows are not included in the results.
    
    Returns:
    
    The ids of extended data rows that match this query.
  - extendedDataRowIds
```
QueryResultsIterable<ExtendedDataRowId> extendedDataRowIds(EnumSet<IdFetchHint> fetchHints)
```
    Execute the query and return the ids of all matching extended data rows. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching extended data rows. Hidden extended data rows are not included in the results.
    
    Parameters:
    
    fetchHints - Details about which data to fetch.
    
    Returns:
    
    The ids of extended data rows that match this query.
  - edges
```
@Deprecated
QueryResultsIterable<Edge> edges(String label)
```
    Deprecated.
  - edges
```
@Deprecated
QueryResultsIterable<Edge> edges(String label,
                                             FetchHints fetchHints)
```
    Deprecated.
  - elements
```
QueryResultsIterable<Element> elements()
```
  - elements
```
QueryResultsIterable<Element> elements(FetchHints fetchHints)
```
  - elementIds
```
QueryResultsIterable<String> elementIds()
```
    Execute the query and return the ids of all matching elements. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching elements. Hidden elements are not included in the results.
    
    Returns:
    
    The ids of elements that match this query.
  - elementIds
```
QueryResultsIterable<String> elementIds(EnumSet<IdFetchHint> fetchHints)
```
    Execute the query and return the ids of all matching elements. This method will not load the data from storage, which is more efficient in cases where you only need to know the ids of matching elements. Hidden elements are not included in the results.
    
    Returns:
    
    The ids of elements that match this query.
  - search
```
QueryResultsIterable<? extends GeObject> search(EnumSet<GeObjectType> objectTypes,
                                                FetchHints fetchHints)
```
  - search
```
QueryResultsIterable<? extends GeObject> search()
```
  - range
```
<T extends Value> Query range(String propertyName,
                              T startValue,
                              T endValue)
```
    Queries for properties in the given range.
    
    Parameters:
    
    propertyName - Name of property.
    
    startValue - Inclusive start value.
    
    endValue - Inclusive end value.
    
    Returns:
    
    this
  - range
```
<T extends Value> Query range(String propertyName,
                              T startValue,
                              boolean inclusiveStartValue,
                              T endValue,
                              boolean inclusiveEndValue)
```
    Queries for properties in the given range.
    
    Parameters:
    
    propertyName - Name of property.
    
    startValue - Inclusive start value.
    
    inclusiveStartValue - true, to include the start value
    
    endValue - Inclusive end value.
    
    inclusiveEndValue - true, to include the end value
    
    Returns:
    
    this
  - hasId
```
Query hasId(String... ids)
```
    Adds an id filter to the query. When searching for elements this will limit the search to the elements with the given ids. When searching for extended data rows this will limit the search to the elements containing the extended data rows.
    
    Parameters:
    
    ids - The ids to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasId
```
Query hasId(Iterable<String> ids)
```
    Adds an id filter to the query. When searching for elements this will limit the search to the elements with the given ids. When searching for extended data rows this will limit the search to the elements containing the extended data rows.
    
    Parameters:
    
    ids - The ids to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasEdgeLabel
```
Query hasEdgeLabel(String... edgeLabels)
```
    Adds a edge label filter to the query.
    
    Parameters:
    
    edgeLabels - The edge labels to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasConceptType
```
Query hasConceptType(String... conceptTypes)
```
  - hasConceptType
```
Query hasConceptType(Collection<String> conceptTypes)
```
  - hasEdgeLabel
```
Query hasEdgeLabel(Collection<String> edgeLabels)
```
    Adds a edge label filter to the query.
    
    Parameters:
    
    edgeLabels - The edge labels to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasAuthorization
```
Query hasAuthorization(String... authorizations)
```
    Adds an authorization filter to the query.
    
    Parameters:
    
    authorizations - An element will match if it or any of its properties use one of the specified authorizations.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasAuthorization
```
Query hasAuthorization(Iterable<String> authorizations)
```
    Adds an authorization filter to the query.
    
    Parameters:
    
    authorizations - An element will match if it or any of its properties use one of the specified authorizations.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasExtendedData
```
Query hasExtendedData(ElementType elementType,
                      String elementId)
```
    Adds a extended data element filter to the query. This will query any table.
    
    Parameters:
    
    elementType - The type of element.
    
    elementId - The element id
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasExtendedData
```
Query hasExtendedData(ElementType elementType,
                      String elementId,
                      String tableName)
```
    Adds a extended data element filter to the query. This will limit the search to the supplied extended data records.
    
    Parameters:
    
    elementType - The type of element. null to search all element types.
    
    elementId - The element id. null to search all elements.
    
    tableName - The table name. null to search all tables.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasExtendedData
```
Query hasExtendedData(Iterable<HasExtendedDataFilter> filters)
```
    Adds a multiple extended data element filter to the query. These will be or'ed together. This will limit the search to the supplied extended data records.
    
    Parameters:
    
    filters - The list of filters to be or'ed together.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasExtendedData
```
Query hasExtendedData(String tableName)
```
    Adds a extended data table filter to the query.
    
    Parameters:
    
    tableName - The table name
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T extends Value> Query has(String propertyName,
                            T value)
```
    Adds an Compare.EQUAL filter to the query.
    
    Parameters:
    
    propertyName - The name of the property to query on.
    
    value - The value of the property to query for.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasNot
```
<T extends Value> Query hasNot(String propertyName,
                               T value)
```
    Adds an Contains.NOT_IN filter to the query.
    
    Parameters:
    
    propertyName - The name of the property to query on.
    
    value - The value of the property to query for.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
Query has(String propertyName)
```
    Adds a has filter to the query.
    
    Parameters:
    
    propertyName - The name of the property the element must contain.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T> Query has(Iterable<String> propertyNames)
```
    Adds a filter to the query.
    
    Parameters:
    
    propertyNames - A document will match if it contains any properties specified.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasNot
```
Query hasNot(String propertyName)
```
    Adds a hasNot filter to the query.
    
    Parameters:
    
    propertyName - The name of the property the element must not contain.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasNot
```
<T> Query hasNot(Iterable<String> propertyNames)
```
    Adds a filter to the query.
    
    Parameters:
    
    propertyNames - A document will match if it does not contain any properties specified.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T extends Value> Query has(String propertyName,
                            Predicate predicate,
                            T value)
```
    Adds a filter to the query.
    
    Parameters:
    
    propertyName - The name of the property to query on.
    
    predicate - One of Compare, TextPredicate, or GeoCompare.
    
    value - The value of the property to query for.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T extends Value> Query has(String propertyName,
                            Predicate predicate,
                            Conjunction conjunction,
                            T value)
```
    Adds a filter to the query.
    
    Parameters:
    
    propertyName - The name of the property to query on.
    
    predicate - One of Compare, TextPredicate, or GeoCompare.
    
    conjunction - AND/OR
    
    value - The value of the property to query for.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T extends Value> Query has(Iterable<String> propertyNames,
                            Predicate predicate,
                            T value)
```
    Adds a filter to the query.
    
    Parameters:
    
    propertyNames - All properties to query on. A match in any of the given properties will cause a document to match.
    
    predicate - One of Compare, TextPredicate, or GeoCompare.
    
    value - The value of the property to query for.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T extends Value,K extends Value> Query has(Class<T> dataType,
                                            Predicate predicate,
                                            K value)
```
    Adds a filter to the query.
    
    Parameters:
    
    dataType - All properties with a matching datatype will be queried on. A match in any of the selected properties will cause a document to match.
    
    predicate - One of Compare, TextPredicate, or GeoCompare.
    
    value - The value of the property to query for.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
<T extends Value> Query has(Class<T> dataType)
```
    Adds a has filter to the query.
    
    Parameters:
    
    dataType - A document will match if it contains any properties of the specified datatype.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasNot
```
<T extends Value> Query hasNot(Class<T> dataType)
```
    Adds a hasNot filter to the query.
    
    Parameters:
    
    dataType - A document will match if it does not contain any properties of the specified datatype.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - skip
```
Query skip(int count)
```
    Skips the given number of items.
  - limit
```
Query limit(Integer count)
```
    Limits the number of items returned. null will return all elements.
  - limit
```
Query limit(Long count)
```
    Limits the number of items returned. null will return all elements.
  - minScore
```
Query minScore(double score)
```
    Minimum score to return
  - sort
```
Query sort(String propertyName,
           SortDirection direction)
```
    Sort the results by the given property name.
    
    Parameters:
    
    propertyName - The property to sort by.
    
    direction - The direction to sort.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - sort
```
Query sort(SortingStrategy sortingStrategy,
           SortDirection direction)
```
    Sort the results by the given SortingStrategy.
    
    Parameters:
    
    sortingStrategy - The SortingStrategy to sort by.
    
    direction - The direction to sort.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - isAggregationSupported
```
boolean isAggregationSupported(Aggregation aggregation)
```
    Test to see if aggregation is supported.
    
    Parameters:
    
    aggregation - the aggregation to test.
    
    Returns:
    
    true, if the aggregation is supported
  - addAggregation
```
Query addAggregation(Aggregation aggregation)
```
    Add an aggregation to the query
    
    Parameters:
    
    aggregation - the aggregation to add.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - getAggregations
```
Iterable<Aggregation> getAggregations()
```
    Gets the added aggregations
  - scoringStrategy
```
Query scoringStrategy(ScoringStrategy scoringStrategy)
```
    Sets the scoring strategy for this query
  - setShard
```
Query setShard(String shardId)
```

Interface Query

Method Summary

Method Detail

vertices

vertices

vertexIds

vertexIds

edges

edges

edgeIds

edgeIds

extendedDataRows

extendedDataRows

extendedDataRowIds

extendedDataRowIds

edges

edges

elements

elements

elementIds

elementIds

search

search

range

range

hasId

hasId

hasEdgeLabel

hasConceptType

hasConceptType

hasEdgeLabel

hasAuthorization

hasAuthorization

hasExtendedData

hasExtendedData

hasExtendedData

hasExtendedData

has

hasNot

has

has

hasNot

hasNot

has

has

has

has

has

hasNot

skip

limit

limit

minScore

sort

sort

isAggregationSupported

addAggregation

getAggregations

scoringStrategy

setShard