| 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.row |
The package provides classes for sending plan requests to and
processing row responses from 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 | Description |
|---|---|---|
abstract PlanExprCol |
PlanBuilder.as(PlanColumn column,
ServerExpression expression) |
This function defines a column by assigning the value of an expression over the rows in the row set.
|
abstract PlanExprCol |
PlanBuilder.as(java.lang.String column,
ServerExpression expression) |
This function defines a column by assigning the value of an expression over the rows in the row set.
|
PlanExprCol |
RdtExpr.maskDeterministic(PlanColumn column) |
Redacts a column with string values by replacing each value with deterministic masking text.
|
PlanExprCol |
RdtExpr.maskDeterministic(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with string values by replacing each value with deterministic masking text.
|
PlanExprCol |
RdtExpr.maskRandom(PlanColumn column) |
Redacts a column with string values by replacing each value with random masking text.
|
PlanExprCol |
RdtExpr.maskRandom(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with string values by replacing each value with random masking text.
|
PlanExprCol |
RdtExpr.redactDatetime(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with date or datetime values either by masking part
of the existing value or by generating a random value.
|
PlanExprCol |
RdtExpr.redactEmail(PlanColumn column) |
Redacts a column with email address string
that conforms to the pattern
name@domain. |
PlanExprCol |
RdtExpr.redactEmail(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with email address string
that conforms to the pattern
name@domain. |
PlanExprCol |
RdtExpr.redactIpv4(PlanColumn column) |
Redacts a column with IPv4 address string that conforms to a pattern with
four blocks of 1-3 decimal digits separated by period (.) where the value of each block
of digits is less than or equal to 255 as in
123.201.098.112 and
123.45.678.0. |
PlanExprCol |
RdtExpr.redactIpv4(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with IPv4 address string that conforms to a pattern with
four blocks of 1-3 decimal digits separated by period (.) where the value of each block
of digits is less than or equal to 255 as in
123.201.098.112 and
123.45.678.0. |
PlanExprCol |
RdtExpr.redactNumber(PlanColumn column) |
Redacts a column by generating a random number within a configurable range
either as a numeric data type or as a formatted string.
|
PlanExprCol |
RdtExpr.redactNumber(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column by generating a random number within a configurable range
either as a numeric data type or as a formatted string.
|
PlanExprCol |
RdtExpr.redactRegex(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a string column by applying a regular expression.
|
PlanExprCol |
RdtExpr.redactUsPhone(PlanColumn column) |
Redacts a column with a 10-digit US phone number string
by generating random numbers or replacing numbers with a masking character.
|
PlanExprCol |
RdtExpr.redactUsPhone(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with a 10-digit US phone number string
by generating random numbers or replacing numbers with a masking character.
|
PlanExprCol |
RdtExpr.redactUsSsn(PlanColumn column) |
Redacts a column with a 9-digit US SSN (Social Security Number) string
by generating random numbers or replacing numbers with a masking character.
|
PlanExprCol |
RdtExpr.redactUsSsn(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with a 9-digit US SSN (Social Security Number) string
by generating random numbers or replacing numbers with a masking character.
|
| Modifier and Type | Method | Description |
|---|---|---|
abstract PlanAggregateCol |
PlanBuilder.arrayAggregate(PlanColumn name,
PlanExprCol column) |
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.arrayAggregate(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
|
abstract PlanSortKey |
PlanBuilder.asc(PlanExprCol column) |
This function sorts the specified columndef in ascending order.
|
abstract PlanAggregateCol |
PlanBuilder.avg(PlanColumn name,
PlanExprCol column) |
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.avg(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanNamedGroup |
PlanBuilder.bucketGroup(XsStringVal name,
PlanExprCol key,
XsAnyAtomicTypeSeqVal boundaries) |
This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
|
abstract PlanNamedGroup |
PlanBuilder.bucketGroup(XsStringVal name,
PlanExprCol key,
XsAnyAtomicTypeSeqVal boundaries,
XsStringVal collation) |
This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
|
abstract PlanExprColSeq |
PlanBuilder.colSeq(PlanExprCol... col) |
Constructs a sequence from multiple col values to pass as a parameter to an operation.
|
abstract PlanAggregateCol |
PlanBuilder.count(PlanColumn name,
PlanExprCol column) |
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
PlanBuilder.count(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function counts the rows where the specified input column has a value.
|
abstract PlanSortKey |
PlanBuilder.desc(PlanExprCol column) |
This function sorts the specified columndef in descending order.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.facetBy(PlanNamedGroupSeq keys,
PlanExprCol countCol) |
This method counts values for multiple grouping key columns.
|
PlanBuilder.AccessPlan |
PlanBuilderBase.fromSearch(CtsQueryExpr query,
PlanExprCol... columns) |
Supports document matching and relevance by constructing rows with the document fragment id and
columns for relevance factors.
|
PlanAggregateCol |
PlanBuilderBase.groupConcat(PlanColumn name,
PlanExprCol column) |
This function concatenates the non-null values of the column for the rows in the group or row set.
|
PlanAggregateCol |
PlanBuilderBase.groupConcat(PlanColumn name,
PlanExprCol column,
PlanGroupConcatOptionSeq options) |
This function concatenates the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.groupKey(PlanColumn name,
PlanExprCol column) |
|
abstract PlanAggregateCol |
PlanBuilder.hasGroupKey(PlanColumn name,
PlanExprCol column) |
This aggregate function adds a flag to a grouped row specifying whether a column acted as a grouping key for the row.
|
abstract PlanAggregateCol |
PlanBuilder.max(PlanColumn name,
PlanExprCol column) |
This function gets the largest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.max(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function gets the largest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.min(PlanColumn name,
PlanExprCol column) |
This function gets the smallest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.min(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function gets the smallest non-null value of the column for the rows in the group or row set.
|
abstract PlanJoinKey |
PlanBuilder.on(PlanExprCol left,
PlanExprCol right) |
Specifies an equijoin using one columndef each from the left and right rows.
|
abstract PlanAggregateCol |
PlanBuilder.sample(PlanColumn name,
PlanExprCol column) |
This function randomly selects one non-null value of the column from the rows in the group or row set.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.select(PlanExprCol... columns) |
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
|
abstract PlanAggregateCol |
PlanBuilder.sequenceAggregate(PlanColumn name,
PlanExprCol column) |
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sequenceAggregate(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sum(PlanColumn name,
PlanExprCol column) |
This function adds the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sum(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function adds the non-null values of the column for the rows in the group or row set.
|
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.
|
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
RowRecord.getBoolean(PlanExprCol col) |
Gets the value of a column with an xs:boolean schema data type
as a Java boolean primitive value.
|
byte |
RowRecord.getByte(PlanExprCol col) |
Gets the value of a column with an xs:byte schema data type
as a Java byte primitive value.
|
com.fasterxml.jackson.databind.JsonNode |
RowRecord.getContainer(PlanExprCol col) |
|
<T extends JSONReadHandle> |
RowRecord.getContainer(PlanExprCol col,
T containerHandle) |
|
<T> T |
RowRecord.getContainerAs(PlanExprCol col,
java.lang.Class<T> as) |
|
<T extends AbstractReadHandle> |
RowRecord.getContent(PlanExprCol col,
T contentHandle) |
Gets the content of a column with a document or other
content node value.
|
<T> T |
RowRecord.getContentAs(PlanExprCol col,
java.lang.Class<T> as) |
Gets the content of a column with a document or other
content node value.
|
Format |
RowRecord.getContentFormat(PlanExprCol col) |
Identifies the format where a column has a document or
other content node value in the row instead of an atomic value.
|
java.lang.String |
RowRecord.getContentMimetype(PlanExprCol col) |
Identifies the format where a column has a document or
other content node value in the row instead of an atomic value.
|
java.lang.String |
RowRecord.getDatatype(PlanExprCol col) |
Identifies the server data type for a column.
|
double |
RowRecord.getDouble(PlanExprCol col) |
Gets the value of a column with an xs:double schema data type
as a Java double primitive value.
|
float |
RowRecord.getFloat(PlanExprCol col) |
Gets the value of a column with an xs:float schema data type
as a Java float primitive value.
|
int |
RowRecord.getInt(PlanExprCol col) |
Gets the value of a column with an xs:int schema data type
as a Java int primitive value.
|
RowRecord.ColumnKind |
RowRecord.getKind(PlanExprCol col) |
Identifies whether the value of a column is an atomic value,
a document or other content structure, or a null.
|
long |
RowRecord.getLong(PlanExprCol col) |
Gets the value of a column with an xs:long schema data type
as a Java long primitive value.
|
short |
RowRecord.getShort(PlanExprCol col) |
Gets the value of a column with an xs:short schema data type
as a Java short primitive value.
|
java.lang.String |
RowRecord.getString(PlanExprCol col) |
Gets the value of a column with an xs:string schema data type
as a Java String literal value.
|
<T extends XsAnyAtomicTypeVal> |
RowRecord.getValueAs(PlanExprCol col,
java.lang.Class<T> as) |
Gets the value of a column with an atomic schema data type.
|
| Modifier and Type | Interface | Description |
|---|---|---|
interface |
PlanColumn |
An instance of a column expression returned by a col() call
in a row pipeline.
|
interface |
PlanSystemColumn |
An instance of a fragment id, graph id, or other system column
for a row pipeline.
|
Copyright © 2013-2021 MarkLogic Corporation.