Package com.marklogic.client.type

The package provides interfaces specifying the type of an expression or value as passed to a PlanBuilder method or returned from a RowRecord method.

See: Description

Interface Summary

Interface	Description
CtsBoxExpr	An instance of a cts.box expression.
CtsBoxSeqExpr	A sequence of cts.box expressions.
CtsCircleExpr	An instance of a cts.circle expression.
CtsCircleSeqExpr	A sequence of cts.circle expressions.
CtsPeriodExpr	An instance of a cts.period expression.
CtsPeriodSeqExpr	A sequence of cts.period expressions.
CtsPointExpr	An instance of a cts.point expression.
CtsPointSeqExpr	A sequence of cts.point expressions.
CtsPolygonExpr	An instance of a cts.polygon expression.
CtsPolygonSeqExpr	A sequence of cts.polygon expressions.
CtsQueryExpr	An instance of a cts.query expression.
CtsQuerySeqExpr	A sequence of cts.query expressions.
CtsReferenceExpr	An instance of a cts.reference expression.
CtsReferenceSeqExpr	A sequence of cts.reference expressions.
CtsRegionExpr	An instance of a cts.region expression.
CtsRegionSeqExpr	A sequence of cts.region expressions.
ItemSeqVal	One or more server values.
ItemVal	An instance of a server value.
PatchBuilder	Manually constructed by first adding the methods to PlanBuilder in optic-defs.json (which is the wrong place) and then moving them to this manually created interface, and then removing the methods from optic-defs.json.
PlanAggregateCol	An instance of a column populated by an aggregate expression in a row pipeline.
PlanAggregateColSeq	A sequence of columns populated by an aggregate expressions in a row pipeline.
PlanCase	An instance of a when or else argument to a case expression in a row pipeline.
PlanCaseSeq	A sequence of when arguments to a case expression in a row pipeline.
PlanColumn	An instance of a column expression returned by a col() call in a row pipeline.
PlanColumnSeq	A sequence of column expressions returned by col() calls for a row pipeline.
PlanCondition	An instance of a conditional expression.
PlanConditionSeq	A sequence of conditional expressions.
PlanDocColsIdentifier
PlanDocColsIdentifierSeq
PlanDocDescriptor
PlanDocDescriptorSeq
PlanExprCol	An instance of a column expression returned by an as() or col() call in a row pipeline.
PlanExprColSeq	A sequence of column expressions returned by as() or col() calls in a row pipeline.
PlanFunction	An instance of a function used for map() or reduce() post-processing of a row pipeline on the server.
PlanFunctionSeq	A sequence of functions used for map() or reduce() post-processing of a row pipeline on the server.
PlanGroup	An instance of a group returned by a group() call in a row pipeline.
PlanGroupConcatOption	An instance of a PlanValueOption or separator string for a group concat aggregate expression in a row pipeline.
PlanGroupConcatOptionSeq	A sequence of PlanValueOption or separator strings for a group concat aggregate expression in a row pipeline.
PlanGroupSeq	A sequence of group expressions returned by group() calls in a row pipeline.
PlanJoinKey	An instance of a join key equivalence expression returned by an on() call in a row pipeline.
PlanJoinKeySeq	A sequence of join key equivalence expressions returned by on() calls in a row pipeline.
PlanJsonProperty	An instance of a JSON property returned by a prop() call or passed as an argument to a jsonObject() call in a row pipeline.
PlanJsonPropertySeq	A sequence of JSON properties returned by prop() calls or passed as an argument to a jsonObject() call in a row pipeline.
PlanNamedGroup	An instance of a group returned by a namedGroup() call in a row pipeline.
PlanNamedGroupSeq	A sequence of group expressions returned by namedGroup() calls in a row pipeline.
PlanNamespaceBindings
PlanNamespaceBindingsSeq
PlanParamBindingSeqVal	A sequence of literal values to pass as arguments to bind() calls to assign to placeholder parameters for a row pipeline.
PlanParamBindingVal	An instance of a literal value passed as an argument to a bind() call to assign to a placeholder parameter for a row pipeline.
PlanParamExpr	An instance of a placeholder parameter returned by a call to the param() function that can represent a literal value in expressions and can be passed on a bind() call to be assigned a literal value when invoking a row pipeline.
PlanParamSeqExpr	A sequence of placeholder parameters returned by calls to param() functions that can represent literal values in expressions and can be passed on bind() calls to be assigned literal values when invoking a row pipeline.
PlanPrefixer	An instance of a convenience that can prepend a base URL when creating iteral semantic IRI values for use in triple patterns for a row pipeline.
PlanPrefixerSeq	A sequence of conveniences that can prepend a base URL when creating iteral semantic IRI values for use in triple patterns for a row pipeline.
PlanRowColTypes
PlanRowColTypesSeq
PlanSampleByOptions	An option controlling the sampling of rows from view, triple, or lexicon indexes for a row pipeline.
PlanSchemaDef
PlanSchemaDefSeq
PlanSearchOptions	An option controlling the scoring and weighting of fromSearch() for a row pipeline.
PlanSortKey	An instance of a column - potentially with a sort direction specified by an asc() or desc() call - for an orderBy() operation in a row pipeline.
PlanSortKeySeq	A sequence of columns - potentially with a sort direction specified by an asc() or desc() call - for an orderBy() operation in a row pipeline.
PlanSparqlOptions	An option controlling whether to check for duplicate triples (which is more expensive) or to supply a base IRI for triples IRIs.
PlanSystemColumn	An instance of a fragment id, graph id, or other system column for a row pipeline.
PlanSystemColumnSeq	A sequence of fragment id, graph id, or other system columns for a row pipeline.
PlanTransformDef
PlanTransformDefSeq
PlanTriplePattern	An instance of a pattern for projecting rows from triples in a row pipeline.
PlanTriplePatternSeq	A sequence of patterns for projecting rows from triples in a row pipeline.
PlanTriplePosition	An instance of a literal value or column for a position within a pattern for projecting rows from triples in a row pipeline.
PlanTriplePositionSeq	A sequence of literal values or columns for positions within patterns for projecting rows from triples in a row pipeline.
PlanValueOptionSeq	A sequence of options controlling whether to calculate over all values including duplicates or over distinct values for aggregate expressions in a row pipeline.
RdfLangStringSeqVal	An instance of an RDF language string value.
RdfLangStringVal	A sequence of RDF language string values.
SemIriSeqVal	A sequence of semantic IRI values.
SemIriVal	An instance of a semantic IRI value.
SemStoreExpr	An instance of a semantic store expression.
SemStoreSeqExpr	A sequence of semantic store expressions.
ServerExpression	One or more server expressions.
XsAnyAtomicTypeSeqVal	A sequence of server atomic values.
XsAnyAtomicTypeVal	An instance of a server atomic value.
XsAnySimpleTypeSeqVal	A sequence of server simple values.
XsAnySimpleTypeVal	An instance of a server simple value.
XsAnyURISeqVal	A sequence of server URI values.
XsAnyURIVal	An instance of a server URI value.
XsBase64BinarySeqVal	A sequence of server base 64 binary values.
XsBase64BinaryVal	An instance of a server base 64 binary value.
XsBooleanSeqVal	A sequence of server boolean values.
XsBooleanVal	An instance of a server boolean value.
XsByteSeqVal	A sequence of server byte values.
XsByteVal	An instance of a server byte value.
XsDateSeqVal	A sequence of server date values.
XsDateTimeSeqVal	A sequence of server datetime values.
XsDateTimeVal	An instance of a server datetime value.
XsDateVal	An instance of a server date value.
XsDayTimeDurationSeqVal	A sequence of server day-time duration values.
XsDayTimeDurationVal	An instance of a server day-time duration value.
XsDecimalSeqVal	A sequence of server decimal values.
XsDecimalVal	An instance of a server decimal value.
XsDoubleSeqVal	A sequence of server double values.
XsDoubleVal	An instance of a server double value.
XsDurationSeqVal	A sequence of server duration values.
XsDurationVal	An instance of a server duration value.
XsFloatSeqVal	A sequence of server float values.
XsFloatVal	An instance of a server float value.
XsGDaySeqVal	A sequence of server GDay values.
XsGDayVal	An instance of a server GDay value.
XsGMonthDaySeqVal	A sequence of server GMonthDay values.
XsGMonthDayVal	An instance of a server GMonthDay value.
XsGMonthSeqVal	A sequence of server GMonth values.
XsGMonthVal	An instance of a server GMonth value.
XsGYearMonthSeqVal	A sequence of server GYearMonth values.
XsGYearMonthVal	An instance of a server GYearMonth value.
XsGYearSeqVal	A sequence of server GYear values.
XsGYearVal	An instance of a server GYear value.
XsHexBinarySeqVal	A sequence of server hex binary values.
XsHexBinaryVal	An instance of a server hex binary value.
XsIntegerSeqVal	A sequence of server integer values.
XsIntegerVal	An instance of a server integer value.
XsIntSeqVal	A sequence of server int values.
XsIntVal	An instance of a server int value.
XsLongSeqVal	A sequence of server long values.
XsLongVal	An instance of a server long value.
XsNonNegativeIntegerSeqVal	A sequence of non-negative integer values.
XsNonNegativeIntegerVal	An instance of a server non-negative integer value.
XsNumericSeqVal	A sequence of server numeric values.
XsNumericVal	An instance of a server numeric value.
XsQNameSeqVal	A sequence of server qualified name values.
XsQNameVal	An instance of a server qualified name value.
XsShortSeqVal	A sequence of server short values.
XsShortVal	An instance of a server short value.
XsStringSeqVal	A sequence of server string values.
XsStringVal	An instance of a server string value.
XsTimeSeqVal	A sequence of server time values.
XsTimeVal	An instance of a server time value.
XsUnsignedByteSeqVal	A sequence of server unsigned byte values.
XsUnsignedByteVal	An instance of a server unsigned byte value.
XsUnsignedIntSeqVal	A sequence of server unsigned int values.
XsUnsignedIntVal	An instance of a server unsigned int value.
XsUnsignedLongSeqVal	A sequence of server unsigned long values.
XsUnsignedLongVal	An instance of a server unsigned long value.
XsUnsignedShortSeqVal	A sequence of server unsigned short values.
XsUnsignedShortVal	An instance of a server unsigned short value.
XsUntypedAtomicSeqVal	A sequence of server untyped atomic values.
XsUntypedAtomicVal	An instance of a server untyped atomic value.
XsYearMonthDurationSeqVal	A sequence of server year-month duration values.
XsYearMonthDurationVal	An instance of a server year-month duration value.

Enum Summary

Enum	Description
PlanSearchOptions.ScoreMethod
PlanTripleOption	An option controlling whether to check for duplicate triples (which is more expensive) or to process all triples when reading triples for a row pipeline.
PlanValueOption	An option controlling whether to calculate over all values including duplicates or over distinct values for an aggregate expression in a row pipeline.

Package com.marklogic.client.type Description

The package provides interfaces specifying the type of an expression or value as passed to a PlanBuilder method or returned from a RowRecord method.