Package com.marklogic.client.expression

Class CtsQueryBuilder

java.lang.Object

com.marklogic.client.expression.CtsQueryBuilder

public abstract class CtsQueryBuilder
extends java.lang.Object

CtsQueryBuilder builds a query for documents in the database.

Field Summary

Fields

Modifier and Type	Field	Description
CtsExpr	cts	Builds expressions with cts server functions.
FnExpr	fn	Builds expressions with fn server functions.
GeoExpr	geo	Builds expressions with geo server functions.
JsonExpr	json	Builds expressions with json server functions.
MapExpr	map	Builds expressions with map server functions.
MathExpr	math	Builds expressions with math server functions.
RdfExpr	rdf	Builds expressions with rdf server functions.
SemExpr	sem	Builds expressions with sem server functions.
SpellExpr	spell	Builds expressions with spell server functions.
SqlExpr	sql	Builds expressions with sql server functions.
XdmpExpr	xdmp	Builds expressions with xdmp server functions.
XsExpr	xs	Builds expressions with xs server functions.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CtsQueryBuilder(CtsExpr cts, FnExpr fn, GeoExpr geo, JsonExpr json, MapExpr map, MathExpr math, RdfExpr rdf, SemExpr sem, SpellExpr spell, SqlExpr sql, XdmpExpr xdmp, XsExpr xs)

Method Summary

Modifier and Type	Method	Description
abstract <T extends JSONReadHandle> T	export(CtsQueryExpr query, T handle)	Export cts query into a handle in AST format
abstract CtsQueryDefinition	newCtsQueryDefinition(CtsQueryExpr query)	Create a CtsQueryDefinition based on a cts query
abstract CtsQueryDefinition	newCtsQueryDefinition(CtsQueryExpr query, JSONWriteHandle queryOptions)	Create a CtsQueryDefinition based on a cts query and query options

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cts

public final CtsExpr cts

Builds expressions with cts server functions.

fn

public final FnExpr fn

Builds expressions with fn server functions.

geo

public final GeoExpr geo

Builds expressions with geo server functions.

json

public final JsonExpr json

Builds expressions with json server functions.

map

public final MapExpr map

Builds expressions with map server functions.

math

public final MathExpr math

Builds expressions with math server functions.

rdf

public final RdfExpr rdf

Builds expressions with rdf server functions.

sem

public final SemExpr sem

Builds expressions with sem server functions.

spell

public final SpellExpr spell

Builds expressions with spell server functions.

sql

public final SqlExpr sql

Builds expressions with sql server functions.

xdmp

public final XdmpExpr xdmp

Builds expressions with xdmp server functions.

xs

public final XsExpr xs

Builds expressions with xs server functions.

Constructor Detail

CtsQueryBuilder

protected CtsQueryBuilder(CtsExpr cts,
                          FnExpr fn,
                          GeoExpr geo,
                          JsonExpr json,
                          MapExpr map,
                          MathExpr math,
                          RdfExpr rdf,
                          SemExpr sem,
                          SpellExpr spell,
                          SqlExpr sql,
                          XdmpExpr xdmp,
                          XsExpr xs)

Method Detail

newCtsQueryDefinition

public abstract CtsQueryDefinition newCtsQueryDefinition(CtsQueryExpr query)

Create a CtsQueryDefinition based on a cts query

Parameters:

query - a cts query

Returns:

a CtsQueryDefinition

newCtsQueryDefinition

public abstract CtsQueryDefinition newCtsQueryDefinition(CtsQueryExpr query,
                                                         JSONWriteHandle queryOptions)

Create a CtsQueryDefinition based on a cts query and query options

Parameters:

query - a cts query

queryOptions - query options

Returns:

a CtsQueryDefinition

export

public abstract <T extends JSONReadHandle> T export(CtsQueryExpr query,
                                                    T handle)

Export cts query into a handle in AST format

Type Parameters:

T - the handle type

Parameters:

query - the cts query to be exported

handle - the handle to store exported query

Returns:

a handle which contains exported cts query in AST format