Package | Description |
---|---|
com.marklogic.client.alerting |
A REST interface to MarkLogic alerting capabilities.
|
com.marklogic.client.document |
The package provides classes for creating, retrieving, updating, and deleting
documents in the database for the REST server.
|
com.marklogic.client.impl | |
com.marklogic.client.io |
The package provides the handle classes with different representations for document content
when you read documents from the database or write documents to the database.
|
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.
|
com.marklogic.client.semantics |
Modifier and Type | Method and Description |
---|---|
<T extends RuleListReadHandle> |
RuleManager.match(QueryDefinition docQuery,
long start,
long pageLength,
String[] candidateRules,
T ruleListHandle)
Matches server rules based on results of a search, with pagination applied to search.
|
<T extends RuleListReadHandle> |
RuleManager.match(QueryDefinition docQuery,
long start,
long pageLength,
String[] candidateRules,
T ruleListHandle,
ServerTransform transform)
Matches server rules based on results of a search, with pagination applied to search.
|
<T extends RuleListReadHandle> |
RuleManager.match(QueryDefinition docQuery,
T ruleListHandle)
Matches server rules based on the results of a search.
|
Modifier and Type | Method and Description |
---|---|
DocumentPage |
DocumentManager.search(QueryDefinition querydef,
long start)
Just like
QueryManager.search
but return complete documents via iterable DocumentPage. |
DocumentPage |
DocumentManager.search(QueryDefinition querydef,
long start,
SearchReadHandle searchHandle)
Just like
QueryManager.search
but return complete documents via iterable DocumentPage. |
DocumentPage |
DocumentManager.search(QueryDefinition querydef,
long start,
SearchReadHandle searchHandle,
Transaction transaction)
Just like
QueryManager.search(QueryDefinition, SearchReadHandle, long, Transaction)
but return complete documents via iterable DocumentPage. |
DocumentPage |
DocumentManager.search(QueryDefinition querydef,
long start,
Transaction transaction)
Just like
QueryManager.search
but return complete documents via iterable DocumentPage. |
Modifier and Type | Class and Description |
---|---|
class |
com.marklogic.client.impl.AbstractQueryDefinition |
Modifier and Type | Method and Description |
---|---|
QueryDefinition |
SearchHandle.getQueryCriteria()
Returns the query definition used for the search represented by this handle.
|
Modifier and Type | Method and Description |
---|---|
void |
SearchHandle.setQueryCriteria(QueryDefinition querydef)
Sets the query definition used in the search.
|
Modifier and Type | Interface and Description |
---|---|
interface |
PojoQueryDefinition
A marker interface identifying QueryDefinition types compatible with
PojoRepository.search |
Modifier and Type | Interface and Description |
---|---|
interface |
DeleteQueryDefinition
A DeleteQueryDefinition is a query definition suitable for use in performing a delete query.
|
interface |
KeyValueQueryDefinition
Deprecated.
Use Query By Example instead for easy-to-write and much more full-featured key/value search.
For instance:
|
interface |
RawCombinedQueryDefinition
A RawCombinedQueryDefinition provides access to a combined query
in a JSON or XML representation.
|
interface |
RawQueryByExampleDefinition
A RawQueryByExampleDefinition provides access to a simple
query by example in an JSON or XML representation.
|
interface |
RawQueryDefinition
A RawQueryDefinition provides access to a query
in a JSON or XML representation.
|
interface |
RawStructuredQueryDefinition
A RawStructuredQueryDefinition provides access to a structured query
in a JSON or XML representation.
|
interface |
StringQueryDefinition
A StringQueryDefinition represents the criteria associated with a simple string query.
|
interface |
StructuredQueryDefinition
A StructuredQueryDefinition represents a structured query.
|
interface |
ValueQueryDefinition
ValueQueryDefinitions can be used in value queries.
|
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 |
---|---|
QueryDefinition |
SearchResults.getQueryCriteria()
Returns the query definition associated with this query.
|
Modifier and Type | Method and Description |
---|---|
MatchDocumentSummary |
QueryManager.findOne(QueryDefinition querydef)
The findOne method is a convenience.
|
MatchDocumentSummary |
QueryManager.findOne(QueryDefinition querydef,
Transaction transaction)
The findOne method is a convenience.
|
<T extends SearchReadHandle> |
QueryManager.search(QueryDefinition querydef,
T searchHandle)
Searches documents based on query criteria and, potentially, previously
saved query options.
|
<T extends SearchReadHandle> |
QueryManager.search(QueryDefinition querydef,
T searchHandle,
long start)
Searches documents based on query criteria and, potentially, previously
saved query options starting with the specified page listing
document results.
|
<T extends SearchReadHandle> |
QueryManager.search(QueryDefinition querydef,
T searchHandle,
long start,
Transaction transaction)
Searches documents based on query criteria and, potentially, previously
saved query options starting with the specified page listing
document results.
|
<T extends SearchReadHandle> |
QueryManager.search(QueryDefinition querydef,
T searchHandle,
Transaction transaction)
Searches documents based on query criteria and, potentially, previously
saved query options.
|
Modifier and Type | Interface and Description |
---|---|
interface |
SPARQLQueryDefinition
Represents a SPARQL query.
|
Modifier and Type | Method and Description |
---|---|
QueryDefinition |
SPARQLQueryDefinition.getConstrainingQueryDefinition() |
Modifier and Type | Method and Description |
---|---|
void |
SPARQLQueryDefinition.setConstrainingQueryDefinition(QueryDefinition query)
Set the search query used to constrain the set of documents included in
the SPARQL query.
|
SPARQLQueryDefinition |
SPARQLQueryDefinition.withConstrainingQuery(QueryDefinition query)
Set the search query used to constrain the set of documents included in
the SPARQL query.
|
Copyright © 2013-2016 MarkLogic Corporation.