Class DOMHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<Document,InputStream>, BufferableHandle, ContentHandle<Document>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<Document,InputStream>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  DOMHandle()

  Zero-argument constructor.

  DOMHandle(Document content)

  Initializes the handle with a DOM document for the content.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Document

  bytesToContent(byte[] buffer)

  Converts a byte serialization to the content representation.

  protected <T> T

  castAs(Object result, Class<?> as)

   

  protected void

  checkContext(Node context)

   

  XPathExpression

  compileXPath(String xpathExpression)

  Compile an XPath string expression for efficient evaluation later.

  byte[]

  contentToBytes(Document content)

  Converts the content representation to bytes.

  <T> T

  evaluateXPath(String xpathExpression, Class<T> as)

  Evaluate a string XPath expression against the retrieved document.

  <T> T

  evaluateXPath(String xpathExpression, Node context, Class<T> as)

  Evaluate a string XPath expression relative to a node such as a node returned by a previous XPath expression.

  <T> T

  evaluateXPath(XPathExpression xpathExpression, Class<T> as)

  Evaluate a compiled XPath expression against the retrieved document.

  <T> T

  evaluateXPath(XPathExpression xpathExpression, Node context, Class<T> as)

  Evaluate a compiled XPath expression relative to a node such as a node returned by a previous XPath expression.

  void

  fromBuffer(byte[] buffer)

  Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.

  Document

  get()

  Returns the DOM document for the content.

  Class<Document>

  getContentClass()

  Returns the class of the handled content, which may be a base class of the actual class of a content object.

  DocumentBuilderFactory

  getFactory()

  Returns the factory for building DOM documents.

  LSResourceResolver

  getResolver()

  Returns the resolver for resolving references while parsing the document.

  XPath

  getXPathProcessor()

  Get the processor used to evaluate XPath expressions.

  Document[]

  newArray(int length)

  Constructs an array for the handled content representation

  static ContentHandleFactory

  newFactory()

  Creates a factory to create a DOMHandle instance for a DOM document.

  DOMHandle

  newHandle()

  Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

  DOMHandle[]

  newHandleArray(int length)

  Constructs an uninitialized array with the specified length with items of the same content representation.

  protected Class<InputStream>

  receiveAs()

   

  protected void

  receiveContent(InputStream content)

   

  protected QName

  returnXPathConstant(Class<?> as)

   

  protected OutputStreamSender

  sendContent()

   

  void

  set(Document content)

  Assigns a DOM document as the content.

  void

  setFactory(DocumentBuilderFactory factory)

  Specifies the factory for building DOM documents.

  void

  setFormat(Format format)

  Restricts the format to XML.

  void

  setResolver(LSResourceResolver resolver)

  Specifies the resolver for resolving references while parsing the document.

  void

  setXPathProcessor(XPath xpathProcessor)

  Specifies the processor used to evaluate XPath expressions against the document.

  byte[]

  toBuffer()

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

  Document

  toContent(InputStream serialization)

  Converts the serialization to the content representation.

  String

  toString()

  Returns the DOM document as an XML string.

  DOMHandle

  with(Document content)

  Assigns a DOM document as the content and returns the handle as a fluent convenience.

  DOMHandle

  withMimetype(String mimetype)

  Specifies the mime type of the content and returns the handle as a fluent convenience.

  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

  Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

  resendableHandleFor

  Methods inherited from interface com.marklogic.client.io.marker.ResendableContentHandle

  newHandle, resendableHandleFor

• Constructor Details

  • DOMHandle

    public DOMHandle()
    Zero-argument constructor.

  • DOMHandle

    public DOMHandle(Document content)
    Initializes the handle with a DOM document for the content.

    Parameters:

    content - a DOM document

• Method Details

  • newFactory

    public static ContentHandleFactory newFactory()
    Creates a factory to create a DOMHandle instance for a DOM document.

    Returns:

    the factory

  • getResolver

    public LSResourceResolver getResolver()
    Returns the resolver for resolving references while parsing the document.

    Returns:

    the resolver

  • setResolver

    public void setResolver(LSResourceResolver resolver)
    Specifies the resolver for resolving references while parsing the document.

    Parameters:

    resolver - the reference resolver

  • get

    public Document get()
    Returns the DOM document for the content.

    Specified by:

    get in interface ContentHandle<Document>

    Returns:

    the DOM document

  • set

    public void set(Document content)
    Assigns a DOM document as the content.

    Specified by:

    set in interface ContentHandle<Document>

    Parameters:

    content - a DOM document

  • with

    public DOMHandle with(Document content)
    Assigns a DOM document as the content and returns the handle as a fluent convenience.

    Parameters:

    content - a DOM document

    Returns:

    this handle

  • getContentClass

    public Class<Document> getContentClass()
    Description copied from interface: ContentHandle
    Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

    Specified by:

    getContentClass in interface ContentHandle<Document>

    Returns:

    the class for the handled content

  • newHandle

    public DOMHandle newHandle()
    Description copied from interface: ContentHandle
    Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

    Specified by:

    newHandle in interface BufferableContentHandle<Document,InputStream>

    Specified by:

    newHandle in interface ContentHandle<Document>

    Specified by:

    newHandle in interface ResendableContentHandle<Document,InputStream>

    Returns:

    the new handle

  • newHandleArray

    public DOMHandle[] newHandleArray(int length)
    Description copied from interface: BufferableContentHandle
    Constructs an uninitialized array with the specified length with items of the same content representation.

    Specified by:

    newHandleArray in interface BufferableContentHandle<Document,InputStream>

    Specified by:

    newHandleArray in interface ResendableContentHandle<Document,InputStream>

    Parameters:

    length - the number of positions in the array

    Returns:

    the uninitialized array

  • newArray

    public Document[] newArray(int length)
    Description copied from interface: ContentHandle
    Constructs an array for the handled content representation

    Specified by:

    newArray in interface ContentHandle<Document>

    Parameters:

    length - the size of the array (zero or more)

    Returns:

    the constructed array

  • setFormat

    public void setFormat(Format format)
    Restricts the format to XML.

    Specified by:

    setFormat in interface ContentDescriptor

    Overrides:

    setFormat in class BaseHandle<InputStream,OutputStreamSender>

    Parameters:

    format - the format of the content

  • withMimetype

    public DOMHandle withMimetype(String mimetype)
    Specifies the mime type of the content and returns the handle as a fluent convenience.

    Parameters:

    mimetype - the mime type of the content

    Returns:

    this handle

  • fromBuffer

    public void fromBuffer(byte[] buffer)
    Description copied from interface: BufferableHandle
    Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.

    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 DOM document as an XML string.

    Overrides:

    toString in class Object

  • getFactory

    public DocumentBuilderFactory getFactory() throws ParserConfigurationException
    Returns the factory for building DOM documents.

    Returns:

    the document factory

    Throws:

    ParserConfigurationException - if it occurs while initializing the new factory

  • setFactory

    public void setFactory(DocumentBuilderFactory factory)
    Specifies the factory for building DOM documents.

    Parameters:

    factory - the document factory

  • getXPathProcessor

    public XPath getXPathProcessor()
    Get the processor used to evaluate XPath expressions. You might get the XPath processor to configure it. For instance, you can configure the XPath processor to declare namespace bindings or to set a function or variable resolver.

    Returns:

    the XPath expression processor

    See Also:

    • EditableNamespaceContext

  • setXPathProcessor

    public void setXPathProcessor(XPath xpathProcessor)
    Specifies the processor used to evaluate XPath expressions against the document.

    Parameters:

    xpathProcessor - the XPath expression processor

  • evaluateXPath

    public <T> T evaluateXPath(String xpathExpression, Class<T> as) throws XPathExpressionException
    Evaluate a string XPath expression against the retrieved document. An XPath expression can return a Node or subinterface such as Element or Text, a NodeList, or a Boolean, Number, or String value.

    Type Parameters:

    T - the type to return

    Parameters:

    xpathExpression - the XPath expression as a string

    as - the type expected to be matched by the xpath

    Returns:

    the value produced by the XPath expression

    Throws:

    XPathExpressionException - if xpathExpression cannot be evaluated

  • evaluateXPath

    public <T> T evaluateXPath(String xpathExpression, Node context, Class<T> as) throws XPathExpressionException
    Evaluate a string XPath expression relative to a node such as a node returned by a previous XPath expression. An XPath expression can return a Node or subinterface such as Element or Text, a NodeList, or a Boolean, Number, or String value.

    Type Parameters:

    T - the type to return

    Parameters:

    xpathExpression - the XPath expression as a string

    context - the node for evaluating the expression

    as - the type expected to be matched by the xpath

    Returns:

    the value produced by the XPath expression

    Throws:

    XPathExpressionException - if xpathExpression cannot be evaluated

  • compileXPath

    public XPathExpression compileXPath(String xpathExpression) throws XPathExpressionException
    Compile an XPath string expression for efficient evaluation later.

    Parameters:

    xpathExpression - the XPath expression as a string

    Returns:

    the compiled XPath expression

    Throws:

    XPathExpressionException - if xpathExpression cannot be compiled

  • evaluateXPath

    public <T> T evaluateXPath(XPathExpression xpathExpression, Class<T> as) throws XPathExpressionException
    Evaluate a compiled XPath expression against the retrieved document. An XPath expression can return a Node or subinterface such as Element or Text, a NodeList, or a Boolean, Number, or String value.

    Type Parameters:

    T - the type to return

    Parameters:

    xpathExpression - an XPath expression compiled previously

    as - the type expected to be matched by the xpath

    Returns:

    the value produced by the XPath expression

    Throws:

    XPathExpressionException - if xpathExpression cannot be evaluated

  • evaluateXPath

    public <T> T evaluateXPath(XPathExpression xpathExpression, Node context, Class<T> as) throws XPathExpressionException
    Evaluate a compiled XPath expression relative to a node such as a node returned by a previous XPath expression. An XPath expression can return a Node or subinterface such as Element or Text, a NodeList, or a Boolean, Number, or String value.

    Type Parameters:

    T - the type to return

    Parameters:

    xpathExpression - an XPath expression compiled previously

    context - the node for evaluating the expression

    as - the type expected to be matched by the xpath

    Returns:

    the value produced by the XPath expression

    Throws:

    XPathExpressionException - if xpathExpression cannot be evaluated

  • checkContext

    protected void checkContext(Node context)

  • returnXPathConstant

    protected QName returnXPathConstant(Class<?> as)

  • castAs

    protected <T> T castAs(Object result, Class<?> as)

  • bytesToContent

    public Document bytesToContent(byte[] buffer)
    Description copied from interface: BufferableContentHandle
    Converts a byte serialization to the content representation.

    Specified by:

    bytesToContent in interface BufferableContentHandle<Document,InputStream>

    Parameters:

    buffer - the byte serialization

    Returns:

    the content representation

  • contentToBytes

    public byte[] contentToBytes(Document content)
    Description copied from interface: BufferableContentHandle
    Converts the content representation to bytes.

    Specified by:

    contentToBytes in interface BufferableContentHandle<Document,InputStream>

    Parameters:

    content - the content

    Returns:

    the byte serialization of the content

  • toContent

    public Document toContent(InputStream serialization)
    Description copied from interface: BufferableContentHandle
    Converts the serialization to the content representation.

    Specified by:

    toContent in interface BufferableContentHandle<Document,InputStream>

    Parameters:

    serialization - a serialization of the content

    Returns:

    the content representation

  • 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.