QueryBase (BigConnect: Common: Core 4.2.1 API)

java.lang.Object
- com.mware.ge.query.QueryBase

All Implemented Interfaces:

GraphQuery, Query, SimilarToGraphQuery

Direct Known Subclasses:

DefaultExtendedDataQuery, DefaultMultiVertexQuery, GraphQueryBase, VertexQueryBase
```
public abstract class QueryBase
extends Object
implements Query, SimilarToGraphQuery
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryBase.HasAuthorizationContainer`
`static class`	`QueryBase.HasContainer`
`static class`	`QueryBase.HasExtendedData`
`static class`	`QueryBase.HasNotPropertyContainer`
`static class`	`QueryBase.HasPropertyContainer`
`static class`	`QueryBase.HasValueContainer`
`static class`	`QueryBase.PropertySortContainer`
`static interface`	`QueryBase.SortContainer`
`static class`	`QueryBase.SortingStrategySortContainer`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QueryBase(Graph graph, String[] similarToFields, String similarToText, Authorizations authorizations)`
`protected`	`QueryBase(Graph graph, String queryString, Authorizations authorizations)`
`protected`	`QueryBase(Graph graph, String queryString, String logicalQuery, Authorizations authorizations)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Query`	`addAggregation(Aggregation aggregation)` Add an aggregation to the query
`SimilarToGraphQuery`	`boost(float boost)` The amount of boost to apply to the similarity query.
`QueryResultsIterable<String>`	`edgeIds()` Execute the query and return the ids of all matching edges.
`QueryResultsIterable<String>`	`edgeIds(EnumSet<IdFetchHint> idFetchHints)` 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> idFetchHints)` Execute the query and return the ids of all matching elements.
`QueryResultsIterable<Element>`	`elements()`
`QueryResultsIterable<Element>`	`elements(FetchHints fetchHints)`
`protected QueryResultsIterable<? extends GeObject>`	`extendedData(FetchHints fetchHints)` This method should be overridden if `search(EnumSet, FetchHints)` is not overridden.
`protected QueryResultsIterable<? extends GeObject>`	`extendedData(FetchHints fetchHints, Iterable<? extends Element> elements)`
`QueryResultsIterable<ExtendedDataRowId>`	`extendedDataRowIds()` Execute the query and return the ids of all matching extended data rows.
`QueryResultsIterable<ExtendedDataRowId>`	`extendedDataRowIds(EnumSet<IdFetchHint> idFetchHints)` Execute the query and return the ids of all matching extended data rows.
`QueryResultsIterable<ExtendedDataRow>`	`extendedDataRows()`
`QueryResultsIterable<ExtendedDataRow>`	`extendedDataRows(FetchHints fetchHints)`
`Aggregation`	`getAggregationByName(String aggregationName)`
`Collection<Aggregation>`	`getAggregations()` Gets the added aggregations
`Graph`	`getGraph()`
`String`	`getLogicalQuery()`
`QueryParameters`	`getParameters()`
`<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.
`Query`	`hasInVertexTypes(String... vertexTypes)`
`<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.
`Query`	`hasOutVertexTypes(String... vertexTypes)`
`protected FetchHints`	`idFetchHintsToElementFetchHints(EnumSet<IdFetchHint> idFetchHints)`
`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.
`SimilarToGraphQuery`	`maxDocFrequency(int maxDocFrequency)` The maximum number of documents a term can be in to be considered for a similarity match.
`SimilarToGraphQuery`	`maxQueryTerms(int maxQueryTerms)` The maximum number of terms to be searched for.
`SimilarToGraphQuery`	`minDocFrequency(int minDocFrequency)` The minimum number of documents a term must be in to be considered for a similarity match.
`Query`	`minScore(double score)` Minimum score to return
`SimilarToGraphQuery`	`minTermFrequency(int minTermFrequency)` The minimum number of times a term must appear in the source data to be considered for a match.
`<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)`
`void`	`setLogicalQuery(String logicalQuery)`
`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.
`String`	`toString()`
`QueryResultsIterable<String>`	`vertexIds()` Execute the query and return the ids of all matching vertices.
`QueryResultsIterable<String>`	`vertexIds(EnumSet<IdFetchHint> idFetchHints)` Execute the query and return the ids of all matching vertices.
`QueryResultsIterable<Vertex>`	`vertices()`
`QueryResultsIterable<Vertex>`	`vertices(FetchHints fetchHints)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - QueryBase
```
protected QueryBase(Graph graph,
                    String queryString,
                    String logicalQuery,
                    Authorizations authorizations)
```
  - QueryBase
```
protected QueryBase(Graph graph,
                    String queryString,
                    Authorizations authorizations)
```
  - QueryBase
```
protected QueryBase(Graph graph,
                    String[] similarToFields,
                    String similarToText,
                    Authorizations authorizations)
```
- Method Detail
  - getLogicalQuery
```
public String getLogicalQuery()
```
  - setLogicalQuery
```
public void setLogicalQuery(String logicalQuery)
```
  - vertices
```
public QueryResultsIterable<Vertex> vertices()
```
    Specified by:
    
    vertices in interface Query
  - vertices
```
public QueryResultsIterable<Vertex> vertices(FetchHints fetchHints)
```
    Specified by:
    
    vertices in interface Query
  - vertexIds
```
public QueryResultsIterable<String> vertexIds()
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    vertexIds in interface Query
    
    Returns:
    
    The ids of vertices that match this query.
  - vertexIds
```
public QueryResultsIterable<String> vertexIds(EnumSet<IdFetchHint> idFetchHints)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    vertexIds in interface Query
    
    Parameters:
    
    idFetchHints - Details about which data to fetch.
    
    Returns:
    
    The ids of vertices that match this query.
  - edges
```
public QueryResultsIterable<Edge> edges()
```
    Specified by:
    
    edges in interface Query
  - edges
```
public QueryResultsIterable<Edge> edges(FetchHints fetchHints)
```
    Specified by:
    
    edges in interface Query
  - edgeIds
```
public QueryResultsIterable<String> edgeIds()
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    edgeIds in interface Query
    
    Returns:
    
    The ids of edges that match this query.
  - edgeIds
```
public QueryResultsIterable<String> edgeIds(EnumSet<IdFetchHint> idFetchHints)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    edgeIds in interface Query
    
    Parameters:
    
    idFetchHints - Details about which data to fetch.
    
    Returns:
    
    The ids of edges that match this query.
  - extendedDataRows
```
public QueryResultsIterable<ExtendedDataRow> extendedDataRows()
```
    Specified by:
    
    extendedDataRows in interface Query
  - extendedDataRows
```
public QueryResultsIterable<ExtendedDataRow> extendedDataRows(FetchHints fetchHints)
```
    Specified by:
    
    extendedDataRows in interface Query
  - extendedDataRowIds
```
public QueryResultsIterable<ExtendedDataRowId> extendedDataRowIds()
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    extendedDataRowIds in interface Query
    
    Returns:
    
    The ids of extended data rows that match this query.
  - extendedDataRowIds
```
public QueryResultsIterable<ExtendedDataRowId> extendedDataRowIds(EnumSet<IdFetchHint> idFetchHints)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    extendedDataRowIds in interface Query
    
    Parameters:
    
    idFetchHints - Details about which data to fetch.
    
    Returns:
    
    The ids of extended data rows that match this query.
  - search
```
public QueryResultsIterable<? extends GeObject> search()
```
    Specified by:
    
    search in interface Query
  - search
```
public QueryResultsIterable<? extends GeObject> search(EnumSet<GeObjectType> objectTypes,
                                                       FetchHints fetchHints)
```
    Specified by:
    
    search in interface Query
  - extendedData
```
protected QueryResultsIterable<? extends GeObject> extendedData(FetchHints fetchHints)
```
    This method should be overridden if search(EnumSet, FetchHints) is not overridden.
  - extendedData
```
protected QueryResultsIterable<? extends GeObject> extendedData(FetchHints fetchHints,
                                                                Iterable<? extends Element> elements)
```
  - hasId
```
public Query hasId(String... ids)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    hasId in interface Query
    
    Parameters:
    
    ids - The ids to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasId
```
public Query hasId(Iterable<String> ids)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    hasId in interface Query
    
    Parameters:
    
    ids - The ids to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasConceptType
```
public Query hasConceptType(String... conceptTypes)
```
    Specified by:
    
    hasConceptType in interface Query
  - hasConceptType
```
public Query hasConceptType(Collection<String> conceptTypes)
```
    Specified by:
    
    hasConceptType in interface Query
  - hasEdgeLabel
```
public Query hasEdgeLabel(String... edgeLabels)
```
    Description copied from interface: Query
    
    Adds a edge label filter to the query.
    
    Specified by:
    
    hasEdgeLabel in interface Query
    
    Parameters:
    
    edgeLabels - The edge labels to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasEdgeLabel
```
public Query hasEdgeLabel(Collection<String> edgeLabels)
```
    Description copied from interface: Query
    
    Adds a edge label filter to the query.
    
    Specified by:
    
    hasEdgeLabel in interface Query
    
    Parameters:
    
    edgeLabels - The edge labels to filter on.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasInVertexTypes
```
public Query hasInVertexTypes(String... vertexTypes)
```
  - hasOutVertexTypes
```
public Query hasOutVertexTypes(String... vertexTypes)
```
  - hasAuthorization
```
public Query hasAuthorization(String... authorizations)
```
    Description copied from interface: Query
    
    Adds an authorization filter to the query.
    
    Specified by:
    
    hasAuthorization in interface 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
```
public Query hasAuthorization(Iterable<String> authorizations)
```
    Description copied from interface: Query
    
    Adds an authorization filter to the query.
    
    Specified by:
    
    hasAuthorization in interface 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
```
public Query hasExtendedData(ElementType elementType,
                             String elementId)
```
    Description copied from interface: Query
    
    Adds a extended data element filter to the query. This will query any table.
    
    Specified by:
    
    hasExtendedData in interface Query
    
    Parameters:
    
    elementType - The type of element.
    
    elementId - The element id
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasExtendedData
```
public Query hasExtendedData(String tableName)
```
    Description copied from interface: Query
    
    Adds a extended data table filter to the query.
    
    Specified by:
    
    hasExtendedData in interface Query
    
    Parameters:
    
    tableName - The table name
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasExtendedData
```
public Query hasExtendedData(ElementType elementType,
                             String elementId,
                             String tableName)
```
    Description copied from interface: Query
    
    Adds a extended data element filter to the query. This will limit the search to the supplied extended data records.
    
    Specified by:
    
    hasExtendedData in interface Query
    
    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
```
public Query hasExtendedData(Iterable<HasExtendedDataFilter> filters)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    hasExtendedData in interface Query
    
    Parameters:
    
    filters - The list of filters to be or'ed together.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - edges
```
@Deprecated
public QueryResultsIterable<Edge> edges(String label,
                                                    FetchHints fetchHints)
```
    Deprecated.
    
    Specified by:
    
    edges in interface Query
  - edges
```
@Deprecated
public QueryResultsIterable<Edge> edges(String label)
```
    Deprecated.
    
    Specified by:
    
    edges in interface Query
  - elements
```
public QueryResultsIterable<Element> elements()
```
    Specified by:
    
    elements in interface Query
  - elements
```
public QueryResultsIterable<Element> elements(FetchHints fetchHints)
```
    Specified by:
    
    elements in interface Query
  - elementIds
```
public QueryResultsIterable<String> elementIds()
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    elementIds in interface Query
    
    Returns:
    
    The ids of elements that match this query.
  - elementIds
```
public QueryResultsIterable<String> elementIds(EnumSet<IdFetchHint> idFetchHints)
```
    Description copied from interface: Query
    
    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.
    
    Specified by:
    
    elementIds in interface Query
    
    Returns:
    
    The ids of elements that match this query.
  - range
```
public <T extends Value> Query range(String propertyName,
                                     T startValue,
                                     T endValue)
```
    Description copied from interface: Query
    
    Queries for properties in the given range.
    
    Specified by:
    
    range in interface Query
    
    Parameters:
    
    propertyName - Name of property.
    
    startValue - Inclusive start value.
    
    endValue - Inclusive end value.
    
    Returns:
    
    this
  - range
```
public <T extends Value> Query range(String propertyName,
                                     T startValue,
                                     boolean inclusiveStartValue,
                                     T endValue,
                                     boolean inclusiveEndValue)
```
    Description copied from interface: Query
    
    Queries for properties in the given range.
    
    Specified by:
    
    range in interface Query
    
    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
  - sort
```
public Query sort(String propertyName,
                  SortDirection direction)
```
    Description copied from interface: Query
    
    Sort the results by the given property name.
    
    Specified by:
    
    sort in interface Query
    
    Parameters:
    
    propertyName - The property to sort by.
    
    direction - The direction to sort.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - sort
```
public Query sort(SortingStrategy sortingStrategy,
                  SortDirection direction)
```
    Description copied from interface: Query
    
    Sort the results by the given SortingStrategy.
    
    Specified by:
    
    sort in interface Query
    
    Parameters:
    
    sortingStrategy - The SortingStrategy to sort by.
    
    direction - The direction to sort.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
public <T extends Value> Query has(String propertyName,
                                   T value)
```
    Description copied from interface: Query
    
    Adds an Compare.EQUAL filter to the query.
    
    Specified by:
    
    has in interface 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
```
public <T extends Value> Query hasNot(String propertyName,
                                      T value)
```
    Description copied from interface: Query
    
    Adds an Contains.NOT_IN filter to the query.
    
    Specified by:
    
    hasNot in interface 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
```
public <T extends Value> Query has(String propertyName,
                                   Predicate predicate,
                                   T value)
```
    Description copied from interface: Query
    
    Adds a filter to the query.
    
    Specified by:
    
    has in interface 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
```
public <T extends Value> Query has(String propertyName,
                                   Predicate predicate,
                                   Conjunction conjunction,
                                   T value)
```
    Description copied from interface: Query
    
    Adds a filter to the query.
    
    Specified by:
    
    has in interface 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
```
public <T extends Value,K extends Value> Query has(Class<T> dataType,
                                                   Predicate predicate,
                                                   K value)
```
    Description copied from interface: Query
    
    Adds a filter to the query.
    
    Specified by:
    
    has in interface 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
```
public <T extends Value> Query has(Class<T> dataType)
```
    Description copied from interface: Query
    
    Adds a has filter to the query.
    
    Specified by:
    
    has in interface 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
```
public <T extends Value> Query hasNot(Class<T> dataType)
```
    Description copied from interface: Query
    
    Adds a hasNot filter to the query.
    
    Specified by:
    
    hasNot in interface 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.
  - has
```
public <T extends Value> Query has(Iterable<String> propertyNames,
                                   Predicate predicate,
                                   T value)
```
    Description copied from interface: Query
    
    Adds a filter to the query.
    
    Specified by:
    
    has in interface 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
```
public Query has(String propertyName)
```
    Description copied from interface: Query
    
    Adds a has filter to the query.
    
    Specified by:
    
    has in interface Query
    
    Parameters:
    
    propertyName - The name of the property the element must contain.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - has
```
public <T> Query has(Iterable<String> propertyNames)
```
    Description copied from interface: Query
    
    Adds a filter to the query.
    
    Specified by:
    
    has in interface Query
    
    Parameters:
    
    propertyNames - A document will match if it contains any properties specified.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasNot
```
public Query hasNot(String propertyName)
```
    Description copied from interface: Query
    
    Adds a hasNot filter to the query.
    
    Specified by:
    
    hasNot in interface Query
    
    Parameters:
    
    propertyName - The name of the property the element must not contain.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - hasNot
```
public <T> Query hasNot(Iterable<String> propertyNames)
```
    Description copied from interface: Query
    
    Adds a filter to the query.
    
    Specified by:
    
    hasNot in interface Query
    
    Parameters:
    
    propertyNames - A document will match if it does not contain any properties specified.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - skip
```
public Query skip(int count)
```
    Description copied from interface: Query
    
    Skips the given number of items.
    
    Specified by:
    
    skip in interface Query
  - limit
```
public Query limit(Integer count)
```
    Description copied from interface: Query
    
    Limits the number of items returned. null will return all elements.
    
    Specified by:
    
    limit in interface Query
  - limit
```
public Query limit(Long count)
```
    Description copied from interface: Query
    
    Limits the number of items returned. null will return all elements.
    
    Specified by:
    
    limit in interface Query
  - minScore
```
public Query minScore(double score)
```
    Description copied from interface: Query
    
    Minimum score to return
    
    Specified by:
    
    minScore in interface Query
  - scoringStrategy
```
public Query scoringStrategy(ScoringStrategy scoringStrategy)
```
    Description copied from interface: Query
    
    Sets the scoring strategy for this query
    
    Specified by:
    
    scoringStrategy in interface Query
  - getGraph
```
public Graph getGraph()
```
  - getParameters
```
public QueryParameters getParameters()
```
  - minTermFrequency
```
public SimilarToGraphQuery minTermFrequency(int minTermFrequency)
```
    Description copied from interface: SimilarToGraphQuery
    
    The minimum number of times a term must appear in the source data to be considered for a match.
    
    Specified by:
    
    minTermFrequency in interface SimilarToGraphQuery
  - maxQueryTerms
```
public SimilarToGraphQuery maxQueryTerms(int maxQueryTerms)
```
    Description copied from interface: SimilarToGraphQuery
    
    The maximum number of terms to be searched for.
    
    Specified by:
    
    maxQueryTerms in interface SimilarToGraphQuery
  - minDocFrequency
```
public SimilarToGraphQuery minDocFrequency(int minDocFrequency)
```
    Description copied from interface: SimilarToGraphQuery
    
    The minimum number of documents a term must be in to be considered for a similarity match.
    
    Specified by:
    
    minDocFrequency in interface SimilarToGraphQuery
  - maxDocFrequency
```
public SimilarToGraphQuery maxDocFrequency(int maxDocFrequency)
```
    Description copied from interface: SimilarToGraphQuery
    
    The maximum number of documents a term can be in to be considered for a similarity match.
    
    Specified by:
    
    maxDocFrequency in interface SimilarToGraphQuery
  - boost
```
public SimilarToGraphQuery boost(float boost)
```
    Description copied from interface: SimilarToGraphQuery
    
    The amount of boost to apply to the similarity query.
    
    Specified by:
    
    boost in interface SimilarToGraphQuery
  - isAggregationSupported
```
public boolean isAggregationSupported(Aggregation aggregation)
```
    Description copied from interface: Query
    
    Test to see if aggregation is supported.
    
    Specified by:
    
    isAggregationSupported in interface Query
    
    Parameters:
    
    aggregation - the aggregation to test.
    
    Returns:
    
    true, if the aggregation is supported
  - addAggregation
```
public Query addAggregation(Aggregation aggregation)
```
    Description copied from interface: Query
    
    Add an aggregation to the query
    
    Specified by:
    
    addAggregation in interface Query
    
    Parameters:
    
    aggregation - the aggregation to add.
    
    Returns:
    
    The query object, allowing you to chain methods.
  - getAggregations
```
public Collection<Aggregation> getAggregations()
```
    Description copied from interface: Query
    
    Gets the added aggregations
    
    Specified by:
    
    getAggregations in interface Query
  - getAggregationByName
```
public Aggregation getAggregationByName(String aggregationName)
```
  - idFetchHintsToElementFetchHints
```
protected FetchHints idFetchHintsToElementFetchHints(EnumSet<IdFetchHint> idFetchHints)
```
  - setShard
```
public Query setShard(String shardId)
```
    Specified by:
    
    setShard in interface Query
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class QueryBase

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryBase

QueryBase

QueryBase

Method Detail

getLogicalQuery

setLogicalQuery

vertices

vertices

vertexIds

vertexIds

edges

edges

edgeIds

edgeIds

extendedDataRows

extendedDataRows

extendedDataRowIds

extendedDataRowIds

search

search

extendedData

extendedData

hasId

hasId

hasConceptType

hasConceptType

hasEdgeLabel

hasEdgeLabel

hasInVertexTypes

hasOutVertexTypes

hasAuthorization

hasAuthorization

hasExtendedData

hasExtendedData

hasExtendedData

hasExtendedData

edges

edges

elements

elements

elementIds

elementIds

range

range

sort

sort

has

hasNot

has

has

has

has

hasNot

has

has

has

hasNot

hasNot

skip

limit

limit

minScore

scoringStrategy

getGraph

getParameters

minTermFrequency

maxQueryTerms

minDocFrequency

maxDocFrequency

boost

isAggregationSupported

addAggregation

getAggregations

getAggregationByName