| Package | Description |
|---|---|
| com.marklogic.client.admin |
The package provides the classes for configuration and initialization of the REST server.
|
| com.marklogic.client.alerting |
A REST interface to MarkLogic alerting capabilities.
|
| com.marklogic.client.bitemporal | |
| com.marklogic.client.document |
The package provides classes for creating, retrieving, updating, and deleting documents in the database for the REST server.
|
| com.marklogic.client.example.cookbook |
The package provides examples for common actions in working with the database.
|
| com.marklogic.client.example.extension |
The package provides examples of extensions that operate on a batch of database documents.
|
| com.marklogic.client.pojo |
The goal of this package (sometimes referred to as “the pojo facade” is to simplify working with custom Plain Old Java Objects (pojos) without hassling with persistence details.
|
| com.marklogic.client.semantics |
| Modifier and Type | Method and Description |
|---|---|
void |
ExtensionLibrariesManager.delete(ExtensionLibraryDescriptor libraryDescriptor)
Removes a library asset from the server.
|
void |
ExtensionLibrariesManager.delete(String libraryPath)
Removes a library asset from the server.
|
void |
QueryOptionsManager.deleteOptions(String name)
Remove a search configuration from the REST server.
|
void |
NamespacesManager.deletePrefix(String prefix)
Deletes a namespace binding on the server.
|
void |
TransformExtensionsManager.deleteTransform(String transformName)
Uninstalls the transform.
|
ExtensionLibraryDescriptor[] |
ExtensionLibrariesManager.list()
Lists all of the library files that are installed on the server.
|
ExtensionLibraryDescriptor[] |
ExtensionLibrariesManager.list(String directory)
Lists all of the library files in one directory (infinite depth) on the server.
|
<T> T |
ExtensionLibrariesManager.read(ExtensionLibraryDescriptor libraryDescriptor,
Class<T> as)
Reads the contents of a library asset as an object of an IO class.
|
<T extends AbstractReadHandle> |
ExtensionLibrariesManager.read(ExtensionLibraryDescriptor libraryDescriptor,
T readHandle)
Reads the contents of a library asset into a handle.
|
<T extends AbstractReadHandle> |
ExtensionLibrariesManager.read(String libraryPath,
T readHandle)
Reads the contents of a library asset into a handle.
|
<T> T |
ExtensionLibrariesManager.readAs(String libraryPath,
Class<T> as)
Reads the contents of a library asset as an object of an IO class.
|
<T extends TextReadHandle> |
TransformExtensionsManager.readJavascriptTransform(String transformName,
T sourceHandle)
Reads the source for a transform implemented in Javascript.
|
<T> T |
TransformExtensionsManager.readJavascriptTransformAs(String transformName,
Class<T> as)
Reads the source for a transform implemented in Javascript in a textual representation provided as an object of an IO class.
|
<T extends QueryOptionsReadHandle> |
QueryOptionsManager.readOptions(String name,
T queryOptionsHandle)
Fetch a query options configuration from the REST Server by name.
|
<T> T |
QueryOptionsManager.readOptionsAs(String name,
Format format,
Class<T> as)
Fetch a query options configuration from the REST Server by name.
|
<T extends TextReadHandle> |
TransformExtensionsManager.readXQueryTransform(String transformName,
T sourceHandle)
Reads the source for a transform implemented in XQuery.
|
<T> T |
TransformExtensionsManager.readXQueryTransformAs(String transformName,
Class<T> as)
Reads the source for a transform implemented in XQuery in a textual representation provided as an object of an IO class.
|
<T extends XMLReadHandle> |
TransformExtensionsManager.readXSLTransform(String transformName,
T sourceHandle)
Reads the source for a transform implemented in XSLT.
|
<T> T |
TransformExtensionsManager.readXSLTransformAs(String transformName,
Class<T> as)
Reads the source for a transform implemented in XSLT in an XML representation provided as an object of an IO class.
|
void |
NamespacesManager.updatePrefix(String prefix,
String namespaceURI)
Writes a namespace binding on the server.
|
void |
ExtensionLibrariesManager.write(ExtensionLibraryDescriptor libraryDescriptor,
AbstractWriteHandle contentHandle)
Writes the contents of a handle to the provided path on the REST server.
|
void |
ExtensionLibrariesManager.write(String libraryPath,
AbstractWriteHandle contentHandle)
Writes the contents of a handle to the provided path on the REST server.
|
void |
ExtensionLibrariesManager.writeAs(ExtensionLibraryDescriptor libraryDescriptor,
Object content)
Writes the contents of a handle to the provided path on the REST server as an object of an IO class.
|
void |
ExtensionLibrariesManager.writeAs(String libraryPath,
Object content)
Writes the contents of a handle to the provided path on the REST server as an object of an IO class.
|
void |
ServerConfigurationManager.writeConfiguration()
Writes the values of the properties of this object to the server.
|
void |
TransformExtensionsManager.writeJavascriptTransform(String transformName,
TextWriteHandle sourceHandle)
Installs a transform implemented in Javascript.
|
void |
TransformExtensionsManager.writeJavascriptTransform(String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata)
Installs a transform implemented in Javascript.
|
void |
TransformExtensionsManager.writeJavascriptTransformAs(String transformName,
ExtensionMetadata metadata,
Object source)
Installs a transform implemented in Javascript in a textual representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeJavascriptTransformAs(String transformName,
Object source)
Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
|
void |
QueryOptionsManager.writeOptions(String name,
QueryOptionsWriteHandle queryOptionsHandle)
Write a named QueryOptions configuration to the REST server.
|
void |
QueryOptionsManager.writeOptionsAs(String name,
Format format,
Object queryOptions)
Write a named QueryOptions configuration to the REST server in a JSON or XML representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXQueryTransform(String transformName,
TextWriteHandle sourceHandle)
Installs a transform implemented in XQuery.
|
void |
TransformExtensionsManager.writeXQueryTransform(String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata)
Installs a transform implemented in XQuery.
|
void |
TransformExtensionsManager.writeXQueryTransformAs(String transformName,
ExtensionMetadata metadata,
Object source)
Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXQueryTransformAs(String transformName,
Object source)
Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXSLTransform(String transformName,
XMLWriteHandle sourceHandle)
Installs a transform implemented in XSL.
|
void |
TransformExtensionsManager.writeXSLTransform(String transformName,
XMLWriteHandle sourceHandle,
ExtensionMetadata metadata)
Installs a transform implemented in XSL.
|
void |
TransformExtensionsManager.writeXSLTransformAs(String transformName,
ExtensionMetadata metadata,
Object source)
Installs a transform implemented in XSL in an XML representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXSLTransformAs(String transformName,
Object source)
Installs a transform implemented in XSL in an XML representation provided as an object of an IO class.
|
| Modifier and Type | Method and Description |
|---|---|
<T extends RuleReadHandle> |
RuleManager.readRule(String ruleName,
T readHandle)
Reads a rule from the server into the provided handle.
|
<T> T |
RuleManager.readRuleAs(String ruleName,
Class<T> as)
Reads a rule from the server in an XML representation provided as an object of an IO class.
|
void |
RuleManager.writeRule(RuleDefinition writeHandle)
Writes a rule to the server from the provided handle.
|
void |
RuleManager.writeRuleAs(String ruleName,
Object ruleSource)
Writes a rule to the server in an XML representation provided as an object of an IO class.
|
| Modifier and Type | Method and Description |
|---|---|
TemporalDescriptor |
TemporalDocumentManager.delete(DocumentDescriptor desc,
Transaction transaction,
String temporalCollection)
Just like
delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management. |
TemporalDescriptor |
TemporalDocumentManager.delete(DocumentDescriptor desc,
Transaction transaction,
String temporalCollection,
Calendar systemTime)
Just like
delete but delete document at a specified system time |
TemporalDescriptor |
TemporalDocumentManager.delete(String docId,
Transaction transaction,
String temporalCollection)
Just like
delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management. |
TemporalDescriptor |
TemporalDocumentManager.delete(String docId,
Transaction transaction,
String temporalCollection,
Calendar systemTime)
Just like
delete but delete document at a specified system time |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
String temporalCollection)
Just like
write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management. |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
String temporalCollection,
Calendar systemTime)
Just like
write but write document at a specific system time |
TemporalDescriptor |
TemporalDocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
String temporalCollection)
Just like
write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management. |
TemporalDescriptor |
TemporalDocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
String temporalCollection,
Calendar systemTime)
Just like
write but write document at a specific system time |
| Modifier and Type | Method and Description |
|---|---|
void |
DocumentManager.delete(DocumentDescriptor desc)
Deletes the document metadata and content from the database
|
void |
DocumentManager.delete(DocumentDescriptor desc,
Transaction transaction)
Deletes the document metadata and content from an open database transaction
|
void |
DocumentManager.delete(String... uris)
Deletes the documents’ metadata and content
|
void |
DocumentManager.delete(String docId)
Deletes the document metadata and content from the database
|
void |
DocumentManager.delete(String docId,
Transaction transaction)
Deletes the document metadata and content from an open database transaction
|
void |
DocumentManager.delete(Transaction transaction,
String... uris)
Deletes the documents’ metadata and content from an open database transaction
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle)
Reads the document metadata and content from the database in the representations provided by the handles
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document metadata and content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
Transaction transaction)
Reads the document metadata and content from an open database transaction in the representations provided by the handles
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle)
Reads the document content from the database in the representations provided by the handles
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
long start,
long length)
Reads a range of bytes from the content of a binary database document in the representation provided by the handle
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads a range of bytes from the content of a binary database document as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
Transaction transaction)
Reads the document content from an open database transaction in the representation provided by the handle
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle)
Reads the document metadata and content from the database in the representations provided by the handles
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document metadata and content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
Transaction transaction)
Reads the document metadata and content from an open database transaction in the representations provided by the handles
|
<T extends R> |
DocumentManager.read(String docId,
T contentHandle)
Reads the document content from the database in the representation provided by the handle
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
long start,
long length)
Reads a range of bytes from the content of a binary database document in the representation provided by the handle
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
|
<T extends R> |
DocumentManager.read(String docId,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads a range of bytes from the content of a binary database document as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
T contentHandle,
Transaction transaction)
Reads the document content from an open database transaction in the representation provided by the handle
|
<T> T |
DocumentManager.readAs(String docId,
Class<T> as)
Reads the document content from the database in the representation specified by the IO class.
|
<T> T |
BinaryDocumentManager.readAs(String docId,
Class<T> as,
long start,
long length)
Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(String docId,
Class<T> as,
ServerTransform transform)
Reads the document content from the database in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(String docId,
DocumentMetadataReadHandle metadataHandle,
Class<T> as)
Reads the document metadata and content from the database in the representation specified by the IO class.
|
<T> T |
BinaryDocumentManager.readAs(String docId,
DocumentMetadataReadHandle metadataHandle,
Class<T> as,
long start,
long length)
Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(String docId,
DocumentMetadataReadHandle metadataHandle,
Class<T> as,
ServerTransform transform)
Reads the document metadata and content from the database in the representation specified by the IO class.
|
<T extends DocumentMetadataReadHandle> |
DocumentManager.readMetadata(String docId,
T metadataHandle)
Reads the document metadata from the database in the representation provided by the handle
|
<T extends DocumentMetadataReadHandle> |
DocumentManager.readMetadata(String docId,
T metadataHandle,
Transaction transaction)
Reads the document metadata from an open database transaction in the representation provided by the handle
|
void |
DocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle)
Writes the document metadata and content to the database from the representations provided by the handles
|
void |
DocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Writes the document metadata and content to the database as transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document metadata and content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction)
Writes the document metadata and content to an open database transaction from the representations provided by the handles
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle)
Writes the document content to the database from the representation provided by the handle
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
Transaction transaction)
Writes the document content to an open database transaction from the representation provided by the handle
|
void |
DocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle)
Writes the document metadata and content to the database from the representations provided by the handles
|
void |
DocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Writes the document metadata and content to the database as transformed on the server.
|
void |
DocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document metadata and content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction)
Writes the document metadata and content to an open database transaction from the representations provided by the handles
|
void |
DocumentManager.write(String docId,
W contentHandle)
Writes the document content to the database from the representation provided by the handle
|
void |
DocumentManager.write(String docId,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
void |
DocumentManager.write(String docId,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(String docId,
W contentHandle,
Transaction transaction)
Writes the document content to an open database transaction from the representation provided by the handle
|
void |
DocumentManager.writeAs(String docId,
DocumentMetadataWriteHandle metadataHandle,
Object content)
Writes the document content to the database from an object of an IO class.
|
void |
DocumentManager.writeAs(String docId,
DocumentMetadataWriteHandle metadataHandle,
Object content,
ServerTransform transform)
Writes the document content to the database from an object of an IO class.
|
void |
DocumentManager.writeAs(String docId,
Object content)
Writes the document content to the database from an object of an IO class.
|
void |
DocumentManager.writeAs(String docId,
Object content,
ServerTransform transform)
Writes the document content to the database from an object of an IO class.
|
void |
DocumentManager.writeDefaultMetadata(String docId)
Reverts the document metadata in the database to the defaults
|
void |
DocumentManager.writeDefaultMetadata(String docId,
Transaction transaction)
Reverts the document metadata in an open database transaction to the defaults
|
void |
DocumentManager.writeMetadata(String docId,
DocumentMetadataWriteHandle metadataHandle)
Writes the document metadata to the database from the representation provided by the handle
|
void |
DocumentManager.writeMetadata(String docId,
DocumentMetadataWriteHandle metadataHandle,
Transaction transaction)
Writes the document metadata to an open database transaction from the representation provided by the handle
|
| Modifier and Type | Method and Description |
|---|---|
static void |
Suggest.configure(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
StructuredSearch.configure(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
StringSearch.configure(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
SearchResponseTransform.configure(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
void |
ResourceExtension.DictionaryManager.createDictionary(String uri,
String[] words) |
void |
ResourceExtension.DictionaryManager.deleteDictionary(String uri) |
static void |
SearchResponseTransform.installTransform(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
DocumentWriteTransform.installTransform(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
DocumentReadTransform.installTransform(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
Suggest.main(String[] args) |
static void |
StructuredSearch.main(String[] args) |
static void |
StringSearch.main(String[] args) |
static void |
SearchResponseTransform.main(String[] args) |
static void |
ResourceExtension.main(String[] args) |
static void |
QueryOptions.main(String[] args) |
static void |
OptimisticLocking.main(String[] args) |
static void |
JavascriptResourceExtension.main(String[] args) |
static void |
DocumentWriteTransform.main(String[] args) |
static void |
DocumentReadTransform.main(String[] args) |
static void |
AllCookbookExamples.main(String[] args) |
static void |
OptimisticLocking.modifyDatabase(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
DocumentReadTransform.readDocument(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
OptimisticLocking.requireOptimisticLocking(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
Suggest.run(Util.ExampleProperties props) |
static void |
StructuredSearch.run(Util.ExampleProperties props) |
static void |
StringSearch.run(Util.ExampleProperties props) |
static void |
SearchResponseTransform.run(Util.ExampleProperties props) |
static void |
ResourceExtension.run(Util.ExampleProperties props) |
static void |
QueryOptions.run(Util.ExampleProperties props) |
static void |
OptimisticLocking.run(Util.ExampleProperties props) |
static void |
JavascriptResourceExtension.run(Util.ExampleProperties props) |
static void |
DocumentWriteTransform.run(Util.ExampleProperties props) |
static void |
DocumentReadTransform.run(Util.ExampleProperties props) |
static void |
QueryOptions.runShortcut(DatabaseClient client) |
static void |
QueryOptions.runStrongTyped(DatabaseClient client) |
static void |
StructuredSearch.search(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
StringSearch.search(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
SearchResponseTransform.search(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
Suggest.setUpExample(DatabaseClient client) |
static void |
StructuredSearch.setUpExample(DatabaseClient client) |
static void |
StringSearch.setUpExample(DatabaseClient client) |
static void |
SearchResponseTransform.setUpExample(DatabaseClient client) |
static void |
DocumentReadTransform.setUpExample(DatabaseClient client,
String docId,
String filename) |
static void |
Suggest.suggest(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
Suggest.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
StructuredSearch.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
StringSearch.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
SearchResponseTransform.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
OptimisticLocking.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
DocumentWriteTransform.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
DocumentReadTransform.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
ResourceExtension.useResource(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
JavascriptResourceExtension.useResource(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
DocumentWriteTransform.writeDocument(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
| Modifier and Type | Method and Description |
|---|---|
static void |
SearchCollectorExample.configureExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
SearchCollectorExample.configureQueryOptions(DatabaseClient client) |
static void |
SearchCollectorExample.main(String[] args) |
static void |
OpenCSVBatcherExample.main(String[] args) |
static void |
BatchManagerExample.main(String[] args) |
static void |
SearchCollectorExample.run(Util.ExampleProperties props) |
static void |
OpenCSVBatcherExample.run(Util.ExampleProperties props) |
static void |
BatchManagerExample.run(Util.ExampleProperties props) |
static void |
SearchCollectorExample.setUpExample(DatabaseClient client) |
static void |
BatchManagerExample.setUpExample(DatabaseClient client) |
static void |
SearchCollectorExample.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
OpenCSVBatcherExample.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
BatchManagerExample.tearDownExample(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
OpenCSVBatcherExample.useResource(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
static void |
BatchManagerExample.useResource(String host,
int port,
String user,
String password,
DatabaseClientFactory.Authentication authType) |
| Modifier and Type | Method and Description |
|---|---|
void |
PojoRepository.delete(ID... ids)
Deletes from the database the persisted pojo instances with the corresponding ids
|
void |
PojoRepository.delete(ID[] ids,
Transaction transaction)
As part of transaction, deletes from the database the documents with the corresponding ids
|
void |
PojoRepository.deleteAll()
Deletes from the database all documents of the type managed by this PojoRepositoryof type T persisted by the pojo facade
|
void |
PojoRepository.deleteAll(Transaction transaction)
As part of transaction, deletes from the database all documents of the type managed by this PojoRepositoryof type T persisted by the pojo facade
|
T |
PojoRepository.read(ID id)
Read one persisted pojo by id and unmarshall its data into a new pojo instance.
|
T |
PojoRepository.read(ID id,
Transaction transaction)
Within an open transaction, read one persisted pojo by id and unmarshall its data into a new pojo instance.
|
void |
PojoRepository.write(T entity)
Write this instance to the database.
|
void |
PojoRepository.write(T entity,
String... collections)
Does everything in
write(T) but also adds your collections to the persisted instance. |
void |
PojoRepository.write(T entity,
Transaction transaction)
Does everything in
write(T) but in your multi-statement transaction context. |
void |
PojoRepository.write(T entity,
Transaction transaction,
String... collections)
Does everything in
write(T) but also adds your collections to the persisted instance and performs the write in your multi-statement transaction context. |
| Modifier and Type | Method and Description |
|---|---|
void |
GraphManager.delete(String uri)
Permanently delete the specified graph from the server.
|
void |
GraphManager.delete(String uri,
Transaction transaction)
Permanently delete the specified graph from the server.
|
void |
GraphManager.deleteGraphs()
Permanently delete all quads from all graphs.
|
void |
GraphManager.deleteGraphs(Transaction transaction)
Permanently delete all quads from all graphs.
|
void |
GraphManager.deletePermissions(String uri)
Delete all permissions for the graph.
|
void |
GraphManager.deletePermissions(String uri,
Transaction transaction)
Delete all permissions for the graph.
|
GraphPermissions |
GraphManager.getPermissions(String uri)
Retrieve permissions for a graph.
|
GraphPermissions |
GraphManager.getPermissions(String uri,
Transaction transaction)
Retrieve permissions for a graph.
|
void |
GraphManager.merge(String uri,
TriplesWriteHandle handle)
Add triples from the handle to the specified graph.
|
void |
GraphManager.merge(String uri,
TriplesWriteHandle handle,
GraphPermissions permissions)
Add triples from the handle and add specified permissions to the
specified graph.
|
void |
GraphManager.merge(String uri,
TriplesWriteHandle handle,
GraphPermissions permissions,
Transaction transaction)
Add triples from the handle and add specified permissions to the
specified graph.
|
void |
GraphManager.merge(String uri,
TriplesWriteHandle handle,
Transaction transaction)
Add triples from the handle to the specified graph.
|
void |
GraphManager.mergeAs(String uri,
Object graphData)
Add triples from the graphData object to the specified graph.
|
void |
GraphManager.mergeAs(String uri,
Object graphData,
GraphPermissions permissions)
Add triples from the graphData object and add specified permissions
to the specified graph.
|
void |
GraphManager.mergeAs(String uri,
Object graphData,
GraphPermissions permissions,
Transaction transaction)
Add triples from the graphData object and add specified permissions
to the specified graph.
|
void |
GraphManager.mergeAs(String uri,
Object graphData,
Transaction transaction)
Add triples from the graphData object to the specified graph.
|
void |
GraphManager.mergeGraphs(QuadsWriteHandle handle)
Add quads from the handle to the graphs specified in the quads data.
|
void |
GraphManager.mergeGraphs(QuadsWriteHandle handle,
Transaction transaction)
Add quads from the handle to the graphs specified in the quads data.
|
void |
GraphManager.mergeGraphsAs(Object quadsData)
Add quads from the object to the graphs specified in the quads data.
|
void |
GraphManager.mergeGraphsAs(Object quadsData,
Transaction transaction)
Add quads from the object to the graphs specified in the quads data.
|
void |
GraphManager.mergePermissions(String uri,
GraphPermissions permissions)
Add to permissions on the graph.
|
void |
GraphManager.mergePermissions(String uri,
GraphPermissions permissions,
Transaction transaction)
Add to permissions on the graph.
|
<T extends TriplesReadHandle> |
GraphManager.read(String uri,
T handle)
Read triples from the server.
|
<T extends TriplesReadHandle> |
GraphManager.read(String uri,
T handle,
Transaction transaction)
Read triples from the server.
|
<T> T |
GraphManager.readAs(String uri,
Class<T> as)
Read triples from the server as the specified type.
|
<T> T |
GraphManager.readAs(String uri,
Class<T> as,
Transaction transaction)
Read triples from the server as the specified type.
|
void |
GraphManager.replaceGraphs(QuadsWriteHandle handle)
Remove all quads from all graphs then insert quads from the handle
to the graphs specified in the quads data.
|
void |
GraphManager.replaceGraphs(QuadsWriteHandle handle,
Transaction transaction)
Remove all quads from all graphs then insert quads from the handle
to the graphs specified in the quads data.
|
void |
GraphManager.replaceGraphsAs(Object quadsData)
Remove all quads from all graphs then insert quads from the quadsData
to the graphs specified in the quads data.
|
void |
GraphManager.replaceGraphsAs(Object quadsData,
Transaction transaction)
Remove all quads from all graphs then insert quads from the quadsData
to the graphs specified in the quads data.
|
<T extends TriplesReadHandle> |
GraphManager.things(T handle,
String... iris)
Retrieves all triples related to specified subject or object iris.
|
<T> T |
GraphManager.thingsAs(Class<T> as,
String... iris)
Retrieves all triples related to specified subject or object iris.
|
void |
GraphManager.write(String uri,
TriplesWriteHandle handle)
Overwrite triples from the handle as the
specified graph.
|
void |
GraphManager.write(String uri,
TriplesWriteHandle handle,
GraphPermissions permissions)
Overwrite triples from the handle and specified permissions as the
specified graph.
|
void |
GraphManager.write(String uri,
TriplesWriteHandle handle,
GraphPermissions permissions,
Transaction transaction)
Overwrite triples from the handle and specified permissions as the
specified graph.
|
void |
GraphManager.write(String uri,
TriplesWriteHandle handle,
Transaction transaction)
Overwrite triples from the handle as the
specified graph.
|
void |
GraphManager.writeAs(String uri,
Object graphData)
Overwrite triples from the graphData object as the specified graph.
|
void |
GraphManager.writeAs(String uri,
Object graphData,
GraphPermissions permissions)
Overwrite triples from the graphData object and specified
permissions as the specified graph.
|
void |
GraphManager.writeAs(String uri,
Object graphData,
GraphPermissions permissions,
Transaction transaction)
Overwrite triples from the graphData object and specified
permissions as the specified graph.
|
void |
GraphManager.writeAs(String uri,
Object graphData,
Transaction transaction)
Overwrite triples from the graphData object as the specified graph.
|
void |
GraphManager.writePermissions(String uri,
GraphPermissions permissions)
Overwrite all permissions for the graph.
|
void |
GraphManager.writePermissions(String uri,
GraphPermissions permissions,
Transaction transaction)
Overwrite all permissions for the graph.
|
Copyright © 2013-2017 MarkLogic Corporation.