Class IncrementalWriteFilter.Builder

Enclosing class:

IncrementalWriteFilter

• Constructor Summary

  Constructors
  Constructor

  Description

  Builder()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  IncrementalWriteFilter

  build()

   

  IncrementalWriteFilter.Builder

  canonicalizeJson(boolean canonicalizeJson)

   

  IncrementalWriteFilter.Builder

  fromView(String schemaName, String viewName)

  Configures the filter to use a TDE view for retrieving hash values instead of field range indexes.

  IncrementalWriteFilter.Builder

  hashKeyName(String keyName)

   

  IncrementalWriteFilter.Builder

  jsonExclusions(String... jsonPointers)

   

  IncrementalWriteFilter.Builder

  onDocumentsSkipped(Consumer<DocumentWriteOperation[]> skippedDocumentsConsumer)

   

  IncrementalWriteFilter.Builder

  timestampKeyName(String keyName)

   

  IncrementalWriteFilter.Builder

  xmlExclusions(String... xpathExpressions)

   

  IncrementalWriteFilter.Builder

  xmlNamespaces(Map<String,String> namespaces)

   

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • Builder

    public Builder()

• Method Details

  • hashKeyName

    public IncrementalWriteFilter.Builder hashKeyName(String keyName)

    Parameters:

    keyName - the name of the MarkLogic metadata key that will hold the hash value; defaults to "incrementalWriteHash".

  • timestampKeyName

    public IncrementalWriteFilter.Builder timestampKeyName(String keyName)

    Parameters:

    keyName - the name of the MarkLogic metadata key that will hold the timestamp value; defaults to null, which means no timestamp will be stored.

  • canonicalizeJson

    public IncrementalWriteFilter.Builder canonicalizeJson(boolean canonicalizeJson)

    Parameters:

    canonicalizeJson - whether to canonicalize JSON content before hashing; defaults to true. Delegates to https://github.com/erdtman/java-json-canonicalization for canonicalization.

  • onDocumentsSkipped

    public IncrementalWriteFilter.Builder onDocumentsSkipped(Consumer<DocumentWriteOperation[]> skippedDocumentsConsumer)

    Parameters:

    skippedDocumentsConsumer - a consumer that will be called with any documents in a batch that were skipped because their content had not changed.

  • jsonExclusions

    public IncrementalWriteFilter.Builder jsonExclusions(String... jsonPointers)

    Parameters:

    jsonPointers - JSON Pointer expressions (RFC 6901) identifying JSON properties to exclude from hash calculation. For example, "/metadata/timestamp" or "/user/lastModified".

  • xmlExclusions

    public IncrementalWriteFilter.Builder xmlExclusions(String... xpathExpressions)

    Parameters:

    xpathExpressions - XPath expressions identifying XML elements to exclude from hash calculation. For example, "//timestamp" or "//metadata/lastModified".

  • xmlNamespaces

    public IncrementalWriteFilter.Builder xmlNamespaces(Map<String,String> namespaces)

    Parameters:

    namespaces - a map of namespace prefixes to URIs for use in XPath exclusion expressions. For example, Map.of("ns", "http://example.com/ns") allows XPath like "//ns:timestamp".

  • fromView

    public IncrementalWriteFilter.Builder fromView(String schemaName, String viewName)
    Configures the filter to use a TDE view for retrieving hash values instead of field range indexes. This approach requires a TDE template to be deployed that extracts the URI and hash metadata.

    Parameters:

    schemaName - the schema name of the TDE view

    viewName - the view name of the TDE view

    Returns:

    this builder

  • build

    public IncrementalWriteFilter build()

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