Interface BinaryDocumentManager

All Superinterfaces:

DocumentManager<BinaryReadHandle,BinaryWriteHandle>

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Interface

  Description

  static enum 

  BinaryDocumentManager.MetadataExtraction

  The MetadataExtraction enumeration identifies whether properties are extracted from binary documents to metadata properties on the binary document, to a separate XHTML document, or not at all.

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

  DocumentManager.Metadata

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  BinaryDocumentManager.MetadataExtraction

  getMetadataExtraction()

  Returns the metadata extraction policy.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length)

  Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length, Transaction transaction)

  Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length)

  Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction)

  Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, T contentHandle, long start, long length)

  Reads a range of bytes from the content of a binary database document in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, T contentHandle, long start, long length, Transaction transaction)

  Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, long start, long length)

  Reads a range of bytes from the content of a binary database document as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction)

  Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length)

  Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length, Transaction transaction)

  Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length)

  Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction)

  Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(String docId, T contentHandle, long start, long length)

  Reads a range of bytes from the content of a binary database document in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(String docId, T contentHandle, long start, long length, Transaction transaction)

  Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

  <T extends BinaryReadHandle>
T

  read(String docId, T contentHandle, ServerTransform transform, long start, long length)

  Reads a range of bytes from the content of a binary database document as transformed on the server.

  <T extends BinaryReadHandle>
T

  read(String docId, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction)

  Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.

  <T> T

  readAs(String docId, DocumentMetadataReadHandle metadataHandle, Class<T> as, long start, long length)

  Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.

  <T> T

  readAs(String docId, Class<T> as, long start, long length)

  Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.

  void

  setMetadataExtraction(BinaryDocumentManager.MetadataExtraction policy)

  Specifies the metadata extraction policy for binary documents.

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

  clearMetadataCategories, create, create, create, create, create, create, create, create, createAs, createAs, createAs, createAs, delete, delete, delete, delete, delete, delete, exists, exists, getContentFormat, getMetadataCategories, getNonDocumentFormat, getPageLength, getReadTransform, getSearchView, getWriteTransform, newDescriptor, newDocumentUriTemplate, newPatchBuilder, newWriteSet, patch, patch, patch, patch, patchAs, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, readAs, readAs, readAs, readAs, readMetadata, readMetadata, readMetadata, readMetadata, search, search, search, search, search, search, search, search, search, setContentFormat, setMetadataCategories, setMetadataCategories, setNonDocumentFormat, setPageLength, setReadTransform, setSearchView, setWriteTransform, startLogging, stopLogging, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeAs, writeAs, writeAs, writeAs, writeDefaultMetadata, writeDefaultMetadata, writeDefaultMetadata, writeDefaultMetadata, writeMetadata, writeMetadata

• Method Details

  • readAs

    <T> T readAs(String docId, Class<T> as, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary database document in the representation specified by the IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of object that will be returned by the handle registered for it

    Parameters:

    docId - the URI identifier for the document

    as - the IO class for reading the range of bytes

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    an object of the IO class with the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • readAs

    <T> T readAs(String docId, DocumentMetadataReadHandle metadataHandle, Class<T> as, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary database document in the representation specified by the IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Type Parameters:

    T - the type of object that will be returned by the handle registered for it

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for reading the metadata of the document

    as - the IO class for reading the range of bytes

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    an object of the IO class with the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary database document in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary database document as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary database document in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary database document as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary database document as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary database document as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • read

    <T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
    Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.

    Type Parameters:

    T - the type of BinaryReadHandle to return

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    metadataHandle - a handle for reading the metadata of the document

    contentHandle - a handle for reading the content of the document

    transform - a server transform to modify the document content

    start - the zero-based index of the first byte in the range

    length - the number of bytes in the range

    transaction - a open transaction under which the document may have been created or deleted

    Returns:

    the range of bytes

    Throws:

    ResourceNotFoundException

    ForbiddenUserException

    FailedRequestException

  • getMetadataExtraction

    BinaryDocumentManager.MetadataExtraction getMetadataExtraction()
    Returns the metadata extraction policy.

    Returns:

    the policy for extracting metadata

  • setMetadataExtraction

    void setMetadataExtraction(BinaryDocumentManager.MetadataExtraction policy)
    Specifies the metadata extraction policy for binary documents.

    Parameters:

    policy - the policy for extracting metadata

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