Package | Description |
---|---|
com.marklogic.client.expression |
The package provides classes for building Optic plan pipelines and expressions
for execution on the REST server.
|
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. |
Modifier and Type | Method and Description |
---|---|
XsStringVal |
XsValue.string(java.lang.String value)
Takes a String literal and constructs an xs:string value
|
Modifier and Type | Method and Description |
---|---|
abstract PlanColumn |
PlanBuilder.col(XsStringVal column)
This method identifies a column, where the column name is unique.
|
PlanColumn |
PlanBuilder.AccessPlan.col(XsStringVal column)
This method identifies a column, where the column name is unique.
|
CtsQueryExpr |
CtsExpr.directoryQuery(XsStringSeqVal uris,
XsStringVal depth)
Returns a query matching documents in the directories with the given URIs.
|
CtsQueryExpr |
CtsExpr.elementAttributeRangeQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value)
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.elementAttributeRangeQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options)
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.elementAttributeRangeQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal weight)
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.elementRangeQuery(XsQNameSeqVal elementName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value)
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.elementRangeQuery(XsQNameSeqVal elementName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options)
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.elementRangeQuery(XsQNameSeqVal elementName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal weight)
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.fieldRangeQuery(XsStringSeqVal fieldName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value)
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.fieldRangeQuery(XsStringSeqVal fieldName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options)
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.fieldRangeQuery(XsStringSeqVal fieldName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal weight)
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
|
CtsReferenceExpr |
CtsExpr.fieldReference(XsStringVal field)
Creates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
CtsExpr.fieldReference(XsStringVal field,
XsStringSeqVal options)
Creates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
|
abstract PlanSystemColumn |
PlanBuilder.fragmentIdCol(XsStringVal column)
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
XsStringVal qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
XsStringVal qualifierName,
PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
PlanBuilder.AccessPlan |
PlanBuilderBase.fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows,
XsStringVal qualifierName)
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select)
This function dynamically constructs a row set based on an SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select,
XsStringVal qualifierName)
This function dynamically constructs a row set based on an SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(XsStringVal select)
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(XsStringVal select,
XsStringVal qualifierName)
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris,
PlanTripleOption option)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromView(XsStringVal schema,
XsStringVal view)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromView(XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromView(XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName,
PlanSystemColumn sysCols)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanSystemColumn |
PlanBuilder.graphCol(XsStringVal column)
Identifies the graph for a triple providing one or more columns for a row.
|
CtsQueryExpr |
CtsExpr.jsonPropertyRangeQuery(XsStringSeqVal propertyName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value)
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.jsonPropertyRangeQuery(XsStringSeqVal propertyName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options)
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
|
CtsQueryExpr |
CtsExpr.jsonPropertyRangeQuery(XsStringSeqVal propertyName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal weight)
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
|
CtsReferenceExpr |
CtsExpr.jsonPropertyReference(XsStringVal property)
Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
CtsExpr.jsonPropertyReference(XsStringVal property,
XsStringSeqVal options)
Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
|
CtsQueryExpr |
CtsExpr.lsqtQuery(XsStringVal temporalCollection)
Returns only documents before LSQT or a timestamp before LSQT for stable query results.
|
CtsQueryExpr |
CtsExpr.lsqtQuery(XsStringVal temporalCollection,
XsDateTimeVal timestamp)
Returns only documents before LSQT or a timestamp before LSQT for stable query results.
|
CtsQueryExpr |
CtsExpr.lsqtQuery(XsStringVal temporalCollection,
XsDateTimeVal timestamp,
XsStringSeqVal options)
Returns only documents before LSQT or a timestamp before LSQT for stable query results.
|
CtsQueryExpr |
CtsExpr.lsqtQuery(XsStringVal temporalCollection,
XsDateTimeVal timestamp,
XsStringSeqVal options,
XsDoubleVal weight)
Returns only documents before LSQT or a timestamp before LSQT for stable query results.
|
abstract PlanParamExpr |
PlanBuilder.param(XsStringVal name)
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
|
CtsQueryExpr |
CtsExpr.pathRangeQuery(XsStringSeqVal pathExpression,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value)
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
|
CtsQueryExpr |
CtsExpr.pathRangeQuery(XsStringSeqVal pathExpression,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options)
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
|
CtsQueryExpr |
CtsExpr.pathRangeQuery(XsStringSeqVal pathExpression,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal weight)
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
|
CtsReferenceExpr |
CtsExpr.pathReference(XsStringVal pathExpression)
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
CtsExpr.pathReference(XsStringVal pathExpression,
XsStringSeqVal options)
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
CtsExpr.pathReference(XsStringVal pathExpression,
XsStringSeqVal options,
MapMapExpr map)
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
|
CtsQueryExpr |
CtsExpr.periodCompareQuery(XsStringVal axis1,
XsStringVal operator,
XsStringVal axis2)
Returns a cts:query matching documents that have relevant pair of period values.
|
CtsQueryExpr |
CtsExpr.periodCompareQuery(XsStringVal axis1,
XsStringVal operator,
XsStringVal axis2,
XsStringSeqVal options)
Returns a cts:query matching documents that have relevant pair of period values.
|
CtsQueryExpr |
CtsExpr.periodRangeQuery(XsStringSeqVal axisName,
XsStringVal operator)
Returns a cts:query matching axis by name with a period value with an operator.
|
CtsQueryExpr |
CtsExpr.periodRangeQuery(XsStringSeqVal axisName,
XsStringVal operator,
CtsPeriodSeqExpr period)
Returns a cts:query matching axis by name with a period value with an operator.
|
CtsQueryExpr |
CtsExpr.periodRangeQuery(XsStringSeqVal axisName,
XsStringVal operator,
CtsPeriodSeqExpr period,
XsStringSeqVal options)
Returns a cts:query matching axis by name with a period value with an operator.
|
abstract PlanPrefixer |
PlanBuilder.prefixer(XsStringVal base)
This function factory returns a new function that takes a name parameter and returns a sem:iri, prepending the specified base URI onto the name.
|
abstract PlanFunction |
PlanBuilder.resolveFunction(XsQNameVal functionName,
XsStringVal modulePath) |
abstract PlanColumn |
PlanBuilder.schemaCol(XsStringVal schema,
XsStringVal view,
XsStringVal column)
Unambiguously identifies a column with the schema name, view name, and column name.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.select(PlanExprColSeq columns,
XsStringVal qualifierName)
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
|
abstract PlanCondition |
PlanBuilder.sqlCondition(XsStringVal expression)
This function returns a filter definition as input for a WHERE operation.
|
XsStringSeqVal |
XsValue.stringSeq(XsStringVal... values)
Takes any number of xs:string values and constructs an xs:string sequence
|
abstract PlanAggregateCol |
PlanBuilder.uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanAggregateCol |
PlanBuilder.uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function,
XsAnyAtomicTypeVal arg)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanColumn |
PlanBuilder.viewCol(XsStringVal view,
XsStringVal column)
Identifies a column where the combination of view and column name is unique.
|
Modifier and Type | Interface and Description |
---|---|
interface |
RdfLangStringVal
A sequence of RDF language string values.
|
Modifier and Type | Method and Description |
---|---|
XsStringVal[] |
XsStringSeqVal.getStringItems() |
Modifier and Type | Method and Description |
---|---|
SemIriVal |
PlanPrefixer.iri(XsStringVal name) |
Copyright © 2013-2018 MarkLogic Corporation.