StructuredQueryBuilder (MarkLogic Java Client API 8.1.0)

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

SEARCH:

java.lang.Object

com.marklogic.client.query.StructuredQueryBuilder

public class StructuredQueryBuilder extends Object

StructuredQueryBuilder builds a query for documents in the database.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected class

StructuredQueryBuilder.AbstractStructuredQuery

protected class

StructuredQueryBuilder.AndNotQuery

protected class

StructuredQueryBuilder.AndQuery

static interface

StructuredQueryBuilder.Attribute

An Attribute represents an attribute in database documents.

protected class

StructuredQueryBuilder.AttributeImpl

static interface

StructuredQueryBuilder.Axis

An axis for use in temporalPeriodRange or temporalPeriodCompare queries.

static interface

StructuredQueryBuilder.Box

protected class

StructuredQueryBuilder.BoxImpl

static interface

StructuredQueryBuilder.Circle

protected class

StructuredQueryBuilder.CircleImpl

protected class

StructuredQueryBuilder.CollectionConstraintQuery

protected class

StructuredQueryBuilder.CollectionQuery

static interface

StructuredQueryBuilder.ContainerIndex

A ContainerIndex can be used for container queries.

protected class

StructuredQueryBuilder.ContainerQuery

static final class

StructuredQueryBuilder.CoordinateSystem

CoordinateSystem provides a list of all known coordinate systems and it also provides a capability to add new CoordinateSystems in the future

protected class

StructuredQueryBuilder.CustomConstraintQuery

protected class

StructuredQueryBuilder.DirectoryQuery

protected class

StructuredQueryBuilder.DocumentFragmentQuery

protected class

StructuredQueryBuilder.DocumentQuery

static interface

StructuredQueryBuilder.Element

An Element represents an element in database documents.

static interface

StructuredQueryBuilder.ElementAttribute

An ElementAttribute represents an attribute on an element in database documents.

protected class

StructuredQueryBuilder.ElementAttributeImpl

protected class

StructuredQueryBuilder.ElementImpl

protected class

StructuredQueryBuilder.FalseQuery

static interface

StructuredQueryBuilder.Field

A Field represents a field defined in the database configuration.

protected class

StructuredQueryBuilder.FieldImpl

static enum

StructuredQueryBuilder.FragmentScope

Whether a query should search the document or its associated properties.

protected class

StructuredQueryBuilder.GeoAttributePairImpl

protected class

StructuredQueryBuilder.GeoElementImpl

protected class

StructuredQueryBuilder.GeoElementPairImpl

protected class

StructuredQueryBuilder.GeoJSONPropertyImpl

protected class

StructuredQueryBuilder.GeoJSONPropertyPairImpl

protected class

StructuredQueryBuilder.GeospatialConstraintQuery

static interface

StructuredQueryBuilder.GeospatialIndex

A GeospatialIndex can be used for geospatial queries.

static enum

StructuredQueryBuilder.GeospatialOperator

Geospatial operators to be used in geospatial region index queries

protected class

StructuredQueryBuilder.GeospatialPointQuery

protected class

StructuredQueryBuilder.GeospatialRegionConstraintQuery

static interface

StructuredQueryBuilder.GeospatialRegionIndex

A GeospatialRangeIndex can be used for geospatial region index queries.

protected class

StructuredQueryBuilder.GeospatialRegionQuery

protected class

StructuredQueryBuilder.IndexImpl

static interface

StructuredQueryBuilder.JSONProperty

A JSONProperty represents a key in JSON database documents.

protected class

StructuredQueryBuilder.JSONPropertyImpl

protected class

StructuredQueryBuilder.LocksQuery

protected class

StructuredQueryBuilder.NearQuery

protected class

StructuredQueryBuilder.NotQuery

static enum

StructuredQueryBuilder.Operator

A comparison operator for use in range queries.

protected class

StructuredQueryBuilder.OperatorState

static enum

StructuredQueryBuilder.Ordering

Control over ordering for use in near queries.

protected class

StructuredQueryBuilder.OrQuery

static interface

StructuredQueryBuilder.PathIndex

A PathIndex represents an index defined with an XPath in the database configuration.

protected class

StructuredQueryBuilder.PathIndexImpl

static interface

StructuredQueryBuilder.Period

A temporal period for use in temporalPeriodRange queries.

static interface

StructuredQueryBuilder.Point

protected class

StructuredQueryBuilder.PointImpl

static interface

StructuredQueryBuilder.Polygon

protected class

StructuredQueryBuilder.PolygonImpl

protected class

StructuredQueryBuilder.PropertiesConstraintQuery

protected class

StructuredQueryBuilder.PropertiesQuery

protected class

StructuredQueryBuilder.RangeConstraintQuery

static interface

StructuredQueryBuilder.RangeIndex

A RangeIndex can be used for range queries.

protected class

StructuredQueryBuilder.RangeQuery

static interface

StructuredQueryBuilder.Region

A region matched by a geospatial query.

protected class

StructuredQueryBuilder.RegionImpl

protected class

StructuredQueryBuilder.TemporalAxis

protected class

StructuredQueryBuilder.TemporalLsqtQuery

static enum

StructuredQueryBuilder.TemporalOperator

The Allen and ISO SQL 2011 temporal operators available for use in temporalPeriodRange or temporalPeriodCompare queries.

protected class

StructuredQueryBuilder.TemporalPeriod

protected class

StructuredQueryBuilder.TemporalPeriodCompareQuery

protected class

StructuredQueryBuilder.TemporalPeriodRangeQuery

protected class

StructuredQueryBuilder.TermQuery

static interface

StructuredQueryBuilder.TextIndex

A TextIndex can be used for word and value queries.

protected class

StructuredQueryBuilder.TimeQuery

protected class

StructuredQueryBuilder.TrueQuery

protected class

StructuredQueryBuilder.ValueConstraintQuery

protected class

StructuredQueryBuilder.ValueQuery

protected class

StructuredQueryBuilder.WordConstraintQuery

protected class

StructuredQueryBuilder.WordQuery
Field Summary

Fields

Modifier and Type

Field

Description

static final String

SEARCH_API_NS
Constructor Summary

Constructors

Constructor

Description

StructuredQueryBuilder()

Zero-argument constructor.

StructuredQueryBuilder(IterableNamespaceContext namespaces)

Constructs a query builder for queries using the specified namespace bindings.

StructuredQueryBuilder(String optionsName)

Constructs a query builder for queries against the options persisted with the specified name.

StructuredQueryBuilder(String optionsName, IterableNamespaceContext namespaces)

Constructs a query builder for queries against the options persisted with the specified name using the specified namespace bindings.
Method Summary

Modifier and Type

Method

Description

StructuredQueryDefinition

afterQuery(long timestamp)

Matches documents with timestamp after the given timestamp.

StructuredQueryDefinition

and(StructuredQueryDefinition... queries)

Defines an AND query over the list of query definitions.

StructuredQueryDefinition

andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative)

Defines an AND NOT query combining a positive and negative query.

StructuredQueryBuilder.Attribute

attribute(String name)

Identifies a simple attribute to match with a query.

StructuredQueryBuilder.Attribute

attribute(QName qname)

Identifies a namespaced attribute to match with a query.

StructuredQueryBuilder.Axis

axis(String name)

Identify an axis for use in temporalPeriodRange or temporalPeriodCompare queries.

StructuredQueryDefinition

beforeQuery(long timestamp)

Matches documents with timestamp prior to the given timestamp.

StructuredQueryDefinition

boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery)

Defines a boost query for the matching and boosting query definitions.

StructuredQueryBuilder.Box

box(double south, double west, double north, double east)

Specifies a geospatial region as a box, supplying the coordinates for the perimeter.

RawStructuredQueryDefinition

build(StructuredQueryDefinition... queries)

Builds a structured query in XML from the list of query definitions.

StructuredQueryBuilder.Circle

circle(double latitude, double longitude, double radius)

Specifies a geospatial region as a circle, supplying coordinates for the center.

StructuredQueryBuilder.Circle

circle(StructuredQueryBuilder.Point center, double radius)

Specifies a geospatial region as a circle, supplying a point for the center.

StructuredQueryDefinition

collection(String... uris)

Matches documents belonging to at least one of the criteria collections.

StructuredQueryDefinition

collectionConstraint(String constraintName, String... uris)

Matches documents belonging to at least one of the criteria collections with the specified constraint.

StructuredQueryDefinition

containerConstraint(String constraintName, StructuredQueryDefinition query)

Matches a query within the substructure of the container specified by the constraint.

StructuredQueryDefinition

containerQuery(StructuredQueryBuilder.ContainerIndex index, StructuredQueryDefinition query)

Matches a query within the substructure contained by an element or JSON property.

StructuredQueryDefinition

customConstraint(String constraintName, String... text)

Matches documents as specified by a constraint that implements a custom query parameterized with the supplied text.

StructuredQueryDefinition

directory(boolean isInfinite, String... uris)

Matches documents at the specified depth within at least one of the criteria directories.

StructuredQueryDefinition

document(String... uris)

Matches the specified documents.

StructuredQueryDefinition

documentFragment(StructuredQueryDefinition query)

Associates a query with the content of documents (as opposed to the properties of documents).

StructuredQueryBuilder.Element

element(String name)

Identifies a simple element to match with a query.

StructuredQueryBuilder.Element

element(QName qname)

Identifies a namespaced element to match with a query.

StructuredQueryBuilder.ElementAttribute

elementAttribute(StructuredQueryBuilder.Element element, StructuredQueryBuilder.Attribute attribute)

Identifies an element having an attribute to match with a query.

StructuredQueryDefinition

falseQuery()

Defines a "true" query that selects all documents.

StructuredQueryBuilder.Field

field(String name)

Identifies a field to match with a query.

StructuredQueryBuilder.GeospatialIndex

geoAttributePair(StructuredQueryBuilder.Element parent, StructuredQueryBuilder.Attribute lat, StructuredQueryBuilder.Attribute lon)

Identifies a parent element with child latitude and longitude attributes to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoElement(StructuredQueryBuilder.Element element)

Identifies an element whose text has the latitude and longitude coordinates to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoElement(StructuredQueryBuilder.Element parent, StructuredQueryBuilder.Element element)

Identifies a parent element with a child element whose text has the latitude and longitude coordinates to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoElementPair(StructuredQueryBuilder.Element parent, StructuredQueryBuilder.Element lat, StructuredQueryBuilder.Element lon)

Identifies a parent element with child latitude and longitude elements to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoJSONProperty(StructuredQueryBuilder.JSONProperty jsonProperty)

Identifies a json property whose text has the point format latitude and longitude coordinates to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoJSONProperty(StructuredQueryBuilder.JSONProperty parent, StructuredQueryBuilder.JSONProperty jsonProperty)

Identifies a parent json property with a child json property whose text has the latitude and longitude coordinates to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoJSONPropertyPair(StructuredQueryBuilder.JSONProperty parent, StructuredQueryBuilder.JSONProperty lat, StructuredQueryBuilder.JSONProperty lon)

Identifies a parent json property with child latitude and longitude json properties to match with a geospatial query.

StructuredQueryBuilder.GeospatialIndex

geoPath(StructuredQueryBuilder.PathIndex pathIndex)

Identifies a path with the latitude and longitude to match with a geospatial query.

StructuredQueryBuilder.GeospatialRegionIndex

geoRegionPath(StructuredQueryBuilder.PathIndex pathIndex)

Identifies a path with regions to match with a geospatial query.

StructuredQueryBuilder.GeospatialRegionIndex

geoRegionPath(StructuredQueryBuilder.PathIndex pathIndex, StructuredQueryBuilder.CoordinateSystem coordinateSystem)

Identifies a path with regions to match with a geospatial query.

StructuredQueryDefinition

geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, StructuredQueryBuilder.Region... regions)

Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.

StructuredQueryDefinition

geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, Double weight, StructuredQueryBuilder.Region... regions)

Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.

StructuredQueryDefinition

geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.Region... regions)

Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.

StructuredQueryDefinition

geospatial(StructuredQueryBuilder.GeospatialRegionIndex index, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.FragmentScope scope, String[] options, StructuredQueryBuilder.Region... regions)

Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.

StructuredQueryDefinition

geospatial(StructuredQueryBuilder.GeospatialRegionIndex index, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.FragmentScope scope, String[] options, Double weight, StructuredQueryBuilder.Region... regions)

Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.

StructuredQueryDefinition

geospatial(StructuredQueryBuilder.GeospatialRegionIndex index, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.Region... regions)

Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.

StructuredQueryBuilder.GeospatialConstraintQuery

geospatialConstraint(String constraintName, StructuredQueryBuilder.Region... regions)

Matches the container specified by the constraint whose geospatial point appears within one of the criteria regions.

StructuredQueryDefinition

geospatialRegionConstraint(String constraintName, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.Region... regions)

Matches the container specified by the constraint whose geospatial region appears within one of the criteria regions.

IterableNamespaceContext

getNamespaces()

Gets the namespace bindings used for the query.

StructuredQueryBuilder.JSONProperty

jsonProperty(String name)

Identifies a JSON property to match with a query.

StructuredQueryDefinition

locks(StructuredQueryDefinition query)

Associates a query with durable locks on documents (as opposed to the content or properties of documents).

StructuredQueryDefinition

near(int maximumDistance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries)

Defines a NEAR query over the list of query definitions with specified parameters.

StructuredQueryDefinition

near(int minimumDistance, int maximumDistance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries)

Defines a NEAR query over the list of query definitions with specified parameters.

StructuredQueryDefinition

near(StructuredQueryDefinition... queries)

Defines a NEAR query over the list of query definitions with default parameters.

StructuredQueryDefinition

not(StructuredQueryDefinition query)

Defines a NOT query for a query definition.

StructuredQueryDefinition

notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative)

Defines a not-in query for the positive and negative query definitions.

StructuredQueryDefinition

operatorState(String operatorName, String stateName)

Define a new operator state; see https://docs.marklogic.com/guide/search-dev/structured-query#id_45570 for more information.

StructuredQueryDefinition

or(StructuredQueryDefinition... queries)

Defines an OR query over the list of query definitions.

StructuredQueryBuilder.PathIndex

pathIndex(String path)

Identifies a path index to match with a query.

StructuredQueryBuilder.Period

period(String start, String end)

Construct a temporal period for use in temporalPeriodRange queries.

StructuredQueryBuilder.Period

period(Calendar start, Calendar end)

Construct a temporal period for use in temporalPeriodRange queries.

StructuredQueryBuilder.Point

point(double latitude, double longitude)

Specifies a geospatial point.

StructuredQueryBuilder.Polygon

polygon(StructuredQueryBuilder.Point... points)

Specifies a geospatial region as an arbitrary polygon.

StructuredQueryDefinition

properties(StructuredQueryDefinition query)

Associates a query with the properties of documents (as opposed to the content of documents).

StructuredQueryDefinition

propertiesConstraint(String constraintName, StructuredQueryDefinition query)

Associates a query with the properties of documents (as opposed to the content of documents) with the specified constraint.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String[] options, double weight, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String[] options, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.FragmentScope scope, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.FragmentScope scope, String[] options, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String collation, String[] options, double weight, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

range(StructuredQueryBuilder.RangeIndex index, String type, String collation, String[] options, StructuredQueryBuilder.Operator operator, Object... values)

Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.

StructuredQueryDefinition

rangeConstraint(String constraintName, StructuredQueryBuilder.Operator operator, String... values)

Matches the container specified by the constraint whose value that has the correct datatyped comparison with one of the criteria values.

String[]

rangeOptions(String... options)

Converts the list of options used for a range query to an array as a convenience.

void

setNamespaces(IterableNamespaceContext namespaces)

Specifies the namespace bindings used for the query.

StructuredQueryDefinition

temporalLsqtQuery(String temporalCollection, String timestamp, double weight, String... options)

Matches documents with LSQT prior to timestamp

StructuredQueryDefinition

temporalLsqtQuery(String temporalCollection, Calendar time, double weight, String... options)

Matches documents with LSQT prior to timestamp

StructuredQueryDefinition

temporalPeriodCompare(StructuredQueryBuilder.Axis axis1, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Axis axis2, String... options)

Matches documents that have a relevant pair of period values.

StructuredQueryDefinition

temporalPeriodRange(StructuredQueryBuilder.Axis[] axes, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Period[] periods, String... options)

Matches documents that have a value in the specified axis that matches the specified periods using the specified operator.

StructuredQueryDefinition

temporalPeriodRange(StructuredQueryBuilder.Axis axis, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Period period, String... options)

Matches documents that have a value in the specified axis that matches the specified period using the specified operator.

StructuredQueryDefinition

term(double weight, String... terms)

Matches documents containing the specified terms, modifying the contribution of the match to the score with the weight.

StructuredQueryDefinition

term(String... terms)

Matches documents containing the specified terms.

StructuredQueryDefinition

trueQuery()

Defines a "true" query that selects all documents.

StructuredQueryDefinition

value(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, Boolean value)

Matches a JSON property that has a value with the same boolean value as at least one of the criteria values.

StructuredQueryDefinition

value(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, Number... values)

Matches a JSON property that has a value with the same numeric value as at least one of the criteria values.

StructuredQueryDefinition

value(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, String... values)

Matches an element, attribute, JSON property, or field that has a value with the same string value as at least one of the criteria values.

StructuredQueryDefinition

value(StructuredQueryBuilder.TextIndex index, Boolean value)

Matches a JSON property that has a value with the same boolean value as at least one of the criteria values.

StructuredQueryDefinition

value(StructuredQueryBuilder.TextIndex index, Number... values)

Matches an JSON property that has a value with the same numeric value as at least one of the criteria values.

StructuredQueryDefinition

value(StructuredQueryBuilder.TextIndex index, String... values)

Matches an element, attribute, JSON property, or field that has a value with the same string value as at least one of the criteria values.

StructuredQueryDefinition

valueConstraint(String constraintName, double weight, String... values)

Matches the container specified by the constraint when it has a value with the same string value as at least one of the criteria values.

StructuredQueryDefinition

valueConstraint(String constraintName, String... values)

Matches the container specified by the constraint when it has a value with the same string value as at least one of the criteria values.

StructuredQueryDefinition

word(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, String... words)

Matches an element, attribute, JSON property, or field that has at least one of the criteria words.

StructuredQueryDefinition

word(StructuredQueryBuilder.TextIndex index, String... words)

Matches an element, attribute, JSON property, or field that has at least one of the criteria words.

StructuredQueryDefinition

wordConstraint(String constraintName, double weight, String... words)

Matches the container specified by the constraint when it has at least one of the criteria words.

StructuredQueryDefinition

wordConstraint(String constraintName, String... words)

Matches the container specified by the constraint when it has at least one of the criteria words.

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

Field Details
- SEARCH_API_NS
  
  public static final String SEARCH_API_NS
  See Also:
  - Constant Field Values
Constructor Details
- StructuredQueryBuilder
  
  public StructuredQueryBuilder()
  
  Zero-argument constructor.
- StructuredQueryBuilder
  
  public StructuredQueryBuilder(String optionsName)
  
  Constructs a query builder for queries against the options persisted with the specified name. The query can include constraint queries for any constraints defined by the options.
  
  Parameters:
  
  optionsName - the name of the persisted query options
- StructuredQueryBuilder
  
  public StructuredQueryBuilder(IterableNamespaceContext namespaces)
  
  Constructs a query builder for queries using the specified namespace bindings.
  
  Parameters:
  
  namespaces - the bindings of prefixes and namespaces
- StructuredQueryBuilder
  
  public StructuredQueryBuilder(String optionsName, IterableNamespaceContext namespaces)
  
  Constructs a query builder for queries against the options persisted with the specified name using the specified namespace bindings. The query can include constraint queries for any constraints defined by the options.
  
  Parameters:
  
  optionsName - the name of the persisted query options
  
  namespaces - the bindings of prefixes and namespaces
Method Details
- build
  
  public RawStructuredQueryDefinition build(StructuredQueryDefinition... queries)
  
  Builds a structured query in XML from the list of query definitions. The structured query can be passed to the search() method of QueryManager.
  
  Parameters:
  
  queries - the query definitions
  
  Returns:
  
  the structured query
- and
  
  public StructuredQueryDefinition and(StructuredQueryDefinition... queries)
  
  Defines an AND query over the list of query definitions.
  
  Parameters:
  
  queries - the query definitions
  
  Returns:
  
  the StructuredQueryDefinition for the AND query
- or
  
  public StructuredQueryDefinition or(StructuredQueryDefinition... queries)
  
  Defines an OR query over the list of query definitions.
  
  Parameters:
  
  queries - the query definitions
  
  Returns:
  
  the StructuredQueryDefinition for the OR query
- not
  
  public StructuredQueryDefinition not(StructuredQueryDefinition query)
  
  Defines a NOT query for a query definition. To negate a list of query definitions, define an AND or OR query over the list and define the NOT query over the AND or OR query.
  
  Parameters:
  
  query - the query definition
  
  Returns:
  
  the StructuredQueryDefinition for the NOT query
- andNot
  
  public StructuredQueryDefinition andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative)
  
  Defines an AND NOT query combining a positive and negative query. You can use an AND or OR query over a list of query definitions as the positive or negative query.
  
  Parameters:
  
  positive - the positive query definition
  
  negative - the negative query definition
  
  Returns:
  
  the StructuredQueryDefinition for the AND NOT query
- trueQuery
  
  public StructuredQueryDefinition trueQuery()
  
  Defines a "true" query that selects all documents.
  
  Returns:
  
  the StructuredQueryDefinition for the "true" query.
  
  Since:
  
  7.1.0
- falseQuery
  
  public StructuredQueryDefinition falseQuery()
  
  Defines a "true" query that selects all documents.
  
  Returns:
  
  the StructuredQueryDefinition for the "true" query.
  
  Since:
  
  7.1.0
- operatorState
  
  public StructuredQueryDefinition operatorState(String operatorName, String stateName)
  
  Define a new operator state; see https://docs.marklogic.com/guide/search-dev/structured-query#id_45570 for more information.
  
  Parameters:
  
  operatorName - The name of a custom runtime configuration operator defined by the query option.
  
  stateName - The name of a state recognized by this operator.
  
  Returns:
  
  the StructuredQueryDefinition for the operator state.
  
  Since:
  
  7.1.0
- near
  
  public StructuredQueryDefinition near(StructuredQueryDefinition... queries)
  
  Defines a NEAR query over the list of query definitions with default parameters.
  
  Parameters:
  
  queries - the query definitions
  
  Returns:
  
  the StructuredQueryDefinition for the NEAR query
- near
  
  public StructuredQueryDefinition near(int maximumDistance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries)
  
  Defines a NEAR query over the list of query definitions with specified parameters.
  
  Parameters:
  
  maximumDistance - the maximum distance (in number of words) between any two matching queries
  
  weight - the weight for the query
  
  order - the ordering for the query terms
  
  queries - the query definitions
  
  Returns:
  
  the StructuredQueryDefinition for the NEAR query
- near
  
  public StructuredQueryDefinition near(int minimumDistance, int maximumDistance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries)
  
  Defines a NEAR query over the list of query definitions with specified parameters.
  
  Parameters:
  
  minimumDistance - the minimum distance (in number of words) between any two matching queries
  
  maximumDistance - the maximum distance (in number of words) between any two matching queries
  
  weight - the weight for the query
  
  order - the ordering for the query terms
  
  queries - the query definitions
  
  Returns:
  
  the StructuredQueryDefinition for the NEAR query
- documentFragment
  
  public StructuredQueryDefinition documentFragment(StructuredQueryDefinition query)
  
  Associates a query with the content of documents (as opposed to the properties of documents).
  
  Parameters:
  
  query - the query definition
  
  Returns:
  
  the StructuredQueryDefinition for the document fragment query
- properties
  
  public StructuredQueryDefinition properties(StructuredQueryDefinition query)
  
  Associates a query with the properties of documents (as opposed to the content of documents).
  
  Parameters:
  
  query - the query definition
  
  Returns:
  
  the StructuredQueryDefinition for the properties query
- locks
  
  public StructuredQueryDefinition locks(StructuredQueryDefinition query)
  
  Associates a query with durable locks on documents (as opposed to the content or properties of documents). Such lock fragments are created with xdmp:lock-acquire().
  
  Parameters:
  
  query - the query definition
  
  Returns:
  
  the StructuredQueryDefinition for the locks query
- containerQuery
  
  public StructuredQueryDefinition containerQuery(StructuredQueryBuilder.ContainerIndex index, StructuredQueryDefinition query)
  
  Matches a query within the substructure contained by an element or JSON property.
  
  Parameters:
  
  index - the element or JSON property
  
  query - the query over the contained substructure
  
  Returns:
  
  the StructuredQueryDefinition for the container query
- collection
  
  public StructuredQueryDefinition collection(String... uris)
  
  Matches documents belonging to at least one of the criteria collections.
  
  Parameters:
  
  uris - the identifiers for the criteria collections
  
  Returns:
  
  the StructuredQueryDefinition for the collection query
- directory
  
  public StructuredQueryDefinition directory(boolean isInfinite, String... uris)
  
  Matches documents at the specified depth within at least one of the criteria directories.
  
  Parameters:
  
  isInfinite - true to match a document at any level of depth
  
  uris - the identifiers for the criteria directories
  
  Returns:
  
  the StructuredQueryDefinition for the directory query
- document
  
  public StructuredQueryDefinition document(String... uris)
  
  Matches the specified documents.
  
  Parameters:
  
  uris - the identifiers for the documents
  
  Returns:
  
  the StructuredQueryDefinition for the document query
- term
  
  public StructuredQueryDefinition term(String... terms)
  
  Matches documents containing the specified terms.
  
  Parameters:
  
  terms - the possible terms to match
  
  Returns:
  
  the StructuredQueryDefinition for the term query
- term
  
  public StructuredQueryDefinition term(double weight, String... terms)
  
  Matches documents containing the specified terms, modifying the contribution of the match to the score with the weight.
  
  Parameters:
  
  weight - the multiplier for the match in the document ranking
  
  terms - the possible terms to match
  
  Returns:
  
  the StructuredQueryDefinition for the term query
- value
  
  public StructuredQueryDefinition value(StructuredQueryBuilder.TextIndex index, String... values)
  
  Matches an element, attribute, JSON property, or field that has a value with the same string value as at least one of the criteria values.
  
  Parameters:
  
  index - the value container
  
  values - the possible values to match
  
  Returns:
  
  the StructuredQueryDefinition for the value query
- value
  
  public StructuredQueryDefinition value(StructuredQueryBuilder.TextIndex index, Boolean value)
  
  Matches a JSON property that has a value with the same boolean value as at least one of the criteria values. Note this method will not match any XML node.
  
  Parameters:
  
  index - the value container
  
  value - either true or false
  
  Returns:
  
  the StructuredQueryDefinition for the value query
- value
  
  public StructuredQueryDefinition value(StructuredQueryBuilder.TextIndex index, Number... values)
  
  Matches an JSON property that has a value with the same numeric value as at least one of the criteria values. Note this method will not match any XML node.
  
  Parameters:
  
  index - the value container
  
  values - the possible values to match
  
  Returns:
  
  the StructuredQueryDefinition for the value query
- value
  
  public StructuredQueryDefinition value(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, String... values)
  
  Matches an element, attribute, JSON property, or field that has a value with the same string value as at least one of the criteria values.
  
  Parameters:
  
  index - the value container
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  values - the possible values to match
  
  Returns:
  
  the StructuredQueryDefinition for the value query
- value
  
  public StructuredQueryDefinition value(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, Boolean value)
  
  Matches a JSON property that has a value with the same boolean value as at least one of the criteria values. Note this method will not match any XML node.
  
  Parameters:
  
  index - the value container
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  value - either true or false
  
  Returns:
  
  the StructuredQueryDefinition for the value query
- value
  
  public StructuredQueryDefinition value(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, Number... values)
  
  Matches a JSON property that has a value with the same numeric value as at least one of the criteria values. Note this method will not match any XML node.
  
  Parameters:
  
  index - the value container
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  values - the possible values to match
  
  Returns:
  
  the StructuredQueryDefinition for the value query
- word
  
  public StructuredQueryDefinition word(StructuredQueryBuilder.TextIndex index, String... words)
  
  Matches an element, attribute, JSON property, or field that has at least one of the criteria words.
  
  Parameters:
  
  index - the word container
  
  words - the possible words to match
  
  Returns:
  
  the StructuredQueryDefinition for the word query
- word
  
  public StructuredQueryDefinition word(StructuredQueryBuilder.TextIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, String... words)
  
  Matches an element, attribute, JSON property, or field that has at least one of the criteria words.
  
  Parameters:
  
  index - the word container
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  words - the possible words to match
  
  Returns:
  
  the StructuredQueryDefinition for the word query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  collation - the identifier for the strategy for comparing types
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.FragmentScope scope, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  collation - the identifier for the strategy for comparing types
  
  scope - whether the query matches the document content or properties
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String[] options, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  options - options for fine tuning the query
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String[] options, double weight, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String collation, String[] options, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  collation - the identifier for the strategy for comparing types
  
  options - options for fine tuning the query
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String collation, String[] options, double weight, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  collation - the identifier for the strategy for comparing types
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.FragmentScope scope, String[] options, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  collation - the identifier for the strategy for comparing types
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- range
  
  public StructuredQueryDefinition range(StructuredQueryBuilder.RangeIndex index, String type, String collation, StructuredQueryBuilder.FragmentScope scope, String[] options, double weight, StructuredQueryBuilder.Operator operator, Object... values)
  
  Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  index - the range container
  
  type - the datatype of the container and specified values
  
  collation - the identifier for the strategy for comparing types
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range query
- geospatial
  
  public StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.Region... regions)
  
  Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.
  
  Parameters:
  
  index - the container for the coordinates of the geospatial point
  
  regions - the possible regions containing the point
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial query
- geospatial
  
  public StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, StructuredQueryBuilder.Region... regions)
  
  Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.
  
  Parameters:
  
  index - the container for the coordinates of the geospatial point
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  regions - the possible regions containing the point
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial query
- geospatial
  
  public StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.FragmentScope scope, String[] options, Double weight, StructuredQueryBuilder.Region... regions)
  
  Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.
  
  Parameters:
  
  index - the container for the coordinates of the geospatial point
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  regions - the possible regions containing the point
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial query
- geospatial
  
  public StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialRegionIndex index, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.Region... regions)
  
  Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.
  
  Parameters:
  
  index - the container for the geospatial regions
  
  operator - the geospatial operator to be applied with the regions in the index and the specified regions
  
  regions - the possible regions containing the region
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial query
- geospatial
  
  public StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialRegionIndex index, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.FragmentScope scope, String[] options, StructuredQueryBuilder.Region... regions)
  
  Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.
  
  Parameters:
  
  index - the container for the geospatial regions
  
  operator - the geospatial operator to be applied with the regions in the index and the specified regions
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  regions - the possible regions containing the region
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial query
- geospatial
  
  public StructuredQueryDefinition geospatial(StructuredQueryBuilder.GeospatialRegionIndex index, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.FragmentScope scope, String[] options, Double weight, StructuredQueryBuilder.Region... regions)
  
  Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.
  
  Parameters:
  
  index - the container for the geospatial regions
  
  operator - the geospatial operator to be applied with the regions in the index and the specified regions
  
  scope - whether the query matches the document content or properties
  
  options - options for fine tuning the query
  
  weight - the multiplier for the match in the document ranking
  
  regions - the possible regions containing the region
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial query
- element
  
  public StructuredQueryBuilder.Element element(QName qname)
  
  Identifies a namespaced element to match with a query.
  
  Parameters:
  
  qname - the name of the element
  
  Returns:
  
  the element identifier
- element
  
  public StructuredQueryBuilder.Element element(String name)
  
  Identifies a simple element to match with a query.
  
  Parameters:
  
  name - the name of the element
  
  Returns:
  
  the element identifier
- attribute
  
  public StructuredQueryBuilder.Attribute attribute(QName qname)
  
  Identifies a namespaced attribute to match with a query.
  
  Parameters:
  
  qname - the name of the attribute
  
  Returns:
  
  the attribute identifier
- attribute
  
  public StructuredQueryBuilder.Attribute attribute(String name)
  
  Identifies a simple attribute to match with a query.
  
  Parameters:
  
  name - the name of the attribute
  
  Returns:
  
  the attribute identifier
- elementAttribute
  
  public StructuredQueryBuilder.ElementAttribute elementAttribute(StructuredQueryBuilder.Element element, StructuredQueryBuilder.Attribute attribute)
  
  Identifies an element having an attribute to match with a query.
  
  Parameters:
  
  element - the element identifier
  
  attribute - the attribute identifier
  
  Returns:
  
  the identifier for the element-attribute pair
- field
  
  public StructuredQueryBuilder.Field field(String name)
  
  Identifies a field to match with a query. Fields are defined in the configuration for the database.
  
  Parameters:
  
  name - the name of the field
  
  Returns:
  
  the identifier for the field
- jsonProperty
  
  public StructuredQueryBuilder.JSONProperty jsonProperty(String name)
  
  Identifies a JSON property to match with a query.
  
  Parameters:
  
  name - the name of the JSON property
  
  Returns:
  
  the identifier for the JSON property
- pathIndex
  
  public StructuredQueryBuilder.PathIndex pathIndex(String path)
  
  Identifies a path index to match with a query.
  
  Parameters:
  
  path - the indexed path
  
  Returns:
  
  the identifier for the path index
- geoJSONProperty
  
  public StructuredQueryBuilder.GeospatialIndex geoJSONProperty(StructuredQueryBuilder.JSONProperty jsonProperty)
  
  Identifies a json property whose text has the point format latitude and longitude coordinates to match with a geospatial query.
  
  Parameters:
  
  jsonProperty - the json property containing the geospatial coordinates
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoJSONProperty
  
  public StructuredQueryBuilder.GeospatialIndex geoJSONProperty(StructuredQueryBuilder.JSONProperty parent, StructuredQueryBuilder.JSONProperty jsonProperty)
  
  Identifies a parent json property with a child json property whose text has the latitude and longitude coordinates to match with a geospatial query.
  
  Parameters:
  
  parent - the parent of the json property with the coordinates
  
  jsonProperty - the json property containing the geospatial coordinates
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoJSONPropertyPair
  
  public StructuredQueryBuilder.GeospatialIndex geoJSONPropertyPair(StructuredQueryBuilder.JSONProperty parent, StructuredQueryBuilder.JSONProperty lat, StructuredQueryBuilder.JSONProperty lon)
  
  Identifies a parent json property with child latitude and longitude json properties to match with a geospatial query.
  
  Parameters:
  
  parent - the parent json property of lat and lon
  
  lat - the json property with the latitude coordinate
  
  lon - the json property with the longitude coordinate
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoElement
  
  public StructuredQueryBuilder.GeospatialIndex geoElement(StructuredQueryBuilder.Element element)
  
  Identifies an element whose text has the latitude and longitude coordinates to match with a geospatial query.
  
  Parameters:
  
  element - the element containing the geospatial coordinates
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoElement
  
  public StructuredQueryBuilder.GeospatialIndex geoElement(StructuredQueryBuilder.Element parent, StructuredQueryBuilder.Element element)
  
  Identifies a parent element with a child element whose text has the latitude and longitude coordinates to match with a geospatial query.
  
  Parameters:
  
  parent - the parent of the element with the coordinates
  
  element - the element containing the geospatial coordinates
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoElementPair
  
  public StructuredQueryBuilder.GeospatialIndex geoElementPair(StructuredQueryBuilder.Element parent, StructuredQueryBuilder.Element lat, StructuredQueryBuilder.Element lon)
  
  Identifies a parent element with child latitude and longitude elements to match with a geospatial query.
  
  Parameters:
  
  parent - the parent of the element with the coordinates
  
  lat - the element with the latitude coordinate
  
  lon - the element with the longitude coordinate
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoAttributePair
  
  public StructuredQueryBuilder.GeospatialIndex geoAttributePair(StructuredQueryBuilder.Element parent, StructuredQueryBuilder.Attribute lat, StructuredQueryBuilder.Attribute lon)
  
  Identifies a parent element with child latitude and longitude attributes to match with a geospatial query.
  
  Parameters:
  
  parent - the parent of the element with the coordinates
  
  lat - the attribute with the latitude coordinate
  
  lon - the attribute with the longitude coordinate
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoPath
  
  public StructuredQueryBuilder.GeospatialIndex geoPath(StructuredQueryBuilder.PathIndex pathIndex)
  
  Identifies a path with the latitude and longitude to match with a geospatial query.
  
  Parameters:
  
  pathIndex - the indexed path
  
  Returns:
  
  the specification for the index on the geospatial coordinates
- geoRegionPath
  
  public StructuredQueryBuilder.GeospatialRegionIndex geoRegionPath(StructuredQueryBuilder.PathIndex pathIndex)
  
  Identifies a path with regions to match with a geospatial query.
  
  Parameters:
  
  pathIndex - the indexed path
  
  Returns:
  
  the specification for the index on the geospatial region
- geoRegionPath
  
  public StructuredQueryBuilder.GeospatialRegionIndex geoRegionPath(StructuredQueryBuilder.PathIndex pathIndex, StructuredQueryBuilder.CoordinateSystem coordinateSystem)
  
  Identifies a path with regions to match with a geospatial query.
  
  Parameters:
  
  pathIndex - the indexed path
  
  coordinateSystem - the coordinate system used along with precision info used for the index
  
  Returns:
  
  the specification for the index on the geospatial region
- point
  
  public StructuredQueryBuilder.Point point(double latitude, double longitude)
  
  Specifies a geospatial point.
  
  Parameters:
  
  latitude - the latitude coordinate
  
  longitude - the longitude coordinate
  
  Returns:
  
  the definition of the point
- circle
  
  public StructuredQueryBuilder.Circle circle(double latitude, double longitude, double radius)
  
  Specifies a geospatial region as a circle, supplying coordinates for the center.
  
  Parameters:
  
  latitude - the latitude coordinate of the center
  
  longitude - the longitude coordinate of the center
  
  radius - the radius of the circle
  
  Returns:
  
  the definition of the circle
- circle
  
  public StructuredQueryBuilder.Circle circle(StructuredQueryBuilder.Point center, double radius)
  
  Specifies a geospatial region as a circle, supplying a point for the center.
  
  Parameters:
  
  center - the point defining the center
  
  radius - the radius of the circle
  
  Returns:
  
  the definition of the circle
- box
  
  public StructuredQueryBuilder.Box box(double south, double west, double north, double east)
  
  Specifies a geospatial region as a box, supplying the coordinates for the perimeter.
  
  Parameters:
  
  south - the latitude of the south coordinate
  
  west - the longitude of the west coordinate
  
  north - the latitude of the north coordinate
  
  east - the longitude of the east coordinate
  
  Returns:
  
  the definition of the box
- polygon
  
  public StructuredQueryBuilder.Polygon polygon(StructuredQueryBuilder.Point... points)
  
  Specifies a geospatial region as an arbitrary polygon.
  
  Parameters:
  
  points - the list of points defining the perimeter of the region
  
  Returns:
  
  the definition of the polygon
- containerConstraint
  
  public StructuredQueryDefinition containerConstraint(String constraintName, StructuredQueryDefinition query)
  
  Matches a query within the substructure of the container specified by the constraint.
  
  Parameters:
  
  constraintName - the constraint definition
  
  query - the query definition
  
  Returns:
  
  the StructuredQueryDefinition for the element constraint query
- propertiesConstraint
  
  public StructuredQueryDefinition propertiesConstraint(String constraintName, StructuredQueryDefinition query)
  
  Associates a query with the properties of documents (as opposed to the content of documents) with the specified constraint.
  
  Parameters:
  
  constraintName - the constraint definition
  
  query - the query definition
  
  Returns:
  
  the StructuredQueryDefinition for the properties constraint query
- collectionConstraint
  
  public StructuredQueryDefinition collectionConstraint(String constraintName, String... uris)
  
  Matches documents belonging to at least one of the criteria collections with the specified constraint.
  
  Parameters:
  
  constraintName - the constraint definition
  
  uris - the identifiers for the criteria collections
  
  Returns:
  
  the StructuredQueryDefinition for the collection constraint query
- valueConstraint
  
  public StructuredQueryDefinition valueConstraint(String constraintName, String... values)
  
  Matches the container specified by the constraint when it has a value with the same string value as at least one of the criteria values.
  
  Parameters:
  
  constraintName - the constraint definition
  
  values - the possible values to match
  
  Returns:
  
  the StructuredQueryDefinition for the value constraint query
- valueConstraint
  
  public StructuredQueryDefinition valueConstraint(String constraintName, double weight, String... values)
  
  Matches the container specified by the constraint when it has a value with the same string value as at least one of the criteria values.
  
  Parameters:
  
  constraintName - the constraint definition
  
  weight - the multiplier for the match in the document ranking
  
  values - the possible values to match
  
  Returns:
  
  the StructuredQueryDefinition for the value constraint query
- wordConstraint
  
  public StructuredQueryDefinition wordConstraint(String constraintName, String... words)
  
  Matches the container specified by the constraint when it has at least one of the criteria words.
  
  Parameters:
  
  constraintName - the constraint definition
  
  words - the possible words to match
  
  Returns:
  
  the StructuredQueryDefinition for the word constraint query
- wordConstraint
  
  public StructuredQueryDefinition wordConstraint(String constraintName, double weight, String... words)
  
  Matches the container specified by the constraint when it has at least one of the criteria words.
  
  Parameters:
  
  constraintName - the constraint definition
  
  weight - the multiplier for the match in the document ranking
  
  words - the possible words to match
  
  Returns:
  
  the StructuredQueryDefinition for the word constraint query
- rangeConstraint
  
  public StructuredQueryDefinition rangeConstraint(String constraintName, StructuredQueryBuilder.Operator operator, String... values)
  
  Matches the container specified by the constraint whose value that has the correct datatyped comparison with one of the criteria values.
  
  Parameters:
  
  constraintName - the constraint definition
  
  operator - the comparison with the criteria values
  
  values - the possible datatyped values for the comparison
  
  Returns:
  
  the StructuredQueryDefinition for the range constraint query
- geospatialConstraint
  
  public StructuredQueryBuilder.GeospatialConstraintQuery geospatialConstraint(String constraintName, StructuredQueryBuilder.Region... regions)
  
  Matches the container specified by the constraint whose geospatial point appears within one of the criteria regions.
  
  Parameters:
  
  constraintName - the constraint definition
  
  regions - the possible regions containing the point
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial constraint query
- geospatialRegionConstraint
  
  public StructuredQueryDefinition geospatialRegionConstraint(String constraintName, StructuredQueryBuilder.GeospatialOperator operator, StructuredQueryBuilder.Region... regions)
  
  Matches the container specified by the constraint whose geospatial region appears within one of the criteria regions.
  
  Parameters:
  
  constraintName - the constraint definition
  
  operator - the geospatial operator to be applied with the regions in the index and the criteria regions
  
  regions - the possible regions containing the point
  
  Returns:
  
  the StructuredQueryDefinition for the geospatial constraint query
- customConstraint
  
  public StructuredQueryDefinition customConstraint(String constraintName, String... text)
  
  Matches documents as specified by a constraint that implements a custom query parameterized with the supplied text.
  
  Parameters:
  
  constraintName - the constraint definition
  
  text - the input to the custom query
  
  Returns:
  
  the StructuredQueryDefinition for the custom constraint query
- rangeOptions
  
  public String[] rangeOptions(String... options)
  
  Converts the list of options used for a range query to an array as a convenience.
  
  Parameters:
  
  options - the list of range query options
  
  Returns:
  
  the range query options as an array
- boost
  
  public StructuredQueryDefinition boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery)
  
  Defines a boost query for the matching and boosting query definitions. The matching or boosting query definitions can each be an AND or OR query definition for complex combinations of criteria.
  
  Parameters:
  
  matchingQuery - the query definition that filters documents
  
  boostingQuery - the query definition that increases the rank for some filtered documents
  
  Returns:
  
  the StructuredQueryDefinition for the boost query
- notIn
  
  public StructuredQueryDefinition notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative)
  
  Defines a not-in query for the positive and negative query definitions. These query definitions can each be an AND or OR query definition for complex combinations of criteria.
  
  Parameters:
  
  positive - the query definition that includes documents
  
  negative - the query definition that excludes documents
  
  Returns:
  
  the StructuredQueryDefinition for the not-in query
- getNamespaces
  
  public IterableNamespaceContext getNamespaces()
  
  Gets the namespace bindings used for the query.
  
  Returns:
  
  the namespace bindings
- setNamespaces
  
  public void setNamespaces(IterableNamespaceContext namespaces)
  
  Specifies the namespace bindings used for the query. You can use the EditableNamespaceContext class to instantiate a set of bindings between namespace prefixes and Uris.
  
  Parameters:
  
  namespaces - the namespace bindings
- axis
  
  public StructuredQueryBuilder.Axis axis(String name)
  
  Identify an axis for use in temporalPeriodRange or temporalPeriodCompare queries.
  
  Parameters:
  
  name - the name of the axis as configured in the server
  
  Returns:
  
  a temporal axis
- period
  
  public StructuredQueryBuilder.Period period(Calendar start, Calendar end)
  
  Construct a temporal period for use in temporalPeriodRange queries.
  
  Parameters:
  
  start - the start date/time for this period
  
  end - the end date/time for this period
  
  Returns:
  
  a temporal period
- period
  
  public StructuredQueryBuilder.Period period(String start, String end)
  
  Construct a temporal period for use in temporalPeriodRange queries.
  
  Parameters:
  
  start - the start date/time for this period, in ISO 8601 format
  
  end - the end date/time for this period, in ISO 8601 format
  
  Returns:
  
  a temporal period
- temporalPeriodRange
  
  public StructuredQueryDefinition temporalPeriodRange(StructuredQueryBuilder.Axis axis, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Period period, String... options)
  
  Matches documents that have a value in the specified axis that matches the specified period using the specified operator.
  Parameters:
  
  axis - the axis of document temporal values used to determine which documents have values that match this query
  
  operator - the operator used to determine if values in the axis match the specified period
  
  period - the period considered using the operator
  
  options - string options from the list for cts:period-range-query calls
  
  Returns:
  
  a query to filter by comparing a temporal axis to period values
  
  See Also:
  - cts:period-range-query
  - Structured Queries: period-range-query
- temporalPeriodRange
  
  public StructuredQueryDefinition temporalPeriodRange(StructuredQueryBuilder.Axis[] axes, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Period[] periods, String... options)
  
  Matches documents that have a value in the specified axis that matches the specified periods using the specified operator.
  Parameters:
  
  axes - the set of axes of document temporal values used to determine which documents have values that match this query
  
  operator - the operator used to determine if values in the axis match the specified period
  
  periods - the periods considered using the operator. When multiple periods are specified, the query matches if a value matches any period.
  
  options - string options from the list for cts:period-range-query calls
  
  Returns:
  
  a query to filter by comparing a temporal axis to period values
  
  See Also:
  - cts:period-range-query
  - Structured Queries: period-range-query
- temporalPeriodCompare
  
  public StructuredQueryDefinition temporalPeriodCompare(StructuredQueryBuilder.Axis axis1, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Axis axis2, String... options)
  
  Matches documents that have a relevant pair of period values. Values from axis1 must match values from axis2 using the specified operator.
  Parameters:
  
  axis1 - the first axis of document temporal values values that match this query
  
  operator - the operator used to determine if values in the axis match the specified period
  
  axis2 - the second axis of document temporal values
  
  options - string options from the list for cts:period-compare-query calls
  
  Returns:
  
  a query to filter by comparing temporal axes
  
  See Also:
  - cts:period-compare-query
  - Structured Queries: period-compare-query
- temporalLsqtQuery
  
  public StructuredQueryDefinition temporalLsqtQuery(String temporalCollection, Calendar time, double weight, String... options)
  
  Matches documents with LSQT prior to timestamp
  Parameters:
  
  temporalCollection - the temporal collection to query
  
  time - documents with lsqt equal to or prior to this timestamp will match
  
  weight - the weight for this query
  
  options - string options from the list for cts:lsqt-query calls
  
  Returns:
  
  a query to filter by lsqt
  
  See Also:
  - cts:lsqt-query
  - Structured Queries: lsqt-query
- temporalLsqtQuery
  
  public StructuredQueryDefinition temporalLsqtQuery(String temporalCollection, String timestamp, double weight, String... options)
  
  Matches documents with LSQT prior to timestamp
  Parameters:
  
  temporalCollection - the temporal collection to query
  
  timestamp - timestamp in ISO 8601 format - documents with lsqt equal to or prior to this timestamp will match
  
  weight - the weight for this query
  
  options - string options from the list for cts:lsqt-query calls
  
  Returns:
  
  a query to filter by lsqt
  
  See Also:
  - cts:lsqt-query
  - Structured Queries: lsqt-query
- beforeQuery
  
  public StructuredQueryDefinition beforeQuery(long timestamp)
  
  Matches documents with timestamp prior to the given timestamp.
  
  Parameters:
  
  timestamp - time in ISO 8601 format - documents with timestamp equal to or prior to this timestamp will match
  
  Returns:
  
  a query to filter.
- afterQuery
  
  public StructuredQueryDefinition afterQuery(long timestamp)
  
  Matches documents with timestamp after the given timestamp.
  
  Parameters:
  
  timestamp - time in ISO 8601 format - documents with timestamp after this time will match.
  
  Returns:
  
  a query to filter.

Class StructuredQueryBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

SEARCH_API_NS

Constructor Details

StructuredQueryBuilder

StructuredQueryBuilder

StructuredQueryBuilder

StructuredQueryBuilder

Method Details

build

and

or

not

andNot

trueQuery

falseQuery

operatorState

near

near

near

documentFragment

properties

locks

containerQuery

collection

directory

document

term

term

value

value

value

value

value

value

word

word

range

range

range

range

range

range

range

range

range

geospatial

geospatial

geospatial

geospatial

geospatial

geospatial

element

element

attribute

attribute

elementAttribute

field

jsonProperty

pathIndex

geoJSONProperty

geoJSONProperty

geoJSONPropertyPair

geoElement

geoElement

geoElementPair

geoAttributePair

geoPath

geoRegionPath

geoRegionPath

point

circle

circle

box

polygon