Class XMLStreamReaderHandle

All Implemented Interfaces:

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

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  XMLStreamReaderHandle()

  Zero-argument constructor.

  XMLStreamReaderHandle(XMLStreamReader content)

  Initializes the handle with a StAX stream reader for the content.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  XMLStreamReader

  bytesToContent(byte[] buffer)

  Converts a byte serialization to the content representation.

  void

  close()

  Closes the XMLStreamReader and the InputStream, if any, used to populate the XMLStreamReader.

  byte[]

  contentToBytes(XMLStreamReader content)

  Converts the content representation to bytes.

  void

  fromBuffer(byte[] buffer)

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

  XMLStreamReader

  get()

  Returns an XML Stream Reader for reading a resource from the database as a StAX pull stream.

  Class<XMLStreamReader>

  getContentClass()

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

  XMLInputFactory

  getFactory()

  Returns the factory for parsing StAX streams.

  XMLResolver

  getResolver()

  Returns the resolver for resolving references while parsing the event reader source.

  protected XMLInputFactory

  makeXMLInputFactory()

   

  XMLStreamReader[]

  newArray(int length)

  Constructs an array for the handled content representation

  static ContentHandleFactory

  newFactory()

  Creates a factory to create an XMLStreamReaderHandle instance for a StAX stream reader.

  XMLStreamReaderHandle

  newHandle()

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

  XMLStreamReaderHandle[]

  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 OutputStreamSender

  sendContent()

   

  void

  set(XMLStreamReader content)

  Assigns the stream reader for the content.

  void

  setFactory(XMLInputFactory factory)

  Specifies the factory for parsing StAX streams.

  void

  setFormat(Format format)

  Restricts the format to XML.

  void

  setResolver(XMLResolver resolver)

  Specifies the resolver for resolving references while parsing the event reader source.

  byte[]

  toBuffer()

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

  XMLStreamReader

  toContent(InputStream serialization)

  Converts the serialization to the content representation.

  String

  toString()

  Buffers the StAX stream and returns the buffer as an XML string.

  XMLStreamReaderHandle

  with(XMLStreamReader content)

  Assigns an stream reader for the content and returns the handle as a fluent convenience.

  XMLStreamReaderHandle

  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

  newHandle, resendableHandleFor

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

  resendableHandleFor

• Constructor Details

  • XMLStreamReaderHandle

    public XMLStreamReaderHandle()
    Zero-argument constructor.

  • XMLStreamReaderHandle

    public XMLStreamReaderHandle(XMLStreamReader content)
    Initializes the handle with a StAX stream reader for the content.

    Parameters:

    content - a StAX stream reader

• Method Details

  • newFactory

    public static ContentHandleFactory newFactory()
    Creates a factory to create an XMLStreamReaderHandle instance for a StAX stream reader.

    Returns:

    the factory

  • getResolver

    public XMLResolver getResolver()
    Returns the resolver for resolving references while parsing the event reader source.

    Returns:

    the resolver

  • setResolver

    public void setResolver(XMLResolver resolver)
    Specifies the resolver for resolving references while parsing the event reader source.

    Parameters:

    resolver - the reference resolver

  • get

    public XMLStreamReader get()
    Returns an XML Stream Reader for reading a resource from the database as a StAX pull stream. When finished with the stream reader, call close() to release the response.

    Specified by:

    get in interface ContentHandle<XMLStreamReader>

    Returns:

    the XML stream reader

  • set

    public void set(XMLStreamReader content)
    Assigns the stream reader for the content.

    Specified by:

    set in interface ContentHandle<XMLStreamReader>

    Parameters:

    content - a StAX stream reader

  • with

    public XMLStreamReaderHandle with(XMLStreamReader content)
    Assigns an stream reader for the content and returns the handle as a fluent convenience.

    Parameters:

    content - a StAX stream reader

    Returns:

    this handle

  • getContentClass

    public Class<XMLStreamReader> 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<XMLStreamReader>

    Returns:

    the class for the handled content

  • newHandle

    public XMLStreamReaderHandle 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<XMLStreamReader,InputStream>

    Specified by:

    newHandle in interface ContentHandle<XMLStreamReader>

    Returns:

    the new handle

  • newHandleArray

    public XMLStreamReaderHandle[] 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<XMLStreamReader,InputStream>

    Parameters:

    length - the number of positions in the array

    Returns:

    the uninitialized array

  • newArray

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

    Specified by:

    newArray in interface ContentHandle<XMLStreamReader>

    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 XMLStreamReaderHandle 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

  • toContent

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

    Specified by:

    toContent in interface BufferableContentHandle<XMLStreamReader,InputStream>

    Parameters:

    serialization - a serialization of the content

    Returns:

    the content representation

  • bytesToContent

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

    Specified by:

    bytesToContent in interface BufferableContentHandle<XMLStreamReader,InputStream>

    Parameters:

    buffer - the byte serialization

    Returns:

    the content representation

  • contentToBytes

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

    Specified by:

    contentToBytes in interface BufferableContentHandle<XMLStreamReader,InputStream>

    Parameters:

    content - the content

    Returns:

    the byte serialization of the content

  • close

    public void close()
    Closes the XMLStreamReader and the InputStream, if any, used to populate the XMLStreamReader. This method or get().close() should always be called when finished with the stream reader.

    Specified by:

    close in interface AutoCloseable

    Specified by:

    close in interface Closeable

  • toString

    public String toString()
    Buffers the StAX stream and returns the buffer as an XML string.

    Overrides:

    toString in class Object

  • getFactory

    public XMLInputFactory getFactory()
    Returns the factory for parsing StAX streams.

    Returns:

    the StAX factory

  • setFactory

    public void setFactory(XMLInputFactory factory)
    Specifies the factory for parsing StAX streams.

    Parameters:

    factory - the StAX factory

  • makeXMLInputFactory

    protected XMLInputFactory makeXMLInputFactory()

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