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.
|
Modifier and Type | Method | Description |
---|---|---|
QueryBatcher |
DataMovementManager.newQueryBatcher(StructuredQueryDefinition query) |
Create a new QueryBatcher instance configured to retrieve uris that
match this query.
|
Modifier and Type | Method | Description |
---|---|---|
SearchCollector.CollectorResults |
SearchCollector.collect(StructuredQueryDefinition def,
long start) |
Modifier and Type | Method | 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(java.lang.String... uris) |
Copied directly from
StructuredQuerybuilder.collection(String...) . |
StructuredQueryDefinition |
PojoQueryBuilder.containerQuery(java.lang.String pojoProperty,
StructuredQueryDefinition query) |
|
StructuredQueryDefinition |
PojoQueryBuilder.geospatial(StructuredQueryBuilder.GeospatialIndex index,
StructuredQueryBuilder.Region... regions) |
|
StructuredQueryDefinition |
PojoQueryBuilder.geospatial(StructuredQueryBuilder.GeospatialIndex index,
java.lang.String[] options,
StructuredQueryBuilder.Region... regions) |
Copied from
StructuredQuerybuilder.geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) but without StructuredQueryBuilder.FragmentScope. |
StructuredQueryDefinition |
PojoQueryBuilder.near(int distance,
double weight,
StructuredQueryBuilder.Ordering order,
StructuredQueryDefinition... queries) |
|
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(java.lang.String pojoProperty,
PojoQueryBuilder.Operator operator,
java.lang.Object... values) |
Query a Path Range Index configured in the database for a pojo property.
|
StructuredQueryDefinition |
PojoQueryBuilder.range(java.lang.String pojoProperty,
java.lang.String[] options,
PojoQueryBuilder.Operator operator,
java.lang.Object... values) |
Query a Path Range Index configured in the database for a pojo property.
|
StructuredQueryDefinition |
PojoQueryBuilder.term(double weight,
java.lang.String... terms) |
Copied directly from
StructuredQuerybuilder.term(double, String...) . |
StructuredQueryDefinition |
PojoQueryBuilder.term(java.lang.String... terms) |
Copied directly from
StructuredQuerybuilder.term(String...) . |
StructuredQueryDefinition |
PojoQueryBuilder.value(java.lang.String pojoProperty,
java.lang.Boolean value) |
Filter search results by properties matching specified value.
|
StructuredQueryDefinition |
PojoQueryBuilder.value(java.lang.String pojoProperty,
java.lang.Number... values) |
Filter search results by properties matching specified values.
|
StructuredQueryDefinition |
PojoQueryBuilder.value(java.lang.String pojoProperty,
java.lang.String... values) |
Filter search results by properties matching specified values.
|
StructuredQueryDefinition |
PojoQueryBuilder.value(java.lang.String pojoProperty,
java.lang.String[] options,
double weight,
java.lang.Boolean value) |
Filter search results by properties matching specified values.
|
StructuredQueryDefinition |
PojoQueryBuilder.value(java.lang.String pojoProperty,
java.lang.String[] options,
double weight,
java.lang.Number... values) |
Filter search results by properties matching specified values.
|
StructuredQueryDefinition |
PojoQueryBuilder.value(java.lang.String pojoProperty,
java.lang.String[] options,
double weight,
java.lang.String... values) |
Filter search results by properties matching specified values.
|
StructuredQueryDefinition |
PojoQueryBuilder.word(java.lang.String pojoProperty,
java.lang.String... words) |
Filter search results by properties with at least one of the specified words or phrases.
|
StructuredQueryDefinition |
PojoQueryBuilder.word(java.lang.String pojoProperty,
java.lang.String[] options,
double weight,
java.lang.String... words) |
Filter search results by properties with at least one of the specified words or phrases.
|
Modifier and Type | Interface | 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.
|
Modifier and Type | Method | Description |
---|---|---|
StructuredQueryDefinition |
StructuredQueryBuilder.afterQuery(long timestamp) |
Matches documents with timestamp after the given timestamp.
|
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.beforeQuery(long timestamp) |
Matches documents with timestamp prior to the given timestamp.
|
StructuredQueryDefinition |
StructuredQueryBuilder.boost(StructuredQueryDefinition matchingQuery,
StructuredQueryDefinition boostingQuery) |
Defines a boost query for the matching and boosting query definitions.
|
StructuredQueryDefinition |
StructuredQueryBuilder.collectionConstraint(java.lang.String constraintName,
java.lang.String... uris) |
Matches documents belonging to at least one
of the criteria collections with the specified constraint.
|
StructuredQueryDefinition |
StructuredQueryBuilder.containerConstraint(java.lang.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,
java.lang.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,
java.lang.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(java.lang.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 maximumDistance,
double weight,
StructuredQueryBuilder.Ordering order,
StructuredQueryDefinition... queries) |
Defines a NEAR query over the list of query definitions
with specified parameters.
|
StructuredQueryDefinition |
StructuredQueryBuilder.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 |
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(java.lang.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,
java.lang.String type,
StructuredQueryBuilder.Operator operator,
java.lang.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,
java.lang.String type,
java.lang.String[] options,
StructuredQueryBuilder.Operator operator,
java.lang.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,
java.lang.String type,
java.lang.String collation,
StructuredQueryBuilder.FragmentScope scope,
StructuredQueryBuilder.Operator operator,
java.lang.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,
java.lang.String type,
java.lang.String collation,
StructuredQueryBuilder.FragmentScope scope,
java.lang.String[] options,
StructuredQueryBuilder.Operator operator,
java.lang.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,
java.lang.String type,
java.lang.String collation,
StructuredQueryBuilder.Operator operator,
java.lang.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,
java.lang.String type,
java.lang.String collation,
java.lang.String[] options,
StructuredQueryBuilder.Operator operator,
java.lang.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(java.lang.String constraintName,
StructuredQueryBuilder.Operator operator,
java.lang.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(java.lang.String temporalCollection,
java.lang.String timestamp,
double weight,
java.lang.String... options) |
Matches documents with LSQT prior to timestamp
|
StructuredQueryDefinition |
StructuredQueryBuilder.temporalLsqtQuery(java.lang.String temporalCollection,
java.util.Calendar time,
double weight,
java.lang.String... options) |
Matches documents with LSQT prior to timestamp
|
StructuredQueryDefinition |
StructuredQueryBuilder.temporalPeriodCompare(StructuredQueryBuilder.Axis axis1,
StructuredQueryBuilder.TemporalOperator operator,
StructuredQueryBuilder.Axis axis2,
java.lang.String... options) |
Matches documents that have a relevant pair of period values.
|
StructuredQueryDefinition |
StructuredQueryBuilder.temporalPeriodRange(StructuredQueryBuilder.Axis[] axes,
StructuredQueryBuilder.TemporalOperator operator,
StructuredQueryBuilder.Period[] periods,
java.lang.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,
java.lang.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,
java.lang.String... terms) |
Matches documents containing the specified terms, modifying
the contribution of the match to the score with the weight.
|
StructuredQueryDefinition |
StructuredQueryBuilder.term(java.lang.String... terms) |
Matches documents containing the specified terms.
|
StructuredQueryDefinition |
StructuredQueryBuilder.value(StructuredQueryBuilder.TextIndex index,
StructuredQueryBuilder.FragmentScope scope,
java.lang.String[] options,
double weight,
java.lang.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,
java.lang.String[] options,
double weight,
java.lang.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,
java.lang.String[] options,
double weight,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.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(java.lang.String constraintName,
double weight,
java.lang.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(java.lang.String constraintName,
java.lang.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(java.lang.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,
StructuredQueryBuilder.FragmentScope scope,
java.lang.String[] options,
double weight,
java.lang.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,
java.lang.String... words) |
Matches an element, attribute, JSON property, or field
that has at least one of the criteria words.
|
StructuredQueryDefinition |
StructuredQueryBuilder.wordConstraint(java.lang.String constraintName,
double weight,
java.lang.String... words) |
Matches the container specified by the constraint when it
has at least one of the criteria words.
|
StructuredQueryDefinition |
StructuredQueryBuilder.wordConstraint(java.lang.String constraintName,
java.lang.String... words) |
Matches the container specified by the constraint when it
has at least one of the criteria words.
|
Modifier and Type | Method | 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(java.lang.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).
|
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 maximumDistance,
double weight,
StructuredQueryBuilder.Ordering order,
StructuredQueryDefinition... queries) |
Defines a NEAR query over the list of query definitions
with specified parameters.
|
StructuredQueryDefinition |
StructuredQueryBuilder.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 |
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(java.lang.String constraintName,
StructuredQueryDefinition query) |
Associates a query with the properties of documents (as opposed to
the content of documents) with the specified constraint.
|
Constructor | Description |
---|---|
AndNotQuery(StructuredQueryDefinition positive,
StructuredQueryDefinition negative) |
|
AndQuery(StructuredQueryDefinition... queries) |
|
DocumentFragmentQuery(StructuredQueryDefinition query) |
|
LocksQuery(StructuredQueryDefinition query) |
|
NearQuery(StructuredQueryDefinition... queries) |
|
NearQuery(java.lang.Integer minimumDistance,
java.lang.Integer maximumDistance,
java.lang.Double weight,
StructuredQueryBuilder.Ordering order,
StructuredQueryDefinition... queries) |
|
NotQuery(StructuredQueryDefinition query) |
|
OrQuery(StructuredQueryDefinition... queries) |
|
PropertiesConstraintQuery(java.lang.String constraintName,
StructuredQueryDefinition query) |
|
PropertiesQuery(StructuredQueryDefinition query) |
Copyright © 2013-2019 MarkLogic Corporation.