com.marklogic.client.type

Interface PatchBuilder

public interface 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.

Method Summary

Modifier and Type	Method and Description
PatchBuilder	insertAfter(java.lang.String path, ServerExpression node) Insert a new node after another node.
PatchBuilder	insertAfter(XsStringVal path, ServerExpression node) Insert a new node after another node.
PatchBuilder	insertBefore(java.lang.String path, ServerExpression node) Insert a new node before another node.
PatchBuilder	insertBefore(XsStringVal path, ServerExpression node) Insert a new node before another node.
PatchBuilder	insertChild(java.lang.String path, ServerExpression node) Insert a node as child.
PatchBuilder	insertChild(XsStringVal path, ServerExpression node) Insert a node as child.
PatchBuilder	insertNamedChild(java.lang.String path, java.lang.String key, ServerExpression node) This method is specific for JSON and inserts a key/value pair to an object.
PatchBuilder	insertNamedChild(XsStringVal path, XsStringVal key, ServerExpression node) This method is specific for JSON and inserts a key/value pair to an object.
PatchBuilder	remove(java.lang.String path) This method deletes a document from the database.
PatchBuilder	remove(XsStringVal path) This method deletes a document from the database.
PatchBuilder	replace(java.lang.String path, ServerExpression node) Replace a node with another node.
PatchBuilder	replace(XsStringVal path, ServerExpression node) Replace a node with another node.
PatchBuilder	replaceInsertChild(java.lang.String parentPath, java.lang.String pathToReplace) Replace a child if it exist, or insert if it does not exist.
PatchBuilder	replaceInsertChild(java.lang.String parentPath, java.lang.String pathToReplace, ServerExpression node) Replace a child if it exist, or insert if it does not exist.
PatchBuilder	replaceInsertChild(XsStringVal parentPath, XsStringVal pathToReplace) Replace a child if it exist, or insert if it does not exist.
PatchBuilder	replaceInsertChild(XsStringVal parentPath, XsStringVal pathToReplace, ServerExpression node) Replace a child if it exist, or insert if it does not exist.
PatchBuilder	replaceValue(java.lang.String path, ServerExpression value) Replace the value of a path with a new value.
PatchBuilder	replaceValue(XsStringVal path, ServerExpression value) Replace the value of a path with a new value.

Method Detail

insertAfter

PatchBuilder insertAfter(java.lang.String path,
                         ServerExpression node)

Insert a new node after another node.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to insert the node after. (of item)

Returns:

a PatchBuilder object

insertAfter

PatchBuilder insertAfter(XsStringVal path,
                         ServerExpression node)

Insert a new node after another node.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to insert the node after. (of item)

Returns:

a PatchBuilder object

insertBefore

PatchBuilder insertBefore(java.lang.String path,
                          ServerExpression node)

Insert a new node before another node.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to insert the node before. (of item)

Returns:

a PatchBuilder object

insertBefore

PatchBuilder insertBefore(XsStringVal path,
                          ServerExpression node)

Insert a new node before another node.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to insert the node before. (of item)

Returns:

a PatchBuilder object

insertChild

PatchBuilder insertChild(java.lang.String path,
                         ServerExpression node)

Insert a node as child.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to insert the child. (of item)

Returns:

a PatchBuilder object

insertChild

PatchBuilder insertChild(XsStringVal path,
                         ServerExpression node)

Insert a node as child.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to insert the child. (of item)

Returns:

a PatchBuilder object

insertNamedChild

PatchBuilder insertNamedChild(java.lang.String path,
                              java.lang.String key,
                              ServerExpression node)

This method is specific for JSON and inserts a key/value pair to an object.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

key - The path which returns an JSON Object.

node - The key to insert. (of item)

Returns:

a PatchBuilder object

insertNamedChild

PatchBuilder insertNamedChild(XsStringVal path,
                              XsStringVal key,
                              ServerExpression node)

This method is specific for JSON and inserts a key/value pair to an object.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

key - The path which returns an JSON Object.

node - The key to insert. (of item)

Returns:

a PatchBuilder object

remove

PatchBuilder remove(java.lang.String path)

This method deletes a document from the database. If the document does not exist, this method does not throw an error. Delete a node.

Parameters:

path - If this column is not specified then it assumes a column 'uri' is present. This can be a string of the uri column name or an op:col. Use op:view-col or op:schema-col if you need to identify columns in the two views that have the same column name. This can also be a map object specify the uri column name.

Returns:

a PatchBuilder object

remove

PatchBuilder remove(XsStringVal path)

This method deletes a document from the database. If the document does not exist, this method does not throw an error. Delete a node.

Parameters:

path - If this column is not specified then it assumes a column 'uri' is present. This can be a string of the uri column name or an op:col. Use op:view-col or op:schema-col if you need to identify columns in the two views that have the same column name. This can also be a map object specify the uri column name.

Returns:

a PatchBuilder object

replace

PatchBuilder replace(java.lang.String path,
                     ServerExpression node)

Replace a node with another node.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to replace. (of item)

Returns:

a PatchBuilder object

replace

PatchBuilder replace(XsStringVal path,
                     ServerExpression node)

Replace a node with another node.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

node - The path to replace. (of item)

Returns:

a PatchBuilder object

replaceInsertChild

PatchBuilder replaceInsertChild(java.lang.String parentPath,
                                java.lang.String pathToReplace)

Replace a child if it exist, or insert if it does not exist.

Parameters:

parentPath - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

pathToReplace - The parent path to insert/replace.

Returns:

a PatchBuilder object

replaceInsertChild

PatchBuilder replaceInsertChild(XsStringVal parentPath,
                                XsStringVal pathToReplace)

Replace a child if it exist, or insert if it does not exist.

Parameters:

parentPath - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

pathToReplace - The parent path to insert/replace.

Returns:

a PatchBuilder object

replaceInsertChild

PatchBuilder replaceInsertChild(java.lang.String parentPath,
                                java.lang.String pathToReplace,
                                ServerExpression node)

Replace a child if it exist, or insert if it does not exist.

Parameters:

parentPath - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

pathToReplace - The parent path to insert/replace.

node - The path to insert/replace which is relative to parent-path. (of item)

Returns:

a PatchBuilder object

replaceInsertChild

PatchBuilder replaceInsertChild(XsStringVal parentPath,
                                XsStringVal pathToReplace,
                                ServerExpression node)

Replace a child if it exist, or insert if it does not exist.

Parameters:

parentPath - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

pathToReplace - The parent path to insert/replace.

node - The path to insert/replace which is relative to parent-path. (of item)

Returns:

a PatchBuilder object

replaceValue

PatchBuilder replaceValue(java.lang.String path,
                          ServerExpression value)

Replace the value of a path with a new value.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

value - The path to replace the value. (of item)

Returns:

a PatchBuilder object

replaceValue

PatchBuilder replaceValue(XsStringVal path,
                          ServerExpression value)

Replace the value of a path with a new value.

Parameters:

path - The Patch Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.

value - The path to replace the value. (of item)

Returns:

a PatchBuilder object