com.marklogic.client.query

Interface QueryDefinition

All Superinterfaces:

SearchQueryDefinition

All Known Subinterfaces:

DeleteQueryDefinition, PojoQueryDefinition, RawCombinedQueryDefinition, RawCtsQueryDefinition, RawQueryByExampleDefinition, RawQueryDefinition, RawStructuredQueryDefinition, SPARQLQueryDefinition, StringQueryDefinition, StructuredQueryBuilder.Box, StructuredQueryBuilder.Circle, StructuredQueryBuilder.Point, StructuredQueryBuilder.Polygon, StructuredQueryBuilder.Region, StructuredQueryDefinition, ValueQueryDefinition

All Known Implementing Classes:

com.marklogic.client.impl.AbstractQueryDefinition, StructuredQueryBuilder.AbstractStructuredQuery, StructuredQueryBuilder.AndNotQuery, StructuredQueryBuilder.AndQuery, StructuredQueryBuilder.BoxImpl, StructuredQueryBuilder.CircleImpl, StructuredQueryBuilder.CollectionConstraintQuery, StructuredQueryBuilder.CollectionQuery, StructuredQueryBuilder.ContainerQuery, StructuredQueryBuilder.CustomConstraintQuery, StructuredQueryBuilder.DirectoryQuery, StructuredQueryBuilder.DocumentFragmentQuery, StructuredQueryBuilder.DocumentQuery, StructuredQueryBuilder.GeospatialConstraintQuery, StructuredQueryBuilder.GeospatialPointQuery, StructuredQueryBuilder.GeospatialRegionConstraintQuery, StructuredQueryBuilder.GeospatialRegionQuery, StructuredQueryBuilder.LocksQuery, StructuredQueryBuilder.NearQuery, StructuredQueryBuilder.NotQuery, StructuredQueryBuilder.OrQuery, StructuredQueryBuilder.PointImpl, StructuredQueryBuilder.PolygonImpl, StructuredQueryBuilder.PropertiesConstraintQuery, StructuredQueryBuilder.PropertiesQuery, StructuredQueryBuilder.RangeConstraintQuery, StructuredQueryBuilder.RangeQuery, StructuredQueryBuilder.RegionImpl, StructuredQueryBuilder.TemporalLsqtQuery, StructuredQueryBuilder.TemporalPeriod, StructuredQueryBuilder.TemporalPeriodCompareQuery, StructuredQueryBuilder.TemporalPeriodRangeQuery, StructuredQueryBuilder.TermQuery, StructuredQueryBuilder.TimeQuery, StructuredQueryBuilder.ValueConstraintQuery, StructuredQueryBuilder.ValueQuery, StructuredQueryBuilder.WordConstraintQuery, StructuredQueryBuilder.WordQuery

public interface QueryDefinition
extends SearchQueryDefinition

A QueryDefinition represents the common parts of most kinds of searches(except Cts query) that can be performed.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCollections() Returns the array of collections to which the query is limited.
java.lang.String	getDirectory() Returns the directory to which the query is limited.
void	setCollections(java.lang.String... collections) Sets the list of collections to which the query should be limited.
void	setDirectory(java.lang.String directory) Sets the directory to which the query should be limited.

Methods inherited from interface com.marklogic.client.query.SearchQueryDefinition

getOptionsName, getResponseTransform, setOptionsName, setResponseTransform

Method Detail

getCollections

java.lang.String[] getCollections()

Returns the array of collections to which the query is limited.

Returns:

The array of collection URIs.

setCollections

void setCollections(java.lang.String... collections)

Sets the list of collections to which the query should be limited.

Parameters:

collections - The list of collection URIs.

getDirectory

java.lang.String getDirectory()

Returns the directory to which the query is limited.

Returns:

The directory URI.

setDirectory

void setDirectory(java.lang.String directory)

Sets the directory to which the query should be limited.

Parameters:

directory - The directory URI.