Interface DocumentDescriptor

All Superinterfaces:

ContentDescriptor

All Known Subinterfaces:

TemporalDescriptor

• Field Summary

  Fields
  Modifier and Type

  Field

  Description

  static final long

  UNKNOWN_VERSION

  Indicates that the version of the database document is not known.

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

  UNKNOWN_LENGTH

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  String

  getUri()

  Returns the URI identifier for the database document.

  long

  getVersion()

  Returns the version for the database document.

  void

  setUri(String uri)

  Specifies the URI identifier for a database document.

  void

  setVersion(long version)

  Specifies the document version.

  DocumentDescriptor

  withFormat(Format format)

  Specifies the format for a database document and returns the descriptor object

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

  getByteLength, getFormat, getMimetype, setByteLength, setFormat, setMimetype

• Field Details

  • UNKNOWN_VERSION

    static final long UNKNOWN_VERSION
    Indicates that the version of the database document is not known.

    See Also:

    • Constant Field Values

• Method Details

  • getUri

    String getUri()
    Returns the URI identifier for the database document.

    Returns:

    the document URI

  • setUri

    void setUri(String uri)
    Specifies the URI identifier for a database document.

    Parameters:

    uri - the document URI

  • withFormat

    DocumentDescriptor withFormat(Format format)
    Specifies the format for a database document and returns the descriptor object

    Parameters:

    format - the document format

    Returns:

    the descriptor object

  • getVersion

    long getVersion()
    Returns the version for the database document. Each update creates a new version of a document. Version numbering can be used to refresh a client document cache or for optimistic locking. Use ServerConfigurationManager to enable versioning on content.

    Returns:

    the document version number

  • setVersion

    void setVersion(long version)
    Specifies the document version. Checking the existence of a document or reading a document specifies the document version if you have enabled versioning on content.

    Parameters:

    version - the document version number

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