Package com.marklogic.client.io

Class InputSourceHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<java.io.InputStream,OutputStreamSender>

com.marklogic.client.io.InputSourceHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableHandle, ContentHandle<org.xml.sax.InputSource>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender, java.io.Closeable, java.lang.AutoCloseable

public class InputSourceHandle
extends BaseHandle<java.io.InputStream,OutputStreamSender>
implements OutputStreamSender, BufferableHandle, ContentHandle<org.xml.sax.InputSource>, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, java.io.Closeable

An Input Source Handle represents XML content as an input source for reading or writing. When reading, the XML may be processed by a SAX content handler.

Always call close() when finished with this handle to release the resources.

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(org.xml.sax.InputSource content)	Initializes the handle with a SAX input source for the content.

Method Summary

Modifier and Type	Method	Description
void	close()	Always call close() when finished with this handle -- it closes the underlying InputStream.
void	fromBuffer(byte[] buffer)	Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
org.xml.sax.InputSource	get()	Returns the input source for the content.
java.lang.Class<org.xml.sax.InputSource>	getContentClass()	Returns the class of the handled content, which may be a base class of the actual class of a content object.
javax.xml.validation.Schema	getDefaultWriteSchema()	Returns the default schema for validating the input source while writing to the database.
org.xml.sax.ErrorHandler	getErrorHandler()	Returns the error handler for errors discovered while parsing the input source.
javax.xml.parsers.SAXParserFactory	getFactory()	Returns the factory for parsing SAX events.
org.xml.sax.EntityResolver	getResolver()	Returns the resolver for resolving references while parsing the input source.
protected org.xml.sax.XMLReader	makeReader(boolean isForWrite)
protected javax.xml.parsers.SAXParserFactory	makeSAXParserFactory()
static ContentHandleFactory	newFactory()	Creates a factory to create a InputSourceHandle instance for a SAX InputSource.
void	process(org.xml.sax.ContentHandler handler)	Reads the input source, sending SAX events to the supplied content handler.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream content)
protected OutputStreamSender	sendContent()
void	set(org.xml.sax.InputSource content)	Assigns an input source as the content.
void	setDefaultWriteSchema(javax.xml.validation.Schema schema)	Specifies the default schema for validating the input source.
void	setErrorHandler(org.xml.sax.ErrorHandler errorHandler)	Specifies the error handler for errors discovered while parsing the input source.
void	setFactory(javax.xml.parsers.SAXParserFactory factory)	Specifies the factory for parsing SAX events.
void	setFormat(Format format)	Restricts the format to XML.
void	setResolver(org.xml.sax.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.
java.lang.String	toString()	Buffers the SAX input source and returns the buffer as an XML string.
InputSourceHandle	with(org.xml.sax.InputSource content)	Assigns an input source as the content and returns the handle as a fluent convenience.
InputSourceHandle	withMimetype(java.lang.String mimetype)	Specifies the mime type of the content and returns the handle as a fluent convenience.
void	write(java.io.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

Constructor Detail

InputSourceHandle

public InputSourceHandle()

Zero-argument constructor.

InputSourceHandle

public InputSourceHandle(org.xml.sax.InputSource content)

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

Parameters:

content - a SAX input source

Method Detail

newFactory

public static ContentHandleFactory newFactory()

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

Returns:

the factory

getResolver

public org.xml.sax.EntityResolver getResolver()

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

Returns:

the resolver

setResolver

public void setResolver(org.xml.sax.EntityResolver resolver)

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

Parameters:

resolver - the reference resolver

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()

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

Returns:

the error handler

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)

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

Parameters:

errorHandler - the error handler

get

public org.xml.sax.InputSource get()

Returns the input source for the content.

Specified by:

get in interface ContentHandle<org.xml.sax.InputSource>

Returns:

the input source

set

public void set(org.xml.sax.InputSource content)

Assigns an input source as the content.

Specified by:

set in interface ContentHandle<org.xml.sax.InputSource>

Parameters:

content - an input source

with

public InputSourceHandle with(org.xml.sax.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 java.lang.Class<org.xml.sax.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<org.xml.sax.InputSource>

Returns:

the class for the handled content

process

public void process(org.xml.sax.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<java.io.InputStream,OutputStreamSender>

Parameters:

format - the format of the content

withMimetype

public InputSourceHandle withMimetype(java.lang.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 java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

getFactory

public javax.xml.parsers.SAXParserFactory getFactory()
                                              throws org.xml.sax.SAXException,
                                                     javax.xml.parsers.ParserConfigurationException

Returns the factory for parsing SAX events.

Returns:

the SAX factory

Throws:

org.xml.sax.SAXException - if such an error occurs while initializing the new factory

javax.xml.parsers.ParserConfigurationException - if such an error occurs while initializing the new factory

setFactory

public void setFactory(javax.xml.parsers.SAXParserFactory factory)

Specifies the factory for parsing SAX events.

Parameters:

factory - the SAX factory

makeSAXParserFactory

protected javax.xml.parsers.SAXParserFactory makeSAXParserFactory()
                                                           throws org.xml.sax.SAXException,
                                                                  javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

getDefaultWriteSchema

public javax.xml.validation.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(javax.xml.validation.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 org.xml.sax.XMLReader makeReader(boolean isForWrite)

receiveAs

protected java.lang.Class<java.io.InputStream> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

receiveContent

protected void receiveContent(java.io.InputStream content)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

sendContent

protected OutputStreamSender sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

write

public void write(java.io.OutputStream out)
           throws java.io.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:

java.io.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 java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable