Class SourceHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<Source,InputStream>, BufferableHandle, ContentHandle<Source>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StreamingContentHandle<Source,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

  SourceHandle()

  Zero-argument constructor.

  SourceHandle(Source content)

  Initializes the handle with a transform source for the content.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Source

  bytesToContent(byte[] buffer)

  Converts a byte serialization to the content representation.

  void

  close()

  Always call close() when finished with this handle -- it closes the underlying InputStream.

  byte[]

  contentToBytes(Source 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.

  Source

  get()

  Returns the transform source that produces the content.

  Class<Source>

  getContentClass()

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

  Transformer

  getTransformer()

  Returns a transformer for modifying the content.

  Source[]

  newArray(int length)

  Constructs an array for the handled content representation

  static ContentHandleFactory

  newFactory()

  Creates a factory to create a SourceHandle instance for a Transformer Source.

  SourceHandle

  newHandle()

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

  SourceHandle[]

  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(Source content)

  Assigns a transform source that produces the content.

  void

  setFormat(Format format)

  Restricts the format to XML.

  void

  setTransformer(Transformer transformer)

  Specifies a transformer for modifying the content.

  byte[]

  toBuffer()

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

  Source

  toContent(InputStream serialization)

  Converts the serialization to the content representation.

  String

  toString()

  Buffers the transform source and returns the buffer as a string.

  void

  transform(Result result)

  Transforms the source for the content output to the result.

  SourceHandle

  with(Source content)

  Assigns a transform source that produces the content and returns the handle as a fluent convenience.

  SourceHandle

  withMimetype(String mimetype)

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

  SourceHandle

  withTransformer(Transformer transformer)

  Specifies a transformer for modifying 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

  • SourceHandle

    public SourceHandle()
    Zero-argument constructor.

  • SourceHandle

    public SourceHandle(Source content)
    Initializes the handle with a transform source for the content.

    Parameters:

    content - a transform source

• Method Details

  • newFactory

    public static ContentHandleFactory newFactory()
    Creates a factory to create a SourceHandle instance for a Transformer Source.

    Returns:

    the factory

  • getTransformer

    public Transformer getTransformer()
    Returns a transformer for modifying the content.

    Returns:

    the transformer

  • setTransformer

    public void setTransformer(Transformer transformer)
    Specifies a transformer for modifying the content.

    Parameters:

    transformer - the transformer

  • withTransformer

    public SourceHandle withTransformer(Transformer transformer)
    Specifies a transformer for modifying the content and returns the handle as a fluent convenience.

    Parameters:

    transformer - the transformer

    Returns:

    this handle

  • get

    public Source get()
    Returns the transform source that produces the content.

    Specified by:

    get in interface ContentHandle<Source>

    Returns:

    the transform source

  • set

    public void set(Source content)
    Assigns a transform source that produces the content.

    Specified by:

    set in interface ContentHandle<Source>

    Parameters:

    content - the transform source

  • with

    public SourceHandle with(Source content)
    Assigns a transform source that produces the content and returns the handle as a fluent convenience.

    Parameters:

    content - the transform source

    Returns:

    this handle

  • getContentClass

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

    Returns:

    the class for the handled content

  • newHandle

    public SourceHandle 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<Source,InputStream>

    Specified by:

    newHandle in interface ContentHandle<Source>

    Returns:

    the new handle

  • newHandleArray

    public SourceHandle[] 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<Source,InputStream>

    Parameters:

    length - the number of positions in the array

    Returns:

    the uninitialized array

  • newArray

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

    Specified by:

    newArray in interface ContentHandle<Source>

    Parameters:

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

    Returns:

    the constructed array

  • transform

    public void transform(Result result)
    Transforms the source for the content output to the result. If the transformer is not specified, an identity transform sends the source to the result. When writing, the result is stored in the database

    Parameters:

    result - the receiver of the transform output

  • 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 SourceHandle 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 Source toContent(InputStream serialization)
    Description copied from interface: BufferableContentHandle
    Converts the serialization to the content representation.

    Specified by:

    toContent in interface BufferableContentHandle<Source,InputStream>

    Parameters:

    serialization - a serialization of the content

    Returns:

    the content representation

  • bytesToContent

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

    Specified by:

    bytesToContent in interface BufferableContentHandle<Source,InputStream>

    Parameters:

    buffer - the byte serialization

    Returns:

    the content representation

  • contentToBytes

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

    Specified by:

    contentToBytes in interface BufferableContentHandle<Source,InputStream>

    Parameters:

    content - the content

    Returns:

    the byte serialization of the content

  • toString

    public String toString()
    Buffers the transform source and returns the buffer as a 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

  • close

    public void close()
    Always call close() when finished with this handle -- it closes the underlying InputStream.

    Specified by:

    close in interface AutoCloseable

    Specified by:

    close in interface Closeable

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