Package com.marklogic.client.expression

The package provides classes for building Optic plan pipelines and expressions for execution on the REST server.

See: Description

Interface Summary

Interface	Description
CtsExpr	Builds expressions to call functions in the cts server library for a row pipeline.
FnExpr	Builds expressions to call functions in the fn server library for a row pipeline.
GeoExpr	Builds expressions to call functions in the geo server library for a row pipeline.
JsonExpr	Builds expressions to call functions in the json server library for a row pipeline.
MapExpr	Builds expressions to call functions in the map server library for a row pipeline.
MathExpr	Builds expressions to call functions in the math server library for a row pipeline.
PlanBuilder.AccessPlan	Provides functions and operations in the access phase of the plan for executing a row pipeline on the server.
PlanBuilder.ExportablePlan	Provides functions and operations in the exportable phase of the plan for executing a row pipeline on the server.
PlanBuilder.ModifyPlan	Provides functions and operations in the modify phase of the plan for executing a row pipeline on the server.
PlanBuilder.Plan	Provides functions and operations in the final phase of the plan for executing a row pipeline on the server.
PlanBuilder.PreparePlan	Provides functions and operations in the prepare phase of the plan for executing a row pipeline on the server.
PlanBuilderBase	Defines base methods for PlanBuilder.
PlanBuilderBase.AccessPlanBase	Defines base methods for AccessPlan.
PlanBuilderBase.ExportablePlanBase	Defines base methods for ExportablePlan.
PlanBuilderBase.ModifyPlanBase	Defines base methods for ModifyPlan.
PlanBuilderBase.PlanBase	Defines base methods for Plan.
PlanBuilderBase.PreparePlanBase	Defines base methods for PreparePlan.
RdfExpr	Builds expressions to call functions in the rdf server library for a row pipeline and constructs client values with rdf.* server types.
RdfValue	RdfValue takes Java values and constructs atomic values and sequences of atomic values with an rdf data type The typed values can then be passed to expression functions for execution on the server.
RdtExpr	The RdtExpr instance provides functions that build expressions for redacting the values of a column.
SchemaDefExpr	Defines the schema for using with the validateDoc operator;
SemExpr	Builds expressions to call functions in the sem server library for a row pipeline and constructs client values with sem.* server types.
SemValue	SemValue takes Java values and constructs atomic values and sequences of atomic values with a semantic data type The typed values can then be passed to expression functions for execution on the server.
SpellExpr	Builds expressions to call functions in the spell server library for a row pipeline.
SqlExpr	Builds expressions to call functions in the sql server library for a row pipeline.
TransformDef	Defines a transform for using with the transformDoc operator; the assumption is that a factory method will be used to instantiate this which requires the path of the transform module.
VecExpr	Builds expressions to call functions in the vec server library for a row pipeline.
XdmpExpr	Builds expressions to call functions in the xdmp server library for a row pipeline.
XsExpr	Builds expressions to call functions in the xs server library for a row pipeline and constructs client values with xs.* server types.
XsValue	XsValue takes Java values and constructs atomic values and sequences of atomic values with an xs schema data type The typed values can then be passed to expression functions for execution on the server.

Class Summary

Class	Description
CtsQueryBuilder	CtsQueryBuilder builds a query for documents in the database.
PlanBuilder	Builds the plan for a row pipeline to execute on the server.

Package com.marklogic.client.expression Description

The package provides classes for building Optic plan pipelines and expressions for execution on the REST server. Use RowManager to create the PlanBuilder object.

The PlanBuilder can define expressions for execution on the server by composing calls to server functions. In Java, the parameters and return values of the server expression functions are typed as ServerExpression. On the server, expression have server types that are determined dynamically. The server coerces the actual type of the return value from a call to a server expression function to the expected type of a parameter for a call to a server expression function. To see the relationships between the server data types, see the Server Expression Type Hierarchy.