Interface DocumentPatchBuilder

All Superinterfaces:

DocumentMetadataPatchBuilder

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Interface

  Description

  static enum 

  DocumentPatchBuilder.PathLanguage

  MarkLogic's REST API patch operations support two path languages for JSON, XPATH and JSONPATH.

  static enum 

  DocumentPatchBuilder.Position

  The Position enumeration indicates the location relative to the context for inserting content.

  Nested classes/interfaces inherited from interface com.marklogic.client.document.DocumentMetadataPatchBuilder

  DocumentMetadataPatchBuilder.Call, DocumentMetadataPatchBuilder.CallBuilder, DocumentMetadataPatchBuilder.Cardinality, DocumentMetadataPatchBuilder.PatchHandle

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  DocumentPatchBuilder

  delete(String selectPath)

  Specifies an operation to delete an existing JSON or XML fragment.

  DocumentPatchBuilder

  delete(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality)

  Specifies an operation to delete an existing JSON or XML fragment.

  DocumentPatchBuilder

  insertFragment(String contextPath, DocumentPatchBuilder.Position position, DocumentMetadataPatchBuilder.Cardinality cardinality, Object fragment)

  Specifies an operation to insert a new JSON or XML fragment.

  DocumentPatchBuilder

  insertFragment(String contextPath, DocumentPatchBuilder.Position position, Object fragment)

  Specifies an operation to insert a new JSON or XML fragment.

  DocumentPatchBuilder

  pathLanguage(DocumentPatchBuilder.PathLanguage pathLang)

  Specifies the language for this patch to use

  DocumentPatchBuilder

  replaceApply(String selectPath, DocumentMetadataPatchBuilder.Call call)

  Specifies a replacement operation by applying a function to an existing JSON or XML fragment.

  DocumentPatchBuilder

  replaceApply(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality, DocumentMetadataPatchBuilder.Call call)

  Specifies a replacement operation by applying a function to an existing JSON or XML fragment.

  DocumentPatchBuilder

  replaceFragment(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality, Object fragment)

  Specifies a fragment to replace an existing JSON or XML fragment.

  DocumentPatchBuilder

  replaceFragment(String selectPath, Object fragment)

  Specifies a fragment to replace an existing JSON or XML fragment.

  DocumentPatchBuilder

  replaceInsertFragment(String selectPath, String contextPath, DocumentPatchBuilder.Position position, DocumentMetadataPatchBuilder.Cardinality cardinality, Object fragment)

  Specifies a fragment to replace an existing JSON or XML fragment or (if the existing fragment doesn't exist) to insert relative to a different existing JSON or XML fragment.

  DocumentPatchBuilder

  replaceInsertFragment(String selectPath, String contextPath, DocumentPatchBuilder.Position position, Object fragment)

  Specifies a fragment to replace an existing JSON or XML fragment or (if the existing fragment doesn't exist) to insert relative to a different existing JSON or XML fragment.

  DocumentPatchBuilder

  replaceValue(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality, Object value)

  Specifies a value to replace the existing value of a JSON or XML node.

  DocumentPatchBuilder

  replaceValue(String selectPath, Object value)

  Specifies a value to replace the existing value of a JSON or XML node.

  Methods inherited from interface com.marklogic.client.document.DocumentMetadataPatchBuilder

  addCollection, addMetadataValue, addPermission, addPropertyValue, addPropertyValue, build, call, deleteCollection, deleteMetadataValue, deletePermission, deleteProperty, deleteProperty, getNamespaces, library, replaceCollection, replaceMetadataValue, replaceMetadataValueApply, replacePermission, replacePermission, replacePropertyApply, replacePropertyApply, replacePropertyValue, replacePropertyValue, replacePropertyValue, replacePropertyValue, setNamespaces, setQuality

• Method Details

  • pathLanguage

    DocumentPatchBuilder pathLanguage(DocumentPatchBuilder.PathLanguage pathLang)
    Specifies the language for this patch to use

    Parameters:

    pathLang - the language (XPath or JSONPath)

    Returns:

    the patch builder (for convenient chaining)

  • delete

    DocumentPatchBuilder delete(String selectPath)
    Specifies an operation to delete an existing JSON or XML fragment.

    Parameters:

    selectPath - the location of the JSON or XML fragment

    Returns:

    the patch builder (for convenient chaining)

  • delete

    DocumentPatchBuilder delete(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality)
    Specifies an operation to delete an existing JSON or XML fragment.

    Parameters:

    selectPath - the location of the JSON or XML fragment

    cardinality - the number of times the patch can match without error

    Returns:

    the patch builder (for convenient chaining)

  • insertFragment

    DocumentPatchBuilder insertFragment(String contextPath, DocumentPatchBuilder.Position position, Object fragment)
    Specifies an operation to insert a new JSON or XML fragment.

    Parameters:

    contextPath - the location of an existing node

    position - a location relative to the existing node

    fragment - the inserted fragment

    Returns:

    the patch builder (for convenient chaining)

  • insertFragment

    DocumentPatchBuilder insertFragment(String contextPath, DocumentPatchBuilder.Position position, DocumentMetadataPatchBuilder.Cardinality cardinality, Object fragment)
    Specifies an operation to insert a new JSON or XML fragment.

    Parameters:

    contextPath - the location of an existing node

    position - a location relative to the existing node

    cardinality - the number of times the patch can match without error

    fragment - the inserted fragment

    Returns:

    the patch builder (for convenient chaining)

  • replaceValue

    DocumentPatchBuilder replaceValue(String selectPath, Object value)
    Specifies a value to replace the existing value of a JSON or XML node.

    Parameters:

    selectPath - the location of the node with the replaced value

    value - the new value for the node

    Returns:

    the patch builder (for convenient chaining)

  • replaceValue

    DocumentPatchBuilder replaceValue(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality, Object value)
    Specifies a value to replace the existing value of a JSON or XML node.

    Parameters:

    selectPath - the location of the node with the replaced value

    cardinality - the number of times the patch can match without error

    value - the new value for the node

    Returns:

    the patch builder (for convenient chaining)

  • replaceFragment

    DocumentPatchBuilder replaceFragment(String selectPath, Object fragment)
    Specifies a fragment to replace an existing JSON or XML fragment.

    Parameters:

    selectPath - the location of the replaced node

    fragment - the replacing fragment

    Returns:

    the patch builder (for convenient chaining)

  • replaceFragment

    DocumentPatchBuilder replaceFragment(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality, Object fragment)
    Specifies a fragment to replace an existing JSON or XML fragment.

    Parameters:

    selectPath - the location of the replaced node

    cardinality - the number of times the patch can match without error

    fragment - the replacing fragment

    Returns:

    the patch builder (for convenient chaining)

  • replaceInsertFragment

    DocumentPatchBuilder replaceInsertFragment(String selectPath, String contextPath, DocumentPatchBuilder.Position position, Object fragment)
    Specifies a fragment to replace an existing JSON or XML fragment or (if the existing fragment doesn't exist) to insert relative to a different existing JSON or XML fragment. The selectPath for the replaced node may be relative to the contextPath for the insert operation.

    Parameters:

    selectPath - the location of the replaced node

    contextPath - the location of an existing node

    position - a location relative to the existing node

    fragment - the replacing or inserted fragment

    Returns:

    the patch builder (for convenient chaining)

  • replaceInsertFragment

    DocumentPatchBuilder replaceInsertFragment(String selectPath, String contextPath, DocumentPatchBuilder.Position position, DocumentMetadataPatchBuilder.Cardinality cardinality, Object fragment)
    Specifies a fragment to replace an existing JSON or XML fragment or (if the existing fragment doesn't exist) to insert relative to a different existing JSON or XML fragment. The selectPath for the replaced node may be relative to the contextPath for the insert operation.

    Parameters:

    selectPath - the location of the replaced node

    contextPath - the location of an existing node

    position - a location relative to the existing node

    cardinality - the number of times the patch can match without error

    fragment - the replacing or inserted fragment

    Returns:

    the patch builder (for convenient chaining)

  • replaceApply

    DocumentPatchBuilder replaceApply(String selectPath, DocumentMetadataPatchBuilder.Call call)
    Specifies a replacement operation by applying a function to an existing JSON or XML fragment. You must use CallBuilder to build a specification of the call.

    Parameters:

    selectPath - the location of the replaced node

    call - the specification of the function call

    Returns:

    the patch builder (for convenient chaining)

  • replaceApply

    DocumentPatchBuilder replaceApply(String selectPath, DocumentMetadataPatchBuilder.Cardinality cardinality, DocumentMetadataPatchBuilder.Call call)
    Specifies a replacement operation by applying a function to an existing JSON or XML fragment. You must use CallBuilder to build a specification of the call.

    Parameters:

    selectPath - the location of the replaced node

    cardinality - the number of times the patch can match without error

    call - the specification of the function call

    Returns:

    the patch builder (for convenient chaining)

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.