public interface BinaryDocumentManager extends DocumentManager<BinaryReadHandle,BinaryWriteHandle>
Modifier and Type | Interface and Description |
---|---|
static class |
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.
|
DocumentManager.Metadata
Modifier and Type | Method and Description |
---|---|
BinaryDocumentManager.MetadataExtraction |
getMetadataExtraction()
Returns the metadata extraction policy.
|
<T extends BinaryReadHandle> |
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> |
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> |
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> |
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> |
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> |
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> |
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> |
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> |
read(java.lang.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> |
read(java.lang.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> |
read(java.lang.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> |
read(java.lang.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> |
read(java.lang.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> |
read(java.lang.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> |
read(java.lang.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> |
read(java.lang.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(java.lang.String docId,
java.lang.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(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
java.lang.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.
|
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, readAs, readAs, readAs, readAs, readMetadata, readMetadata, readMetadata, readMetadata, 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, writeMetadata, writeMetadata
<T> T readAs(java.lang.String docId, java.lang.Class<T> as, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
ContentHandle
are registered.
Learn more about shortcut methodsT
- the type of object that will be returned by the handle registered for itdocId
- the URI identifier for the documentas
- the IO class for reading the range of bytesstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T> T readAs(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, java.lang.Class<T> as, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
ContentHandle
are registered.
Learn more about shortcut methodsT
- the type of object that will be returned by the handle registered for itdocId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentas
- the IO class for reading the range of bytesstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangeResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndocId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends BinaryReadHandle> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, long start, long length, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T
- the type of BinaryReadHandle to returndesc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentstart
- the zero-based index of the first byte in the rangelength
- the number of bytes in the rangetransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
BinaryDocumentManager.MetadataExtraction getMetadataExtraction()
void setMetadataExtraction(BinaryDocumentManager.MetadataExtraction policy)
policy
- the policy for extracting metadataCopyright © 2013-2018 MarkLogic Corporation.