Uses of Interface
com.marklogic.client.query.StructuredQueryDefinition

Packages that use StructuredQueryDefinition

Package	Description
com.marklogic.client.datamovement	The MarkLogic Data Movement SDK supports long-running write, read, delete, or transform jobs.
com.marklogic.client.example.extension	The package provides examples of extensions that operate on a batch of database documents.
com.marklogic.client.pojo	The goal of this package (sometimes referred to as “the pojo facade” is to simplify working with custom Plain Old Java Objects (pojos) without hassling with persistence details.
com.marklogic.client.query	The package provides classes for queries including searching documents and reading values directly from indexes in the database for the REST server.

Uses of StructuredQueryDefinition in com.marklogic.client.datamovement

Methods in com.marklogic.client.datamovement with parameters of type StructuredQueryDefinition

Modifier and Type	Method and Description
QueryBatcher	DataMovementManager.newQueryBatcher(StructuredQueryDefinition query) Create a new QueryBatcher instance configured to retrieve uris that match this query.

Uses of StructuredQueryDefinition in com.marklogic.client.example.extension

Methods in com.marklogic.client.example.extension with parameters of type StructuredQueryDefinition

Modifier and Type	Method and Description
SearchCollector.CollectorResults	SearchCollector.collect(StructuredQueryDefinition def, long start)

Uses of StructuredQueryDefinition in com.marklogic.client.pojo

Methods in com.marklogic.client.pojo that return StructuredQueryDefinition

Modifier and Type	Method and Description
StructuredQueryDefinition	PojoQueryBuilder.and(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	PojoQueryBuilder.andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Copied directly from StructuredQuerybuilder.andNot.
StructuredQueryDefinition	PojoQueryBuilder.boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery) Copied directly from StructuredQuerybuilder.boost.
StructuredQueryDefinition	PojoQueryBuilder.collection(String... uris) Copied directly from StructuredQuerybuilder.collection(String...).
StructuredQueryDefinition	PojoQueryBuilder.containerQuery(String pojoProperty, StructuredQueryDefinition query)
StructuredQueryDefinition	PojoQueryBuilder.geospatial(StructuredQueryBuilder.GeospatialIndex index, String[] options, StructuredQueryBuilder.Region... regions) Copied from StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) but without StructuredQueryBuilder.FragmentScope.
StructuredQueryDefinition	PojoQueryBuilder.geospatial(StructuredQueryBuilder.GeospatialIndex index, StructuredQueryBuilder.Region... regions) Copied directly from StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...).
StructuredQueryDefinition	PojoQueryBuilder.near(int distance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...).
StructuredQueryDefinition	PojoQueryBuilder.near(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.near(StructuredQueryDefinition...).
StructuredQueryDefinition	PojoQueryBuilder.not(StructuredQueryDefinition query) Copied directly from StructuredQuerybuilder.not.
StructuredQueryDefinition	PojoQueryBuilder.notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	PojoQueryBuilder.or(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	PojoQueryBuilder.range(String pojoProperty, PojoQueryBuilder.Operator operator, Object... values) Query a Path Range Index configured in the database for a pojo property.
StructuredQueryDefinition	PojoQueryBuilder.range(String pojoProperty, String[] options, PojoQueryBuilder.Operator operator, Object... values) Query a Path Range Index configured in the database for a pojo property.
StructuredQueryDefinition	PojoQueryBuilder.term(double weight, String... terms) Copied directly from StructuredQuerybuilder.term(double, String...).
StructuredQueryDefinition	PojoQueryBuilder.term(String... terms) Copied directly from StructuredQuerybuilder.term(String...).
StructuredQueryDefinition	PojoQueryBuilder.value(String pojoProperty, Boolean value) Filter search results by properties matching specified value.
StructuredQueryDefinition	PojoQueryBuilder.value(String pojoProperty, Number... values) Filter search results by properties matching specified values.
StructuredQueryDefinition	PojoQueryBuilder.value(String pojoProperty, String... values) Filter search results by properties matching specified values.
StructuredQueryDefinition	PojoQueryBuilder.value(String pojoProperty, String[] options, double weight, Boolean value) Filter search results by properties matching specified values.
StructuredQueryDefinition	PojoQueryBuilder.value(String pojoProperty, String[] options, double weight, Number... values) Filter search results by properties matching specified values.
StructuredQueryDefinition	PojoQueryBuilder.value(String pojoProperty, String[] options, double weight, String... values) Filter search results by properties matching specified values.
StructuredQueryDefinition	PojoQueryBuilder.word(String pojoProperty, String... words) Filter search results by properties with at least one of the specified words or phrases.
StructuredQueryDefinition	PojoQueryBuilder.word(String pojoProperty, String[] options, double weight, String... words) Filter search results by properties with at least one of the specified words or phrases.

Methods in com.marklogic.client.pojo with parameters of type StructuredQueryDefinition

Modifier and Type	Method and Description
StructuredQueryDefinition	PojoQueryBuilder.and(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	PojoQueryBuilder.andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Copied directly from StructuredQuerybuilder.andNot.
StructuredQueryDefinition	PojoQueryBuilder.boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery) Copied directly from StructuredQuerybuilder.boost.
RawStructuredQueryDefinition	PojoQueryBuilder.build(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.build.
StructuredQueryDefinition	PojoQueryBuilder.containerQuery(String pojoProperty, StructuredQueryDefinition query)
PojoQueryDefinition	PojoQueryBuilder.filteredQuery(StructuredQueryDefinition query) Wraps the structured query into a combined query with options containing <search-option>filtered</search-option> so results are accurate though slower.
StructuredQueryDefinition	PojoQueryBuilder.near(int distance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...).
StructuredQueryDefinition	PojoQueryBuilder.near(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.near(StructuredQueryDefinition...).
StructuredQueryDefinition	PojoQueryBuilder.not(StructuredQueryDefinition query) Copied directly from StructuredQuerybuilder.not.
StructuredQueryDefinition	PojoQueryBuilder.notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Copied directly from StructuredQuerybuilder.and.
StructuredQueryDefinition	PojoQueryBuilder.or(StructuredQueryDefinition... queries) Copied directly from StructuredQuerybuilder.and.

Uses of StructuredQueryDefinition in com.marklogic.client.query

Subinterfaces of StructuredQueryDefinition in com.marklogic.client.query

Modifier and Type	Interface and Description
static interface	StructuredQueryBuilder.Box
static interface	StructuredQueryBuilder.Circle
static interface	StructuredQueryBuilder.Point
static interface	StructuredQueryBuilder.Polygon
static interface	StructuredQueryBuilder.Region A region matched by a geospatial query.

Methods in com.marklogic.client.query that return StructuredQueryDefinition

Modifier and Type	Method and Description
StructuredQueryDefinition	StructuredQueryBuilder.and(StructuredQueryDefinition... queries) Defines an AND query over the list of query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Defines an AND NOT query combining a positive and negative query.
StructuredQueryDefinition	StructuredQueryBuilder.boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery) Defines a boost query for the matching and boosting query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.collectionConstraint(String constraintName, String... uris) Matches documents belonging to at least one of the criteria collections with the specified constraint.
StructuredQueryDefinition	StructuredQueryBuilder.containerConstraint(String constraintName, StructuredQueryDefinition query) Matches a query within the substructure of the container specified by the constraint.
StructuredQueryDefinition	StructuredQueryBuilder.containerQuery(StructuredQueryBuilder.ContainerIndex index, StructuredQueryDefinition query) Matches a query within the substructure contained by an element or JSON property.
StructuredQueryDefinition	StructuredQueryBuilder.documentFragment(StructuredQueryDefinition query) Associates a query with the content of documents (as opposed to the properties of documents).
StructuredQueryDefinition	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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.
StructuredQueryDefinition	StructuredQueryBuilder.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.
StructuredQueryDefinition	StructuredQueryBuilder.near(int distance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries) Defines a NEAR query over the list of query definitions with specified parameters.
StructuredQueryDefinition	StructuredQueryBuilder.near(StructuredQueryDefinition... queries) Defines a NEAR query over the list of query definitions with default parameters.
StructuredQueryDefinition	StructuredQueryBuilder.not(StructuredQueryDefinition query) Defines a NOT query for a query definition.
StructuredQueryDefinition	StructuredQueryBuilder.notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Defines a not-in query for the positive and negative query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.or(StructuredQueryDefinition... queries) Defines an OR query over the list of query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.properties(StructuredQueryDefinition query) Associates a query with the properties of documents (as opposed to the content of documents).
StructuredQueryDefinition	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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.
StructuredQueryDefinition	StructuredQueryBuilder.temporalLsqtQuery(String temporalCollection, Calendar time, double weight, String... options) Matches documents with LSQT prior to timestamp
StructuredQueryDefinition	StructuredQueryBuilder.temporalLsqtQuery(String temporalCollection, String timestamp, double weight, String... options) Matches documents with LSQT prior to timestamp
StructuredQueryDefinition	StructuredQueryBuilder.temporalPeriodCompare(StructuredQueryBuilder.Axis axis1, StructuredQueryBuilder.TemporalOperator operator, StructuredQueryBuilder.Axis axis2, String... options) Matches documents that have a relevant pair of period values.
StructuredQueryDefinition	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.term(double weight, String... terms) Matches documents containing the specified terms, modifying the contribution of the match to the score with the weight.
StructuredQueryDefinition	StructuredQueryBuilder.term(String... terms) Matches documents containing the specified terms.
StructuredQueryDefinition	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryDefinition.withCriteria(String criteria) Sets the query criteria as a query string and returns the query definition as a fluent convenience.
StructuredQueryDefinition	StructuredQueryBuilder.word(StructuredQueryBuilder.TextIndex index, String... words) Matches an element, attribute, JSON property, or field that has at least one of the criteria words.
StructuredQueryDefinition	StructuredQueryBuilder.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	StructuredQueryBuilder.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	StructuredQueryBuilder.wordConstraint(String constraintName, String... words) Matches the container specified by the constraint when it has at least one of the criteria words.

Methods in com.marklogic.client.query with parameters of type StructuredQueryDefinition

Modifier and Type	Method and Description
StructuredQueryDefinition	StructuredQueryBuilder.and(StructuredQueryDefinition... queries) Defines an AND query over the list of query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.andNot(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Defines an AND NOT query combining a positive and negative query.
StructuredQueryDefinition	StructuredQueryBuilder.boost(StructuredQueryDefinition matchingQuery, StructuredQueryDefinition boostingQuery) Defines a boost query for the matching and boosting query definitions.
RawStructuredQueryDefinition	StructuredQueryBuilder.build(StructuredQueryDefinition... queries) Builds a structured query in XML from the list of query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.containerConstraint(String constraintName, StructuredQueryDefinition query) Matches a query within the substructure of the container specified by the constraint.
StructuredQueryDefinition	StructuredQueryBuilder.containerQuery(StructuredQueryBuilder.ContainerIndex index, StructuredQueryDefinition query) Matches a query within the substructure contained by an element or JSON property.
StructuredQueryDefinition	StructuredQueryBuilder.documentFragment(StructuredQueryDefinition query) Associates a query with the content of documents (as opposed to the properties of documents).
com.marklogic.client.query.StructuredQueryBuilder.LocksQuery	StructuredQueryBuilder.locks(StructuredQueryDefinition query) Associates a query with durable locks on documents (as opposed to the content or properties of documents).
StructuredQueryDefinition	StructuredQueryBuilder.near(int distance, double weight, StructuredQueryBuilder.Ordering order, StructuredQueryDefinition... queries) Defines a NEAR query over the list of query definitions with specified parameters.
StructuredQueryDefinition	StructuredQueryBuilder.near(StructuredQueryDefinition... queries) Defines a NEAR query over the list of query definitions with default parameters.
StructuredQueryDefinition	StructuredQueryBuilder.not(StructuredQueryDefinition query) Defines a NOT query for a query definition.
StructuredQueryDefinition	StructuredQueryBuilder.notIn(StructuredQueryDefinition positive, StructuredQueryDefinition negative) Defines a not-in query for the positive and negative query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.or(StructuredQueryDefinition... queries) Defines an OR query over the list of query definitions.
StructuredQueryDefinition	StructuredQueryBuilder.properties(StructuredQueryDefinition query) Associates a query with the properties of documents (as opposed to the content of documents).
StructuredQueryDefinition	StructuredQueryBuilder.propertiesConstraint(String constraintName, StructuredQueryDefinition query) Associates a query with the properties of documents (as opposed to the content of documents) with the specified constraint.