Package com.marklogic.client.io

The package provides the handle classes with different representations for document content when you read documents from the database or write documents to the database.

See: Description

Interface Summary

Interface	Description
DocumentMetadataHandle.DocumentCollections	Represents the collections for a database document.
DocumentMetadataHandle.DocumentMetadataValues	Represents the metadata-values for a database document.
DocumentMetadataHandle.DocumentPermissions	Represents the permissions for a database document.
DocumentMetadataHandle.DocumentProperties	Represents the properties for a database document.
OutputStreamSender	An Output Stream Sender sends content to the database by writing to the provided OutputStream.

Class Summary

Class	Description
BaseHandle<R,W>	BaseHandle is the base class for content representations such as byte arrays, strings, input streams, character readers, files, POJO (Plain Old Java Object) structures and so on.
BytesHandle	A Bytes Handle represents document content as a byte array for reading or writing.
DocumentMetadataHandle	A DocumentMetadataHandle represents the metadata for a database document.
DOMHandle	A DOM Handle represents XML content as a DOM document for reading or writing.
FileHandle	A File Handle represents document content as a file for reading or writing.
InputSourceHandle	An Input Source Handle represents XML content as an input source for reading or writing.
InputSourceHandle.DraconianErrorHandler	DraconianErrorHandler treats SAX parse errors as exceptions but ignores warnings (based on the JavaDoc for the javax.xml.validation package).
InputStreamHandle	An InputStreamHandle represents a resource as an InputStream for reading or writing.
JacksonDatabindHandle<T>	An adapter for using the Jackson Open Source library for JSON; represents JSON content for reading or writing as objects of the specified POJO class.
JacksonHandle	An adapter for using the Jackson Open Source library for JSON; represents JSON content as a Jackson JsonNode for reading or writing.
JacksonParserHandle	An adapter for using the streaming capabilities of the Jackson Open Source library.
JAXBHandle<C>	A JAXB Handle roundtrips a POJO (a Java data structure) to and from a database document.
JSONErrorParser	This class is provided as a convenience method for parsing MarkLogic errors that are serialized as JSON.
OutputStreamHandle	An OutputStreamHandle generates output during writing.
QueryOptionsListHandle	A QueryOptionsListHandle is used to access the list of named query options that exist on the server.
ReaderHandle	A Reader Handle represents a character content as a reader for reading to or writing from the database.
SearchHandle	A SearchHandle represents a set of search results returned by the server.
SearchHandle.Report	Represents a report message.
SearchHandle.Warning	Represents a warning.
SourceHandle	A Source Handle represents XML content as a transform source for reading or transforms a source into a result for writing.
StringHandle	A String Handle represents document content as a string for reading or writing.
TuplesHandle	A TuplesHandle represents a set of tuples returned by a query on the server.
ValuesHandle	A ValuesHandle represents a list of values or of tuples (combination of values for the same document) retrieved from the indexes.
ValuesListHandle	A ValuesListHandle represents a list of available named lexicon configurations from saved query options.
XMLEventReaderHandle	An XML Event Reader Handle represents XML content as an XML event reader for reading as a series of StAX events.
XMLStreamReaderHandle	An XML Stream Reader Handle represents XML content as an XML stream reader for reading as a StAX pull stream.

Enum Summary

Enum	Description
DocumentMetadataHandle.Capability	A document operation restricted to users with a role.
Format	The Format enumerates different kinds of document content.

Package com.marklogic.client.io Description

The package provides the handle classes with different representations for document content when you read documents from the database or write documents to the database. Some handles can be used only with specific document formats. For instance, you can use DOMHandle only for XML content. You can also use some handles to read or write document metadata or query options or to read search results.