Package com.marklogic.client.expression

Interface RdtExpr

public interface RdtExpr

The RdtExpr instance provides functions that build expressions for redacting the values of a column.

In addition to using the provided functions, you can redact any column by using PlanBuilder.as(PlanColumn, ServerExpression) to rebind the column to an expression that replaces the existing value with an altered or randomly generated value. You can also hide a column by binding the column to the null value or by projecting other columns.

Method Summary

Modifier and Type	Method	Description
PlanExprCol	maskDeterministic(PlanColumn column)	Redacts a column with string values by replacing each value with deterministic masking text.
PlanExprCol	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	maskRandom(PlanColumn column)	Redacts a column with string values by replacing each value with random masking text.
PlanExprCol	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	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	redactEmail(PlanColumn column)	Redacts a column with email address string that conforms to the pattern name@domain.
PlanExprCol	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	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	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	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	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	redactRegex(PlanColumn column, java.util.Map<java.lang.String,?> options)	Redacts a string column by applying a regular expression.
PlanExprCol	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	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	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	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.

Method Detail

maskDeterministic

PlanExprCol maskDeterministic(PlanColumn column)

Redacts a column with string values by replacing each value with deterministic masking text. That is, a specific value generates the same masked value every time the value is redacted.

Provides a client interface to the ordt:mask-deterministic server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object

maskDeterministic

PlanExprCol maskDeterministic(PlanColumn column,
                              java.util.Map<java.lang.String,?> options)

Redacts a column with string values by replacing each value with deterministic masking text. That is, a specific value generates the same masked value every time the value is redacted.

Provides a client interface to the ordt:mask-deterministic server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object

maskRandom

PlanExprCol maskRandom(PlanColumn column)

Redacts a column with string values by replacing each value with random masking text. The same value may produce a different masked value every time the value is redacted.

Provides a client interface to the ordt:mask-random server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object for the redacted column

maskRandom

PlanExprCol maskRandom(PlanColumn column,
                       java.util.Map<java.lang.String,?> options)

Redacts a column with string values by replacing each value with random masking text. The same value may produce a different masked value every time the value is redacted.

Provides a client interface to the ordt:mask-random server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactDatetime

PlanExprCol 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.

Provides a client interface to the ordt:redact-datetime server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactEmail

PlanExprCol redactEmail(PlanColumn column)

Redacts a column with email address string that conforms to the pattern name@domain.

Provides a client interface to the ordt:redact-email server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object for the redacted column

redactEmail

PlanExprCol redactEmail(PlanColumn column,
                        java.util.Map<java.lang.String,?> options)

Redacts a column with email address string that conforms to the pattern name@domain.

Provides a client interface to the ordt:redact-email server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactIpv4

PlanExprCol 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.

Provides a client interface to the ordt:redact-ipv4 server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object for the redacted column

redactIpv4

PlanExprCol 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.

Provides a client interface to the ordt:redact-ipv4 server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactNumber

PlanExprCol 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.

Provides a client interface to the ordt:redact-number server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object for the redacted column

redactNumber

PlanExprCol 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.

Provides a client interface to the ordt:redact-number server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactRegex

PlanExprCol redactRegex(PlanColumn column,
                        java.util.Map<java.lang.String,?> options)

Redacts a string column by applying a regular expression.

Provides a client interface to the ordt:redact-regex server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactUsPhone

PlanExprCol 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.

Provides a client interface to the ordt:redact-us-phone server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object for the redacted column

redactUsPhone

PlanExprCol 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.

Provides a client interface to the ordt:redact-us-phone server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column

redactUsSsn

PlanExprCol 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.

Provides a client interface to the ordt:redact-us-ssn server function.

Parameters:

column - the column to be redacted

Returns:

a PlanExprCol object for the redacted column

redactUsSsn

PlanExprCol 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.

Provides a client interface to the ordt:redact-us-ssn server function.

Parameters:

column - the column to be redacted

options - the options for redacting the column

Returns:

a PlanExprCol object for the redacted column