Uses of Package
com.marklogic.client.query

Packages that use com.marklogic.client.query

Package	Description
com.marklogic.client	The package provides the core classes, interfaces and exceptions for working with the database.
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.example.extension	The package provides examples of extensions that operate on a batch of database documents.
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

Classes in com.marklogic.client.query used by com.marklogic.client

Class and Description
QueryManager A Query Manager supports searching documents and retrieving values and tuples from lexicons.

Classes in com.marklogic.client.query used by com.marklogic.client.alerting

Class and Description
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.

Classes in com.marklogic.client.query used by com.marklogic.client.document

Class and Description
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.
QueryManager.QueryView The view produced by a query.

Classes in com.marklogic.client.query used by com.marklogic.client.example.extension

Class and Description
StructuredQueryDefinition A StructuredQueryDefinition represents a structured query.

Classes in com.marklogic.client.query used by com.marklogic.client.impl

Class and Description
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.

Classes in com.marklogic.client.query used by com.marklogic.client.io

Class and Description
AggregateResult A CountedDistinctValue is a value that includes a frequency.
CountedDistinctValue A CountedDistinctValue is a value that includes a frequency.
FacetResult A FacetResult represents a single facet as returned by a search.
MatchDocumentSummary A MatchDocumentSummary is the information returned for each document found by a search.
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.
QueryOptionsListResults This interface supports access to the list of named query options provided by the server.
SearchMetrics A SearchMetrics object represents the query metrics returned by a search.
SearchResults The SearchResults represent the set of results returned by a search.
Tuple A Tuple is a single tuple value taken from a tuple/value query.
TuplesResults TupleResults represent the values returned by a tuple values query.
ValuesDefinition A ValuesDefinition represents a values query used to retreive values from the server.
ValuesListResults A ValuesListResults represents the results of a values query.
ValuesMetrics A SearchMetrics object represents the query metrics returned by a search.
ValuesResults ValuesResults represents one set of values from a values query.

Classes in com.marklogic.client.query used by com.marklogic.client.pojo

Class and Description
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.
RawStructuredQueryDefinition A RawStructuredQueryDefinition provides access to a structured query in a JSON or XML representation.
StructuredQueryBuilder.GeospatialIndex A GeospatialIndex can be used for geospatial queries.
StructuredQueryBuilder.Ordering Control over ordering for use in near queries.
StructuredQueryBuilder.Point Deprecated. Treat the Point class as an interface that extends Region.
StructuredQueryBuilder.Region A region matched by a geospatial query.
StructuredQueryDefinition A StructuredQueryDefinition represents a structured query.

Classes in com.marklogic.client.query used by com.marklogic.client.query

Class and Description
AggregateResult A CountedDistinctValue is a value that includes a frequency.
CountedDistinctValue A CountedDistinctValue is a value that includes a frequency.
DeleteQueryDefinition A DeleteQueryDefinition is a query definition suitable for use in performing a delete query.
ElementLocator Deprecated. Use Query By Example instead for easy-to-write and much more full-featured key/value search. An Element Locator specifies an element or element and attribute containing a value as part of a KeyValueQueryDefinition. The element is required. The attribute is optional.
ExtractedItem Access the extracted XML or JSON node using any StructureReadHandle or class registered by a ContentHandle.
ExtractedResult Surfaces the data sent from the server-side XQuery search:search API.
FacetResult A FacetResult represents a single facet as returned by a search.
FacetValue A FacetValue represents a single value returned in a set of facet results.
KeyLocator Deprecated. Use Query By Example instead for easy-to-write and much more full-featured key/value search. A Key Locator specifies a JSON key containing a value as part of a KeyValueQueryDefinition.
KeyValueQueryDefinition Deprecated. Use Query By Example instead for easy-to-write and much more full-featured key/value search. For instance: QueryManager queryMgr = databaseClient.newQueryManager(); String rawXMLQuery = "{ \"$query\": { \"author\": \"Mark Twain\" } }"; StringHandle qbeHandle = new StringHandle(rawXMLQuery).withFormat(Format.JSON); RawQueryByExampleDefinition query = queryMgr.newRawQueryByExampleDefinition(qbeHandle, "myoptions"); SearchHandle resultsHandle = queryMgr.search(query, new SearchHandle());
MatchDocumentSummary A MatchDocumentSummary is the information returned for each document found by a search.
MatchLocation A MatchLocation represents a location in a document matched by a search.
MatchSnippet A MatchSnippet is a Java object representation of a part of a snippet.
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.
QueryManager.QueryView The view produced by a query.
RawCombinedQueryDefinition A RawCombinedQueryDefinition provides access to a combined query in a JSON or XML representation.
RawQueryByExampleDefinition A RawQueryByExampleDefinition provides access to a simple query by example in an JSON or XML representation.
RawQueryDefinition A RawQueryDefinition provides access to a query in a JSON or XML representation.
RawStructuredQueryDefinition A RawStructuredQueryDefinition provides access to a structured query in a JSON or XML representation.
SearchMetrics A SearchMetrics object represents the query metrics returned by a search.
StringQueryDefinition A StringQueryDefinition represents the criteria associated with a simple string query.
StructuredQueryBuilder StructuredQueryBuilder builds a query for documents in the database.
StructuredQueryBuilder.AndNotQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of AndNotQuery.
StructuredQueryBuilder.AndQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of AndQuery.
StructuredQueryBuilder.Attribute An Attribute represents an attribute in database documents.
StructuredQueryBuilder.Axis An axis for use in temporalPeriodRange or temporalPeriodCompare queries.
StructuredQueryBuilder.Box Deprecated. Use the Region interface as the type for instances of Box.
StructuredQueryBuilder.Circle Deprecated. Use the Region interface as the type for instances of Circle.
StructuredQueryBuilder.CollectionConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of CollectionConstraintQuery.
StructuredQueryBuilder.CollectionQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of CollectionQuery.
StructuredQueryBuilder.ContainerIndex A ContainerIndex can be used for container queries.
StructuredQueryBuilder.CustomConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of CustomConstraintQuery.
StructuredQueryBuilder.DirectoryQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of DirectoryQuery.
StructuredQueryBuilder.DocumentFragmentQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of DocumentFragmentQuery.
StructuredQueryBuilder.DocumentQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of DocumentQuery.
StructuredQueryBuilder.Element An Element represents an element in database documents.
StructuredQueryBuilder.ElementAttribute An ElementAttribute represents an attribute on an element in database documents.
StructuredQueryBuilder.ElementConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of ElementConstraintQuery.
StructuredQueryBuilder.Field A Field represents a field defined in the database configuration.
StructuredQueryBuilder.FragmentScope Whether a query should search the document or its associated properties.
StructuredQueryBuilder.GeospatialConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of GeospatialConstraintQuery.
StructuredQueryBuilder.GeospatialIndex A GeospatialIndex can be used for geospatial queries.
StructuredQueryBuilder.JSONProperty A JSONProperty represents a key in JSON database documents.
StructuredQueryBuilder.LocksQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of LocksQuery.
StructuredQueryBuilder.NearQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of NearQuery.
StructuredQueryBuilder.NotQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of NotQuery.
StructuredQueryBuilder.Operator A comparison operator for use in range queries.
StructuredQueryBuilder.Ordering Control over ordering for use in near queries.
StructuredQueryBuilder.OrQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of OrQuery.
StructuredQueryBuilder.PathIndex A PathIndex represents an index defined with an XPath in the database configuration.
StructuredQueryBuilder.Period A temporal period for use in temporalPeriodRange queries.
StructuredQueryBuilder.Point Deprecated. Treat the Point class as an interface that extends Region.
StructuredQueryBuilder.Polygon Deprecated. Use the Region interface as the type for instances of Polygon.
StructuredQueryBuilder.PropertiesConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of PropertiesConstraintQuery.
StructuredQueryBuilder.PropertiesQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of PropertiesQuery.
StructuredQueryBuilder.RangeConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of RangeConstraintQuery.
StructuredQueryBuilder.RangeIndex A RangeIndex can be used for range queries.
StructuredQueryBuilder.Region A region matched by a geospatial query.
StructuredQueryBuilder.TemporalOperator The Allen and ISO SQL 2011 temporal operators available for use in temporalPeriodRange or temporalPeriodCompare queries.
StructuredQueryBuilder.TermQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of TermQuery.
StructuredQueryBuilder.TextIndex A TextIndex can be used for word and value queries.
StructuredQueryBuilder.ValueConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of ValueConstraintQuery.
StructuredQueryBuilder.WordConstraintQuery Deprecated. Use the StructuredQueryDefinition interface as the type for instances of WordConstraintQuery.
StructuredQueryDefinition A StructuredQueryDefinition represents a structured query.
SuggestDefinition Represents the criteria for a suggestion call, in which the beginning of a term is supplied for possible suggested endings.
Tuple A Tuple is a single tuple value taken from a tuple/value query.
TypedDistinctValue A TypedDistinctValue is a value that includes a type.
ValueLocator Deprecated. Use Query By Example instead for easy-to-write and much more full-featured key/value search. A Locator identifying a JSON key, element, or element and attribute containing a value as part of a KeyValueQueryDefinition.
ValueQueryDefinition ValueQueryDefinitions can be used in value queries.
ValuesDefinition A ValuesDefinition represents a values query used to retreive values from the server.
ValuesDefinition.Direction The possible directions.
ValuesDefinition.Frequency The kinds of frequencies.
ValuesListDefinition A ValuesListDefinition is the base type for a values or tuples list.
ValuesMetrics A SearchMetrics object represents the query metrics returned by a search.

Classes in com.marklogic.client.query used by com.marklogic.client.semantics

Class and Description
QueryDefinition A QueryDefinition represents the common parts of all kinds of searches that can be performed.