Package | Description |
---|---|
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 and Description |
---|---|
SearchCollector.CollectorResults |
SearchCollector.collect(StructuredQueryDefinition def,
long start) |
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)
|
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(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.
|
Modifier and Type | Class and Description |
---|---|
class |
StructuredQueryBuilder.AndNotQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of AndNotQuery. |
class |
StructuredQueryBuilder.AndQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of AndQuery. |
class |
StructuredQueryBuilder.CollectionConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of CollectionConstraintQuery. |
class |
StructuredQueryBuilder.CollectionQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of CollectionQuery. |
class |
StructuredQueryBuilder.CustomConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of CustomConstraintQuery. |
class |
StructuredQueryBuilder.DirectoryQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of DirectoryQuery. |
class |
StructuredQueryBuilder.DocumentFragmentQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of DocumentFragmentQuery. |
class |
StructuredQueryBuilder.DocumentQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of DocumentQuery. |
class |
StructuredQueryBuilder.ElementConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of ElementConstraintQuery. |
class |
StructuredQueryBuilder.GeospatialConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of GeospatialConstraintQuery. |
class |
StructuredQueryBuilder.LocksQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of LocksQuery. |
class |
StructuredQueryBuilder.NearQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of NearQuery. |
class |
StructuredQueryBuilder.NotQuery
Deprecated.
Use the
StructuredQueryDefinition interface as the type for instances of NotQuery. |
class |
StructuredQueryBuilder.OrQuery
Deprecated.
Use the
StructuredQueryDefinition interface as the type for instances of OrQuery. |
class |
StructuredQueryBuilder.PropertiesConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of PropertiesConstraintQuery. |
class |
StructuredQueryBuilder.PropertiesQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of PropertiesQuery. |
class |
StructuredQueryBuilder.RangeConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of RangeConstraintQuery. |
class |
StructuredQueryBuilder.TermQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of TermQuery. |
class |
StructuredQueryBuilder.ValueConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of ValueConstraintQuery. |
class |
StructuredQueryBuilder.WordConstraintQuery
Deprecated.
Use the
StructuredQueryDefinition interface
as the type for instances of WordConstraintQuery. |
Modifier and Type | Method and Description |
---|---|
StructuredQueryDefinition |
StructuredQueryBuilder.boost(StructuredQueryDefinition matchingQuery,
StructuredQueryDefinition boostingQuery)
Defines a boost query for the matching and boosting 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.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.notIn(StructuredQueryDefinition positive,
StructuredQueryDefinition negative)
Defines a not-in query for the positive and negative query definitions.
|
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.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.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.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.
|
Modifier and Type | Method and Description |
---|---|
StructuredQueryBuilder.AndQuery |
StructuredQueryBuilder.and(StructuredQueryDefinition... queries)
Defines an AND query over the list of query definitions.
|
StructuredQueryBuilder.AndNotQuery |
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.
|
StructuredQueryBuilder.DocumentFragmentQuery |
StructuredQueryBuilder.documentFragment(StructuredQueryDefinition query)
Associates a query with the content of documents (as opposed to
the properties of documents).
|
StructuredQueryBuilder.ElementConstraintQuery |
StructuredQueryBuilder.elementConstraint(String constraintName,
StructuredQueryDefinition query)
Deprecated.
Matches a query within the substructure of the container specified
by the constraint.
This method is deprecated in favor of the more general
containerConstraint() method. |
StructuredQueryBuilder.LocksQuery |
StructuredQueryBuilder.locks(StructuredQueryDefinition query)
Associates a query with durable locks on documents (as opposed to
the content or properties of documents).
|
StructuredQueryBuilder.NearQuery |
StructuredQueryBuilder.near(int distance,
double weight,
StructuredQueryBuilder.Ordering order,
StructuredQueryDefinition... queries)
Defines a NEAR query over the list of query definitions
with specified parameters.
|
StructuredQueryBuilder.NearQuery |
StructuredQueryBuilder.near(StructuredQueryDefinition... queries)
Defines a NEAR query over the list of query definitions
with default parameters.
|
StructuredQueryBuilder.NotQuery |
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.
|
StructuredQueryBuilder.OrQuery |
StructuredQueryBuilder.or(StructuredQueryDefinition... queries)
Defines an OR query over the list of query definitions.
|
StructuredQueryBuilder.PropertiesQuery |
StructuredQueryBuilder.properties(StructuredQueryDefinition query)
Associates a query with the properties of documents (as opposed to
the content of documents).
|
StructuredQueryBuilder.PropertiesConstraintQuery |
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.
|
Constructor and Description |
---|
AndNotQuery(StructuredQueryDefinition positive,
StructuredQueryDefinition negative)
Deprecated.
Use the andNot() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
AndQuery(StructuredQueryDefinition... queries)
Deprecated.
Use the and() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
DocumentFragmentQuery(StructuredQueryDefinition query)
Deprecated.
Use the documentFragment() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
ElementConstraintQuery(String constraintName,
StructuredQueryDefinition query)
Deprecated.
Use the elementConstraint() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
LocksQuery(StructuredQueryDefinition query)
Deprecated.
Use the locks() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
NearQuery(Integer distance,
Double weight,
StructuredQueryBuilder.Ordering order,
StructuredQueryDefinition... queries)
Deprecated.
|
NearQuery(StructuredQueryDefinition... queries)
Deprecated.
Use the near() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
NotQuery(StructuredQueryDefinition query)
Deprecated.
Use the not() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
OrQuery(StructuredQueryDefinition... queries)
Deprecated.
Use the or() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
PropertiesConstraintQuery(String constraintName,
StructuredQueryDefinition query)
Deprecated.
Use the propertiesConstraint() builder method of StructuredQueryBuilder
operator and type the object as an instance of the StructuredQueryDefinition interface.
|
PropertiesQuery(StructuredQueryDefinition query)
Deprecated.
Use the properties() builder method of StructuredQueryBuilder
and type the object as an instance of the StructuredQueryDefinition interface.
|
Copyright © 2013-2016 MarkLogic Corporation.