Package com.marklogic.client.query

Interface StructuredQueryDefinition

All Superinterfaces:

PojoQueryDefinition, QueryDefinition, ValueQueryDefinition

All Known Subinterfaces:

StructuredQueryBuilder.Box, StructuredQueryBuilder.Circle, StructuredQueryBuilder.Point, StructuredQueryBuilder.Polygon, StructuredQueryBuilder.Region

All Known Implementing Classes:

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 StructuredQueryDefinition
extends QueryDefinition, ValueQueryDefinition, PojoQueryDefinition

A StructuredQueryDefinition represents a structured query. Instances of this interface are produced by StructuredQueryBuilder.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCriteria()	Returns the query criteria, that is the query string.
java.lang.String	serialize()	Returns the structured query definition as a serialized XML string.
void	setCriteria(java.lang.String criteria)	Sets the query criteria as a query string.
StructuredQueryDefinition	withCriteria(java.lang.String criteria)	Sets the query criteria as a query string and returns the query definition as a fluent convenience.

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

getCollections, getDirectory, getOptionsName, getResponseTransform, setCollections, setDirectory, setOptionsName, setResponseTransform

Method Detail

serialize

java.lang.String serialize()

Returns the structured query definition as a serialized XML string.

Returns:

The serialized definition.

getCriteria

java.lang.String getCriteria()

Returns the query criteria, that is the query string.

Returns:

The query string.

setCriteria

void setCriteria(java.lang.String criteria)

Sets the query criteria as a query string.

Parameters:

criteria - The query string.

withCriteria

StructuredQueryDefinition withCriteria(java.lang.String criteria)

Sets the query criteria as a query string and returns the query definition as a fluent convenience.

Parameters:

criteria - The query string.

Returns:

This query definition.