Class InputSourceHandle

All Implemented Interfaces:

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

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Class

  Description

  static class 

  InputSourceHandle.DraconianErrorHandler

  DraconianErrorHandler treats SAX parse errors as exceptions but ignores warnings (based on the JavaDoc for the javax.xml.validation package).

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  InputSourceHandle()

  Zero-argument constructor.

  InputSourceHandle(InputSource content)

  Initializes the handle with a SAX input source for the content.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  InputSource

  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(InputSource 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.

  InputSource

  get()

  Returns the input source for the content.

  Class<InputSource>

  getContentClass()

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

  Schema

  getDefaultWriteSchema()

  Returns the default schema for validating the input source while writing to the database.

  ErrorHandler

  getErrorHandler()

  Returns the error handler for errors discovered while parsing the input source.

  SAXParserFactory

  getFactory()

  Returns the factory for parsing SAX events.

  EntityResolver

  getResolver()

  Returns the resolver for resolving references while parsing the input source.

  protected XMLReader

  makeReader(boolean isForWrite)

   

  protected SAXParserFactory

  makeSAXParserFactory()

   

  InputSource[]

  newArray(int length)

  Constructs an array for the handled content representation

  static ContentHandleFactory

  newFactory()

  Creates a factory to create a InputSourceHandle instance for a SAX InputSource.

  InputSourceHandle

  newHandle()

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

  InputSourceHandle[]

  newHandleArray(int length)

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

  void

  process(ContentHandler handler)

  Reads the input source, sending SAX events to the supplied content handler.

  protected Class<InputStream>

  receiveAs()

   

  protected void

  receiveContent(InputStream content)

   

  protected OutputStreamSender

  sendContent()

   

  protected OutputStreamSender

  sendContent(InputSource content)

   

  void

  set(InputSource content)

  Assigns an input source as the content.

  void

  setDefaultWriteSchema(Schema schema)

  Specifies the default schema for validating the input source.

  void

  setErrorHandler(ErrorHandler errorHandler)

  Specifies the error handler for errors discovered while parsing the input source.

  void

  setFactory(SAXParserFactory factory)

  Specifies the factory for parsing SAX events.

  void

  setFormat(Format format)

  Restricts the format to XML.

  void

  setResolver(EntityResolver resolver)

  Specifies the resolver for resolving references while parsing the input source.

  byte[]

  toBuffer()

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

  InputSource

  toContent(InputStream serialization)

  Converts the serialization to the content representation.

  String

  toString()

  Buffers the SAX input source and returns the buffer as an XML string.

  InputSourceHandle

  with(InputSource content)

  Assigns an input source as the content and returns the handle as a fluent convenience.

  InputSourceHandle

  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

  • InputSourceHandle

    public InputSourceHandle()
    Zero-argument constructor.

  • InputSourceHandle

    public InputSourceHandle(InputSource content)
    Initializes the handle with a SAX input source for the content.

    Parameters:

    content - a SAX input source

• Method Details

  • newFactory

    public static ContentHandleFactory newFactory()
    Creates a factory to create a InputSourceHandle instance for a SAX InputSource.

    Returns:

    the factory

  • getResolver

    public EntityResolver getResolver()
    Returns the resolver for resolving references while parsing the input source.

    Returns:

    the resolver

  • setResolver

    public void setResolver(EntityResolver resolver)
    Specifies the resolver for resolving references while parsing the input source.

    Parameters:

    resolver - the reference resolver

  • getErrorHandler

    public ErrorHandler getErrorHandler()
    Returns the error handler for errors discovered while parsing the input source.

    Returns:

    the error handler

  • setErrorHandler

    public void setErrorHandler(ErrorHandler errorHandler)
    Specifies the error handler for errors discovered while parsing the input source.

    Parameters:

    errorHandler - the error handler

  • get

    public InputSource get()
    Returns the input source for the content.

    Specified by:

    get in interface ContentHandle<InputSource>

    Returns:

    the input source

  • set

    public void set(InputSource content)
    Assigns an input source as the content.

    Specified by:

    set in interface ContentHandle<InputSource>

    Parameters:

    content - an input source

  • with

    public InputSourceHandle with(InputSource content)
    Assigns an input source as the content and returns the handle as a fluent convenience.

    Parameters:

    content - an input source

    Returns:

    this handle

  • getContentClass

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

    Returns:

    the class for the handled content

  • newHandle

    public InputSourceHandle 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<InputSource,InputStream>

    Specified by:

    newHandle in interface ContentHandle<InputSource>

    Returns:

    the new handle

  • newHandleArray

    public InputSourceHandle[] 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<InputSource,InputStream>

    Parameters:

    length - the number of positions in the array

    Returns:

    the uninitialized array

  • newArray

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

    Specified by:

    newArray in interface ContentHandle<InputSource>

    Parameters:

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

    Returns:

    the constructed array

  • process

    public void process(ContentHandler handler)
    Reads the input source, sending SAX events to the supplied content handler.

    Parameters:

    handler - the SAX content handler

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

    Specified by:

    toContent in interface BufferableContentHandle<InputSource,InputStream>

    Parameters:

    serialization - a serialization of the content

    Returns:

    the content representation

  • bytesToContent

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

    Specified by:

    bytesToContent in interface BufferableContentHandle<InputSource,InputStream>

    Parameters:

    buffer - the byte serialization

    Returns:

    the content representation

  • contentToBytes

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

    Specified by:

    contentToBytes in interface BufferableContentHandle<InputSource,InputStream>

    Parameters:

    content - the content

    Returns:

    the byte serialization of the content

  • toString

    public String toString()
    Buffers the SAX input source and returns the buffer as an XML string.

    Overrides:

    toString in class Object

  • getFactory

    public SAXParserFactory getFactory() throws SAXException, ParserConfigurationException
    Returns the factory for parsing SAX events.

    Returns:

    the SAX factory

    Throws:

    SAXException - if such an error occurs while initializing the new factory

    ParserConfigurationException - if such an error occurs while initializing the new factory

  • setFactory

    public void setFactory(SAXParserFactory factory)
    Specifies the factory for parsing SAX events.

    Parameters:

    factory - the SAX factory

  • makeSAXParserFactory

    protected SAXParserFactory makeSAXParserFactory() throws SAXException, ParserConfigurationException

    Throws:

    SAXException

    ParserConfigurationException

  • getDefaultWriteSchema

    public Schema getDefaultWriteSchema()
    Returns the default schema for validating the input source while writing to the database.

    Returns:

    the default schema for writing documents

  • setDefaultWriteSchema

    public void setDefaultWriteSchema(Schema schema)
    Specifies the default schema for validating the input source. The default schema is used only while writing to the database and only when no schema has been set directly on the factory. To minimize creation of partial documents while writing an input source to the database, set the error handler on the InputSourceHandle to InputSourceHandle.DraconianErrorHandler and set the repair policy to NONE on the XMLDocumentManager. An error on the root element can still result in an empty document.

    Parameters:

    schema - the default schema for writing documents

  • makeReader

    protected XMLReader makeReader(boolean isForWrite)

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

  • sendContent

    protected OutputStreamSender sendContent(InputSource content)

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