Class DocumentMetadataHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, OutputStreamSender

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Class

  Description

  static enum 

  DocumentMetadataHandle.Capability

  A document operation restricted to users with a role.

  static interface 

  DocumentMetadataHandle.DocumentCollections

  Represents the collections for a database document.

  static interface 

  DocumentMetadataHandle.DocumentMetadataValues

  Represents the metadata-values for a database document.

  static interface 

  DocumentMetadataHandle.DocumentPermissions

  Represents the permissions for a database document.

  static interface 

  DocumentMetadataHandle.DocumentProperties

  Represents the properties for a database document.

• Field Summary

  Fields inherited from interface com.marklogic.client.document.ContentDescriptor

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  DocumentMetadataHandle()

  Zero-argument constructor.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  void

  fromBuffer(byte[] buffer)

  fromBuffer() populates DocumentMetadataHandle from a byte array buffer.

  DocumentMetadataHandle.DocumentCollections

  getCollections()

  Returns a container for the collections for the document as read from the server or modified locally.

  DocumentMetadataHandle.DocumentMetadataValues

  getMetadataValues()

  Returns a container for the metadata-values for the document as read from the server or modified locally.

  DocumentMetadataHandle.DocumentPermissions

  getPermissions()

  Returns a container for the permissions on the document as read from the server or modified locally.

  DocumentMetadataHandle.DocumentProperties

  getProperties()

  Returns a container for the properties of the document as read from the server or modified locally.

  int

  getQuality()

  Returns the quality of the document.

  protected Class<InputStream>

  receiveAs()

   

  protected void

  receiveContent(InputStream content)

   

  protected OutputStreamSender

  sendContent()

   

  void

  setCollections(DocumentMetadataHandle.DocumentCollections collections)

  Locally assigns a container with document collections.

  void

  setFormat(Format format)

  Restricts the format used parsing and serializing the metadata.

  void

  setMetadataValues(DocumentMetadataHandle.DocumentMetadataValues metadataValues)

  Locally assigns a container with document metadata-values.

  void

  setPermissions(DocumentMetadataHandle.DocumentPermissions permissions)

  Locally assigns a container with document permissions.

  void

  setProperties(DocumentMetadataHandle.DocumentProperties properties)

  Locally assigns a container with document properties.

  void

  setQuality(int quality)

  Specifies the quality of the document, which affects search weighting.

  byte[]

  toBuffer()

  Copies the content of the handle to a byte array buffer encoded in UTF-8.

  String

  toString()

  Returns the document metadata as an XML string.

  DocumentMetadataHandle

  withCollections(String... collections)

  Locally adds the collections to the current collections for the document.

  DocumentMetadataHandle

  withMetadataValue(String key, String value)

  Locally adds the metadata-value to the current metadata-values for the document.

  DocumentMetadataHandle

  withPermission(String role, DocumentMetadataHandle.Capability... capabilities)

  Locally adds the role and its capabilities to the current permissions for the document.

  DocumentMetadataHandle

  withProperty(String name, Object value)

  Locally adds the property name and value to the current properties for the document.

  DocumentMetadataHandle

  withProperty(QName name, Object value)

  Locally adds the property name and value to the current properties for the document.

  DocumentMetadataHandle

  withQuality(int quality)

  Locally specifies the match quality for the document.

  void

  write(OutputStream out)

  Implements a callback to write content to the provided output stream for sending to the database server.

  Methods inherited from class com.marklogic.client.io.BaseHandle

  getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

  Methods inherited from class com.marklogic.client.impl.HandleImplementation

  getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • DocumentMetadataHandle

    public DocumentMetadataHandle()
    Zero-argument constructor.

• Method Details

  • getCollections

    public DocumentMetadataHandle.DocumentCollections getCollections()
    Returns a container for the collections for the document as read from the server or modified locally.

    Returns:

    the document collections

  • setCollections

    public void setCollections(DocumentMetadataHandle.DocumentCollections collections)
    Locally assigns a container with document collections. Ordinarily, you never change the container but, instead, modify the collections stored by the container.

    Parameters:

    collections - the document collections

  • withCollections

    public DocumentMetadataHandle withCollections(String... collections)
    Locally adds the collections to the current collections for the document.

    Parameters:

    collections - the document collections

    Returns:

    the document metadata handle

  • getPermissions

    public DocumentMetadataHandle.DocumentPermissions getPermissions()
    Returns a container for the permissions on the document as read from the server or modified locally.

    Returns:

    the document permissions

  • setPermissions

    public void setPermissions(DocumentMetadataHandle.DocumentPermissions permissions)
    Locally assigns a container with document permissions. Ordinarily, you never change the container but, instead, modify the permissions stored by the container.

    Parameters:

    permissions - the document permissions

  • withPermission

    public DocumentMetadataHandle withPermission(String role, DocumentMetadataHandle.Capability... capabilities)
    Locally adds the role and its capabilities to the current permissions for the document.

    Parameters:

    role - the role for users permitted to access the document

    capabilities - the permissions to be granted to users with the role

    Returns:

    the document metadata handle

  • getProperties

    public DocumentMetadataHandle.DocumentProperties getProperties()
    Returns a container for the properties of the document as read from the server or modified locally.

    Returns:

    the document properties

  • setProperties

    public void setProperties(DocumentMetadataHandle.DocumentProperties properties)
    Locally assigns a container with document properties. Ordinarily, you never change the container but, instead, modify the properties stored by the container.

    Parameters:

    properties - the document properties

  • withProperty

    public DocumentMetadataHandle withProperty(QName name, Object value)
    Locally adds the property name and value to the current properties for the document.

    Parameters:

    name - the namespaced QName identifying the property

    value - the value of the property

    Returns:

    the document metadata handle

  • withProperty

    public DocumentMetadataHandle withProperty(String name, Object value)
    Locally adds the property name and value to the current properties for the document.

    Parameters:

    name - the simple string name identifying the property

    value - the value of the property

    Returns:

    the document metadata handle

  • getQuality

    public int getQuality()
    Returns the quality of the document.

    Returns:

    the document quality

  • setQuality

    public void setQuality(int quality)
    Specifies the quality of the document, which affects search weighting.

    Parameters:

    quality - the document quality

  • withQuality

    public DocumentMetadataHandle withQuality(int quality)
    Locally specifies the match quality for the document.

    Parameters:

    quality - the document quality

    Returns:

    the document metadata handle

  • getMetadataValues

    public DocumentMetadataHandle.DocumentMetadataValues getMetadataValues()
    Returns a container for the metadata-values for the document as read from the server or modified locally.

    Returns:

    the document metadata-values

  • setMetadataValues

    public void setMetadataValues(DocumentMetadataHandle.DocumentMetadataValues metadataValues)
    Locally assigns a container with document metadata-values. Ordinarily, you never change the container but, instead, modify the metadata-values stored by the container.

    Parameters:

    metadataValues - the document metadata-values

  • withMetadataValue

    public DocumentMetadataHandle withMetadataValue(String key, String value)
    Locally adds the metadata-value to the current metadata-values for the document.

    Parameters:

    key - the key of metadata-value

    value - the value of metadata-value

    Returns:

    the document metadata handle

  • setFormat

    public void setFormat(Format format)
    Restricts the format used parsing and serializing the metadata.

    Specified by:

    setFormat in interface ContentDescriptor

    Overrides:

    setFormat in class BaseHandle<InputStream,OutputStreamSender>

    Parameters:

    format - the format of the content

  • fromBuffer

    public void fromBuffer(byte[] buffer)
    fromBuffer() populates DocumentMetadataHandle from a byte array buffer. The buffer must store document metadata in XML format in the UTF-8 encoding.

    Specified by:

    fromBuffer in interface BufferableHandle

    Parameters:

    buffer - the byte array

  • toBuffer

    public byte[] toBuffer()
    Description copied from interface: BufferableHandle
    Copies the content of the handle to a byte array buffer encoded in UTF-8.

    Specified by:

    toBuffer in interface BufferableHandle

    Returns:

    the byte array

  • toString

    public String toString()
    Returns the document metadata as an XML string.

    Overrides:

    toString in class Object

  • receiveAs

    protected Class<InputStream> receiveAs()

    Overrides:

    receiveAs in class com.marklogic.client.impl.HandleImplementation<InputStream,OutputStreamSender>

  • receiveContent

    protected void receiveContent(InputStream content)

    Overrides:

    receiveContent in class com.marklogic.client.impl.HandleImplementation<InputStream,OutputStreamSender>

  • sendContent

    protected OutputStreamSender sendContent()

    Overrides:

    sendContent in class com.marklogic.client.impl.HandleImplementation<InputStream,OutputStreamSender>

  • write

    public void write(OutputStream out) throws IOException
    Description copied from interface: OutputStreamSender
    Implements a callback to write content to the provided output stream for sending to the database server.

    Specified by:

    write in interface OutputStreamSender

    Parameters:

    out - the output stream receiving the content

    Throws:

    IOException - if io problems arise

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