Package com.marklogic.client.example.cookbook

The package provides examples for common actions in working with the database.

See: Description

Class Summary

Class	Description
AllCookbookExamples	AllCookbookExamples executes all of the recipe examples in the cookbook.
ClientCreator	ClientCreator illustrates how to create a database client.
DocumentDelete	DocumentDelete illustrates how to delete a database document.
DocumentFormats	DocumentFormats illustrates working with documents in multiple or unknown formats.
DocumentMetadataRead	DocumentMetadataReader illustrates how to read the metadata and content of a database document in a single request.
DocumentMetadataWrite	DocumentMetadataWriter illustrates how to write metadata and content to a database document in a single request.
DocumentOutputStream	DocumentOutputStream illustrates how to write content to a document using an OutputStream.
DocumentRead	DocumentReader illustrates how to read the content of a database document.
DocumentReadTransform	DocumentReadTransform installs a server transform for converting XML documents with a known vocabulary to HTML documents for presentation.
DocumentWrite	DocumentWriter illustrates how to write content to a database document.
DocumentWriteServerURI	DocumentWriterServerURI illustrates how to write content, letting MarkLogic assign a server URI
DocumentWriteTransform	DocumentWriteTransform installs a server transform for converting HTML documents to XHTML documents so HTML documents can be written to the database, indexed, and easily modified.
JavascriptResourceExtension	JavascriptResourceExtension installs an extension for managing spelling dictionary resources.
JavascriptResourceExtension.HelloWorld	HelloWorld provides an example of a class that implements a resource extension client, exposing a method for each service.
JAXBDocument	JAXBDocument illustrates how to write and read a POJO structure as a database document.
JAXBDocument.Product	Product provides an example of a class with JAXB annotations.
MultiStatementTransaction	MultiStatementTransaction illustrates how to open a transaction, execute multiple statements under the transaction, and commit the transaction.
OptimisticLocking	Optimistic Locking creates a document only when the document doesn't exist and updates or deletes a document only when the document hasn't changed.
QueryOptions	QueryOptions illustrates writing, reading, and deleting query options.
RawClientAlert	RawClientAlert illustrates defining and finding rules that match documents.
RawCombinedSearch	RawCombinedSearch illustrates searching for documents and iterating over results by passing structured criteria and query options in a single request.
ResourceExtension	ResourceExtension installs an extension for managing spelling dictionary resources.
ResourceExtension.DictionaryManager	DictionaryManager provides an example of a class that implements a resource extension client, exposing a method for each service.
SearchResponseTransform	Search illustrates adding a result transformation to a search.
SSLClientCreator	SSLClientCreator illustrates the basic approach for creating a client using SSL for database access.
StringSearch	StringSearch illustrates searching for documents and iterating over results with string criteria referencing a constraint defined by options.
StructuredSearch	StructuredSearch illustrates searching for documents and iterating over results with structured criteria referencing a constraint defined by options.
Suggest	Suggest illustrates getting suggestions for words to find in an element.
Util	Utilities to support and simplify examples.
Util.ExampleProperties	ExampleProperties represents the configuration for the examples.

Package com.marklogic.client.example.cookbook Description

The package provides examples for common actions in working with the database. Edit the Example.properties file in the distribution to specify the connection parameters for your server. Look at the source code for AllCookbookExamples for a suggested order for viewing the examples