Class ExportToWriterListener

All Implemented Interfaces:

BatchListener<QueryBatch>, QueryBatchListener

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Class

  Description

  static interface 

  ExportToWriterListener.OutputListener

  The listener interface required by onGenerateOutput.

• Constructor Summary

  Constructors
  Constructor

  Description

  ExportToWriterListener(Writer writer)

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  void

  initializeListener(QueryBatcher queryBatcher)

  This implementation of initializeListener adds this instance of ExportToWriterListener to the two RetryListener's in this QueryBatcher so they will retry any batches that fail during the read request.

  ExportToWriterListener

  onGenerateOutput(ExportToWriterListener.OutputListener listener)

  Registers a custom listener to override the default behavior for each document which sends the document contents to the writer.

  void

  processEvent(QueryBatch batch)

  This is the method QueryBatcher calls for ExportListener to do its thing.

  ExportToWriterListener

  withMetadataCategory(DocumentManager.Metadata category)

  Adds a metadata category to retrieve with each document.

  ExportToWriterListener

  withNonDocumentFormat(Format nonDocumentFormat)

  The format for the metadata retrieved with each document.

  ExportToWriterListener

  withRecordPrefix(String prefix)

  Sets the string prefix to send to the writer before each record.

  ExportToWriterListener

  withRecordSuffix(String suffix)

  Sets the string suffix to append to the writer after each record.

  ExportToWriterListener

  withTransform(ServerTransform transform)

  Sets the server tranform to modify the document contents.

  Methods inherited from class com.marklogic.client.datamovement.ExportListener

  getBatchFailureListeners, getDocs, onDocumentPageReady, onDocumentReady, onFailure, withConsistentSnapshot

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • ExportToWriterListener

    public ExportToWriterListener(Writer writer)

• Method Details

  • initializeListener

    public void initializeListener(QueryBatcher queryBatcher)
    This implementation of initializeListener adds this instance of ExportToWriterListener to the two RetryListener's in this QueryBatcher so they will retry any batches that fail during the read request.

    Specified by:

    initializeListener in interface QueryBatchListener

    Overrides:

    initializeListener in class ExportListener

    Parameters:

    queryBatcher - the QueryBatcher which will call this Listener

  • processEvent

    public void processEvent(QueryBatch batch)
    Description copied from class: ExportListener
    This is the method QueryBatcher calls for ExportListener to do its thing. You should not need to call it.

    Specified by:

    processEvent in interface BatchListener<QueryBatch>

    Specified by:

    processEvent in interface QueryBatchListener

    Overrides:

    processEvent in class ExportListener

    Parameters:

    batch - the batch of uris and some metadata about the current status of the job

  • withRecordSuffix

    public ExportToWriterListener withRecordSuffix(String suffix)
    Sets the string suffix to append to the writer after each record.

    Parameters:

    suffix - the string suffix

    Returns:

    this instance (for method chaining)

  • withRecordPrefix

    public ExportToWriterListener withRecordPrefix(String prefix)
    Sets the string prefix to send to the writer before each record.

    Parameters:

    prefix - the string prefix

    Returns:

    this instance (for method chaining)

  • onGenerateOutput

    public ExportToWriterListener onGenerateOutput(ExportToWriterListener.OutputListener listener)
    Registers a custom listener to override the default behavior for each document which sends the document contents to the writer. This listener can choose what string to send to the writer for each document.

    Parameters:

    listener - the custom listener (or lambda expression)

    Returns:

    this instance (for method chaining)

  • withTransform

    public ExportToWriterListener withTransform(ServerTransform transform)
    Description copied from class: ExportListener
    Sets the server tranform to modify the document contents.

    Overrides:

    withTransform in class ExportListener

    Parameters:

    transform - the name of the transform already installed in the REST server

    Returns:

    this instance for method chaining

  • withMetadataCategory

    public ExportToWriterListener withMetadataCategory(DocumentManager.Metadata category)
    Adds a metadata category to retrieve with each document. The metadata will be available via DocumentRecord.getMetadata in each DocumentRecord sent to the OutputListener registered with onGenerateOutput. To specify the format for the metdata, call withNonDocumentFormat.

    Overrides:

    withMetadataCategory in class ExportListener

    Parameters:

    category - the metadata category to retrieve

    Returns:

    this instance (for method chaining)

    See Also:

    • DocumentManager.setMetadataCategories

  • withNonDocumentFormat

    public ExportToWriterListener withNonDocumentFormat(Format nonDocumentFormat)
    The format for the metadata retrieved with each document. The metadata will be available in each DocumentRecord sent to the OutputListener registered with onGenerateOutput.

    Overrides:

    withNonDocumentFormat in class ExportListener

    Parameters:

    nonDocumentFormat - the format for the metadata

    Returns:

    this instance (for method chaining)

    See Also:

    • DocumentManager.setNonDocumentFormat

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