- abbreviate() - Method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns the standard abbreviation for the cardinality value.
- abs(XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the absolute value of arg.
- AbstractReadHandle - Interface in com.marklogic.client.io.marker
-
A Read Handle defines a representation for reading database content.
- AbstractWriteHandle - Interface in com.marklogic.client.io.marker
-
A Write Handle defines a representation for writing database content.
- acos(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
- add(String, AbstractWriteHandle) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- add(String, DocumentMetadataWriteHandle, AbstractWriteHandle) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- add(WriteEvent...) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Add docs in the form of WriteEvents.
- add(Number) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to add to an existing value.
- add(String, AbstractWriteHandle) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri) and contents provided by the handle
- add(String, DocumentMetadataWriteHandle, AbstractWriteHandle) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri), metadata, and contents provided by the handle
- add(DocumentDescriptor, AbstractWriteHandle) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given uri template, and contents provided by the handle
- add(DocumentDescriptor, DocumentMetadataWriteHandle, AbstractWriteHandle) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given uri template, metadata, and contents provided by the handle
- add(String, AbstractWriteHandle, String) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri), temporalDocumentURI and contents provided by the handle
- add(String, DocumentMetadataWriteHandle, AbstractWriteHandle, String) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents provided by the handle
- add(DocumentDescriptor, AbstractWriteHandle, String) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given uri template, temporalDocumentURI and contents provided by the handle
- add(DocumentDescriptor, DocumentMetadataWriteHandle, AbstractWriteHandle, String) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given uri template, metadata, temporalDocumentURI and contents provided by the handle
- add(XsNumericExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns the sum of the specified numeric expressions.
- add(String, String) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentMetadataValues
-
Adds metadata-value that can be written for the document.
- add(String, DocumentMetadataHandle.Capability...) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentPermissions
-
Adds a role with one or more capabilities to the metadata that can be written for the document.
- add(String, String) - Method in class com.marklogic.client.util.RequestParameters
-
Appends a value to the list for a parameter.
- add(String, String...) - Method in class com.marklogic.client.util.RequestParameters
-
Appends a list of values to the list for a parameter.
- add64(XsUnsignedLongExpr, XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Add two 64-bit integer values, discarding overflow.
- addAll(String...) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentCollections
-
Adds one or more collections to the metadata that can be written for the document.
- addAs(String, Object) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- addAs(String, DocumentMetadataWriteHandle, Object) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- addAs(String, Object) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri) and contents.
- addAs(String, DocumentMetadataWriteHandle, Object) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri), metadata, and contents.
- addAs(String, Object, String) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri), temporalDocumentURI and contents.
- addAs(String, DocumentMetadataWriteHandle, Object, String) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents.
- addCollection(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds the specified collections.
- addConfigurator(DatabaseClientFactory.ClientConfigurator<?>) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Adds a listener that provides custom configuration when a communication library is created.
- addDefault(DocumentMetadataWriteHandle) - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Sets the default metadata for this write set for all documents added after this call
- addMetadataValue(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a new metadata-value
- addNamespace(String, String) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Add a single namespace prefix-to-uri mapping to the namespace context.
- addParameter(String, String) - Method in class com.marklogic.client.document.ServerTransform
-
Appends a value to the list for a parameter and returns this instance for method chaining.
- addPermission(String, String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
adds a permission to this module
- addPermission(String, DocumentMetadataHandle.Capability...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a role with the specified capabilities
- addPrefix(String, String) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Creates a namespace binding on the server.
- addPropertyValue(String, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a new metadata property with a simple name.
- addPropertyValue(QName, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a new metadata property with a namespaced name.
- addVariable(String, String) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the code executing server-side.
- addVariable(String, Number) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the code executing server-side.
- addVariable(String, Boolean) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the code executing server-side.
- addVariable(String, AbstractWriteHandle) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the code executing server-side.
- addVariableAs(String, Object) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Convenience method to set a variable of a type mapped to an io handle.
- adjustDateTimeToTimezone(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all.
- adjustDateTimeToTimezone(XsDateTimeExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all.
- adjustDateTimeToTimezone(XsDateTimeExpr, XsDayTimeDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all.
- adjustDateToTimezone(XsDateExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:date value to a specific timezone, or to no timezone at all.
- adjustDateToTimezone(XsDateExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:date value to a specific timezone, or to no timezone at all.
- adjustDateToTimezone(XsDateExpr, XsDayTimeDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:date value to a specific timezone, or to no timezone at all.
- adjustTimeToTimezone(XsTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:time value to a specific timezone, or to no timezone at all.
- adjustTimeToTimezone(XsTimeExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:time value to a specific timezone, or to no timezone at all.
- adjustTimeToTimezone(XsTimeExpr, XsDayTimeDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:time value to a specific timezone, or to no timezone at all.
- adminPassword - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- adminUser - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- AggregateResult - Class in com.marklogic.client.query
-
A CountedDistinctValue is a value that includes a frequency.
- AggregateResult() - Constructor for class com.marklogic.client.query.AggregateResult
-
- aggregateSeq(PlanAggregateCol...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- ALL_CONTENT - Static variable in interface com.marklogic.client.util.RequestLogger
-
Indicates that all content is copied to the log.
- ALL_VALUES_FROM - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- AllCookbookExamples - Class in com.marklogic.client.example.cookbook
-
AllCookbookExamples executes all of the recipe examples in the cookbook.
- AllCookbookExamples() - Constructor for class com.marklogic.client.example.cookbook.AllCookbookExamples
-
- analyzeString(String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
- analyzeString(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
- analyzeString(String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
- analyzeString(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
- and(XsAnyAtomicTypeExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the specified expressions all return true.
- and(StructuredQueryDefinition...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- and(StructuredQueryDefinition...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines an AND query over the list of query definitions.
- and64(XsUnsignedLongExpr, XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
AND two 64-bit integer values.
- andNot(StructuredQueryDefinition, StructuredQueryDefinition) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- andNot(StructuredQueryDefinition, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines an AND NOT query combining a positive and negative query.
- andNotQuery(CtsQueryExpr, CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the set difference of the matches specified by two sub-queries.
- andQuery(CtsQueryExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of the matches specified by the sub-queries.
- andQuery(CtsQuerySeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of the matches specified by the sub-queries.
- andQuery(CtsQuerySeqExpr, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of the matches specified by the sub-queries.
- andQuery(CtsQuerySeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of the matches specified by the sub-queries.
- ANY - Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The ANY SSLHostnameVerifier allows any hostname, which can be useful during initial development when a valid SSL certificate is not available but is not recommended for production because it would permit an invalid SSL certificate.
- anyAtomicTypeSeq(XsAnyAtomicTypeExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsAnyAtomicTypeExpr items.
- anyURI(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:anyURI server data type.
- anyURI(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a uri as a string and constructs an xs:anyURI value
- anyURISeq(XsAnyURIExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsAnyURIExpr items.
- anyURISeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of uris as a string and constructs an xs:anyURI sequence
- anyURISeq(XsAnyURIVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:anyURI values and constructs an xs:anyURI sequence
- appendToNCName(boolean, int, StringBuilder) - Static method in class com.marklogic.client.example.extension.NameConverter
-
- apply(BatchManager.BatchRequest) - Method in class com.marklogic.client.example.extension.BatchManager
-
- applyLibrary(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls a function with no arguments other than the existing fragment.
- applyLibraryFragments(String, Object...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls a function with the existing fragment and one or more specified fragments.
- applyLibraryValues(String, Object...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls a function with the existing fragment and one or more values.
- ApplyTransformListener - Class in com.marklogic.client.datamovement
-
- ApplyTransformListener() - Constructor for class com.marklogic.client.datamovement.ApplyTransformListener
-
- ApplyTransformListener.ApplyResult - Enum in com.marklogic.client.datamovement
-
- array() - Method in interface com.marklogic.client.expression.JsonExpr
-
Creates a (JSON) array, which is like a sequence of values, but allows for nesting.
- array(ElementNodeExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Creates a (JSON) array, which is like a sequence of values, but allows for nesting.
- arrayAggregate(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
- arrayAggregate(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
- arrayAggregate(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
- arrayAggregate(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
- ArrayNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON array node expression.
- ArrayNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON array node expressions.
- arraySeq(JsonArrayExpr...) - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs a sequence of JsonArrayExpr items.
- arraySize(JsonArrayExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the size of the array.
- arrayValues(JsonArrayExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the array values as an XQuery sequence.
- arrayValues(JsonArrayExpr, boolean) - Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the array values as an XQuery sequence.
- arrayValues(JsonArrayExpr, XsBooleanExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the array values as an XQuery sequence.
- as(String, ItemSeqExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function defines a column by assigning the value of an expression over the rows in the row set.
- as(PlanColumn, ItemSeqExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function defines a column by assigning the value of an expression over the rows in the row set.
- asc(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the specified columndef in ascending order.
- asc(PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the specified columndef in ascending order.
- asin(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
- asParameters() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Constructs request parameters expressing the extension metadata.
- atan(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc tangent of x, in radians.
- atan2(XsDoubleExpr, double) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
- atan2(XsDoubleExpr, XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
- attribute(QName) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a namespaced attribute to match with a query.
- attribute(String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a simple attribute to match with a query.
- AttributeNodeExpr - Interface in com.marklogic.client.type
-
An instance of an XML attribute node expression.
- AttributeNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of XML attribute node expressions.
- authType - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- avg(XsAnyAtomicTypeSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the average of the values in the input sequence arg, that is, the sum of the values divided by the number of values.
- avg(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of the column for the rows in the group or row set.
- avg(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of the column for the rows in the group or row set.
- avg(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of the column for the rows in the group or row set.
- avg(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of the column for the rows in the group or row set.
- awaitCompletion() - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Blocks until the job is complete.
- awaitCompletion(long, TimeUnit) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Blocks until the job is complete.
- awaitCompletion() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Blocks until the job has finished or cancelled all queued tasks.
- awaitCompletion(long, TimeUnit) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Blocks until the job has finished or cancelled all queued tasks.
- axis(String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- call() - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
A factory method for building calls to modify an existing node by applying built-in functions or functions from a library.
- Capability - Enum in com.marklogic.client.semantics
-
The permission capabilities available for operations on graphs.
- caseExpr(PlanCase...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns the specified valueExpression if the specified valueExpression is true.
- castableAs(XsStringExpr, String, ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns true if a value is castable.
- castableAs(XsStringExpr, XsStringExpr, ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns true if a value is castable.
- ceil(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the smallest integer greater than or equal to x.
- ceiling(XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of arg.
- CertificateAuthContext(SSLContext) - Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed.
- CertificateAuthContext(SSLContext, DatabaseClientFactory.SSLHostnameVerifier) - Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed and assigns the SSLHostnameVerifier passed to be used for checking host names.
- CertificateAuthContext(String) - Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext with a PKCS12 file.
- CertificateAuthContext(String, String) - Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext with a PKCS12 file.
- check() - Method in class com.marklogic.client.example.handle.URIHandle
-
- check(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- check(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- checkDictionaries(String...) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- checkProperties(Properties) - Static method in class com.marklogic.client.example.util.Bootstrapper
-
- circle(double, CtsPointExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial circle value.
- circle(XsDoubleVal, CtsPointExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial circle value.
- circle(double, double, double) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- circle(StructuredQueryBuilder.Point, double) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- circle(double, double, double) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a circle, supplying coordinates for the center.
- circle(StructuredQueryBuilder.Point, double) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a circle, supplying a point for the center.
- circleSeq(CtsCircleExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsCircleExpr items.
- clear() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Removes all namespace bindings.
- clear() - Method in class com.marklogic.client.util.RequestParameters
-
Removes all parameters.
- clearBindings() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Remove all variable bindings from the child SPARQLBindings instance.
- clearHandleRegistry() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Removes the current registered associations so the handle registry is empty.
- clearHandleRegistry() - Static method in class com.marklogic.client.DatabaseClientFactory
-
Removes the current registered associations so the handle registry is empty.
- clearMetadataCategories() - Method in interface com.marklogic.client.document.DocumentManager
-
Clears the metadata categories.
- clearPageLength() - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Reset this instance to have no page length set.
- ClientCreator - Class in com.marklogic.client.example.cookbook
-
ClientCreator illustrates how to create a database client.
- ClientCreator() - Constructor for class com.marklogic.client.example.cookbook.ClientCreator
-
- close() - Method in interface com.marklogic.client.document.DocumentPage
-
Frees the underlying resources, including the http connection.
- close() - Method in interface com.marklogic.client.eval.EvalResultIterator
-
- close() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- close() - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- close() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResultIterator
-
Closes the iterator when no longer needed.
- close() - Method in class com.marklogic.client.io.InputSourceHandle
-
Always call close() when finished with this handle – it closes the underlying InputStream.
- close() - Method in class com.marklogic.client.io.InputStreamHandle
-
Either call close() or get().close() when finished with this handle to close the underlying InputStream.
- close() - Method in class com.marklogic.client.io.JacksonParserHandle
-
Always call close() when finished with this handle – it closes the underlying InputStream.
- close() - Method in class com.marklogic.client.io.ReaderHandle
-
Either call close() or get().close() when finished with this handle to close the underlying Reader.
- close() - Method in class com.marklogic.client.io.SourceHandle
-
Always call close() when finished with this handle – it closes the underlying InputStream.
- close() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Either call close() or get().close() when finished with this handle to close the underlying InputStream.
- close() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Closes the XMLStreamReader and the InputStream, if any, used to populate the XMLStreamReader.
- close() - Method in interface com.marklogic.client.pojo.PojoPage
-
Frees the underlying resources, including the http connection.
- close() - Method in interface com.marklogic.client.util.RequestLogger
-
Close the log.
- coalesce(ItemExpr...) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns the value of the first argument that evaluates without error.
- codepointEqual(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified parameters are the same Unicode code point, otherwise returns false.
- codepointEqual(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified parameters are the same Unicode code point, otherwise returns false.
- codepointsToString(XsIntegerSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Creates an xs:string from a sequence of Unicode code points.
- col(String) - Method in interface com.marklogic.client.expression.PlanBuilder.AccessPlan
-
This method identifies a column, where the column name is unique.
- col(XsStringVal) - Method in interface com.marklogic.client.expression.PlanBuilder.AccessPlan
-
This method identifies a column, where the column name is unique.
- col(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This method identifies a column, where the column name is unique.
- col(XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
This method identifies a column, where the column name is unique.
- collatedString(XsStringExpr, String) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an rdf:collatedString value with the given value and collation tag.
- collatedString(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an rdf:collatedString value with the given value and collation tag.
- collect(String, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(String, long, String) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collect(StructuredQueryDefinition, long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- collection(String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- collection(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents belonging to at least one of the criteria collections.
- collectionConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents belonging to at least one of the criteria collections with the specified constraint.
- collectionQuery(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the collections with the given URIs.
- collectionQuery(XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the collections with the given URIs.
- collectionReference() - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to the collection lexicon, for use as a parameter to cts:value-tuples.
- collectionReference(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to the collection lexicon, for use as a parameter to cts:value-tuples.
- collectionReference(XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to the collection lexicon, for use as a parameter to cts:value-tuples.
- colSeq(String...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- colSeq(PlanExprCol...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- com.marklogic.client - package com.marklogic.client
-
The package provides the core classes, interfaces and exceptions for working with the database.
- com.marklogic.client.admin - package com.marklogic.client.admin
-
The package provides the classes for configuration and initialization of the REST server.
- com.marklogic.client.alerting - package com.marklogic.client.alerting
-
A REST interface to MarkLogic alerting capabilities.
- com.marklogic.client.bitemporal - package com.marklogic.client.bitemporal
-
- com.marklogic.client.datamovement - package com.marklogic.client.datamovement
-
The MarkLogic Data Movement SDK supports long-running write, read, delete, or transform jobs.
- com.marklogic.client.document - package 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.eval - package com.marklogic.client.eval
-
- com.marklogic.client.example.cookbook - package com.marklogic.client.example.cookbook
-
The package provides examples for common actions in working with the database.
- com.marklogic.client.example.cookbook.datamovement - package com.marklogic.client.example.cookbook.datamovement
-
- com.marklogic.client.example.extension - package com.marklogic.client.example.extension
-
The package provides examples of extensions that operate on a batch of database documents.
- com.marklogic.client.example.handle - package com.marklogic.client.example.handle
-
The package provides examples of extensions that read or write database documents in a new way or with a new representation.
- com.marklogic.client.example.util - package com.marklogic.client.example.util
-
The package provides utilities for bootstrapping and tearing down a MarkLogic REST instance.
- com.marklogic.client.expression - package com.marklogic.client.expression
-
The package provides classes for building Optic plan pipelines and expressions for execution on the REST server.
- com.marklogic.client.extensions - package com.marklogic.client.extensions
-
The package provides base and support classes so you can derive a new Resource Manager to provide a client interface for a Resource Services extension on the REST server.
- com.marklogic.client.extra.dom4j - package com.marklogic.client.extra.dom4j
-
The package provides an adapter for using the dom4j Open Source library to read and write XML documents, XML structured search, and other XML data structures.
- com.marklogic.client.extra.gson - package com.marklogic.client.extra.gson
-
The package provides an adapter for using the GSON Open Source library to read and write JSON documents, JSON structured search, and other JSON input and output.
- com.marklogic.client.extra.httpclient - package com.marklogic.client.extra.httpclient
-
The package supports optional configuration of the Open Source HttpClient library.
- com.marklogic.client.extra.jdom - package com.marklogic.client.extra.jdom
-
The package provides an adapter for using the JDOM Open Source library to read and write XML documents, XML structured search, and other XML data structures.
- com.marklogic.client.extra.xom - package com.marklogic.client.extra.xom
-
The package provides an adapter for using the XOM Open Source library to read and write XML documents, XML structured search, and other XML data structures.
- com.marklogic.client.io - 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.
- com.marklogic.client.io.marker - package com.marklogic.client.io.marker
-
The package provides marker interfaces for reading and writing each kind of document format.
- com.marklogic.client.pojo - package 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.pojo.annotation - package com.marklogic.client.pojo.annotation
-
- com.marklogic.client.pojo.util - package com.marklogic.client.pojo.util
-
- com.marklogic.client.query - package com.marklogic.client.query
-
The package provides classes for queries including searching documents and reading values directly from indexes in the database for the REST server.
- com.marklogic.client.row - package com.marklogic.client.row
-
The package provides classes for sending plan requests to and processing row responses from the REST server.
- com.marklogic.client.semantics - package com.marklogic.client.semantics
-
- com.marklogic.client.type - package com.marklogic.client.type
-
The package provides interfaces specifying the type of an expression or value as passed to a
PlanBuilder method or returned from a
RowRecord method.
- com.marklogic.client.util - package com.marklogic.client.util
-
The package provides loggers, specialized maps, and other utilities shared across other packages.
- CommentNodeExpr - Interface in com.marklogic.client.type
-
An instance of an XML comment node expression.
- CommentNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of XML comment node expressions.
- commit() - Method in interface com.marklogic.client.Transaction
-
Completes the transaction, making writes and deletes visible to other database clients.
- COMMON - Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The COMMON SSLHostnameVerifier applies common rules for checking hostnames during SSL authentication (similar to org.apache.http.conn.ssl.BrowserCompatHostnameVerifier).
- compare(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
- compare(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
- compare(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
- compare(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
- compileXPath(String) - Method in class com.marklogic.client.io.DOMHandle
-
Compile an XPath string expression for efficient evaluation later.
- concat(XsAnyAtomicTypeExpr...) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the xs:string that is the concatenation of the values of the specified parameters.
- concatenateAfter(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to append an existing string to the supplied string.
- concatenateBefore(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to concatenate an existing string before the supplied string.
- concatenateBetween(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to concatenate an existing string between the supplied strings.
- ConfigServer(Properties) - Constructor for class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
Construct the configuration server specification based on properties.
- ConfigServer(String, int, String, String, DatabaseClientFactory.Authentication) - Constructor for class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
Construct the configuration server specification programmatically.
- configure(T) - Method in interface com.marklogic.client.DatabaseClientFactory.ClientConfigurator
-
Called as the last step in configuring the communication library.
- configure(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- configure(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- configureExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- configureQueryOptions(DatabaseClient) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- containerConstraint(String, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a query within the substructure of the container specified by the constraint.
- containerQuery(String, StructuredQueryDefinition) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- containerQuery(StructuredQueryBuilder.ContainerIndex, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a query within the substructure contained by an element or JSON property.
- containerQueryBuilder(String, Class<C>) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Use this method to provide a query builder that can query a nested object within your pojo.
- contains(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
- contains(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
- contains(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
- contains(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
- contains(MapMapExpr, String) - Method in interface com.marklogic.client.expression.MapExpr
-
Returns true if the key exists in the map.
- contains(MapMapExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.MapExpr
-
Returns true if the key exists in the map.
- containsKey(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Checks whether a prefix has a binding.
- containsKey(String) - Method in interface com.marklogic.client.util.NameMap
-
Whether the map contains the string name as a key.
- containsKey(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Checks whether the parameter name has been specified.
- containsValue(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Checks whether a namespace URI has a binding.
- containsValue(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Checks whether any parameters have the value.
- ContentDescriptor - Interface in com.marklogic.client.document
-
A Content Descriptor identifies the properties of some content.
- ContentHandle<C> - Interface in com.marklogic.client.io.marker
-
A Content Handle provides get / set access to a representation of content such a byte[] array, input stream, file, reader, string, and so on.
- ContentHandleFactory - Interface in com.marklogic.client.io.marker
-
A ContentHandleFactory creates instances of a ContentHandle that provides an adapter for an IO representation.
- convert(RawQueryByExampleDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Sends a query by example to the server to convert into a combined query that expresses the criteria as a structured search.
- copy() - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Create a copy of the current registry
- copy(String) - Method in class com.marklogic.client.util.RequestParameters
-
Creates a copy of the parameters, prepending a namespace prefix to each parameter name.
- copyContent(T) - Method in interface com.marklogic.client.util.RequestLogger
-
Copies content to the log during request processing up to the length limit specified for the logger.
- correlation(JsonArraySeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the Pearson correlation coefficient of a data set.
- cos(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the cosine of x, in the range from -1 to +1 (inclusive).
- cosh(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the hyperbolic cosine of x.
- cot(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the cotangent of x.
- count(ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number of items in the value of arg.
- count(ItemSeqExpr, double) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number of items in the value of arg.
- count(ItemSeqExpr, XsDoubleExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number of items in the value of arg.
- count(MapMapExpr) - Method in interface com.marklogic.client.expression.MapExpr
-
Returns the number of keys used in the map.
- count(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the specified input column has a value.
- count(PlanColumn) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the specified input column has a value.
- count(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the specified input column has a value.
- count(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the specified input column has a value.
- count(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the specified input column has a value.
- count(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the specified input column has a value.
- count() - Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of documents of the type managed by this PojoRepository persisted in the database
- count(Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
In the context of transaction, the number of documents of the type managed by this PojoRepository persisted in the database
- count(String...) - Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of documents of the type managed by this PojoRepository persisted in the database with at least one of the criteria collections
- count(String[], Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
In the context of transaction, the number of documents of the type managed by this PojoRepository persisted in the database with at least one of the criteria collections
- count(PojoQueryDefinition) - Method in interface com.marklogic.client.pojo.PojoRepository
-
- count(PojoQueryDefinition, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
In the context of transaction, the number of documents of the type managed by this PojoRepository persisted in the database which match the query
- CountedDistinctValue - Class in com.marklogic.client.query
-
A CountedDistinctValue is a value that includes a frequency.
- CountedDistinctValue() - Constructor for class com.marklogic.client.query.CountedDistinctValue
-
- covariance(JsonArraySeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sample covariance of a data set.
- covarianceP(JsonArraySeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the population covariance of a data set.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
create but create document at a specific system time
- create(DocumentUriTemplate, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server.
- create(DocumentUriTemplate, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server as transformed on the server.
- create(DocumentUriTemplate, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server in an open database transaction.
- create(DocumentUriTemplate, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server in an open database transaction as transformed on the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and content and a uri assigned by the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
- createAs(DocumentUriTemplate, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createAs(DocumentUriTemplate, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createAs(DocumentUriTemplate, DocumentMetadataWriteHandle, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createAs(DocumentUriTemplate, DocumentMetadataWriteHandle, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned by the server from an object of an IO class.
- createDictionary(String, String[]) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- crypt(XsStringExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the password hash for the given password and salt.
- crypt(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the password hash for the given password and salt.
- crypt2(XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the password hash for the given plain-text password.
- cts - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with cts server functions.
- CtsBoxExpr - Interface in com.marklogic.client.type
-
An instance of a cts.box expression.
- CtsBoxSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.box expressions.
- CtsCircleExpr - Interface in com.marklogic.client.type
-
An instance of a cts.circle expression.
- CtsCircleSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.circle expressions.
- CtsExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the cts server library for a row pipeline.
- CtsPeriodExpr - Interface in com.marklogic.client.type
-
An instance of a cts.period expression.
- CtsPeriodSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.period expressions.
- CtsPointExpr - Interface in com.marklogic.client.type
-
An instance of a cts.point expression.
- CtsPointSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.point expressions.
- CtsPolygonExpr - Interface in com.marklogic.client.type
-
An instance of a cts.polygon expression.
- CtsPolygonSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.polygon expressions.
- CtsQueryExpr - Interface in com.marklogic.client.type
-
An instance of a cts.query expression.
- CtsQuerySeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.query expressions.
- CtsReferenceExpr - Interface in com.marklogic.client.type
-
An instance of a cts.reference expression.
- CtsReferenceSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.reference expressions.
- CtsRegionExpr - Interface in com.marklogic.client.type
-
An instance of a cts.region expression.
- CtsRegionSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.region expressions.
- currentDate() - Method in interface com.marklogic.client.expression.FnExpr
-
Returns xs:date(fn:current-dateTime()).
- currentDateTime() - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the current dateTime value (with timezone) from the dynamic context.
- currentTime() - Method in interface com.marklogic.client.expression.FnExpr
-
Returns xs:time(fn:current-dateTime()).
- customConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents as specified by a constraint that implements a custom query parameterized with the supplied text.
- DatabaseClient - Interface in com.marklogic.client
-
A Database Client instantiates document and query managers and other objects with shared access to a database.
- DatabaseClientFactory - Class in com.marklogic.client
-
A Database Client Factory configures a database client for making database requests.
- DatabaseClientFactory.Authentication - Enum in com.marklogic.client
-
- DatabaseClientFactory.BasicAuthContext - Class in com.marklogic.client
-
- DatabaseClientFactory.Bean - Class in com.marklogic.client
-
A Database Client Factory Bean provides an object for specifying configuration before creating a client to make database requests.
- DatabaseClientFactory.CertificateAuthContext - Class in com.marklogic.client
-
- DatabaseClientFactory.ClientConfigurator<T> - Interface in com.marklogic.client
-
A ClientConfigurator provides custom configuration for the communication library used to sending client requests and receiving server responses.
- DatabaseClientFactory.DigestAuthContext - Class in com.marklogic.client
-
- DatabaseClientFactory.HandleFactoryRegistry - Interface in com.marklogic.client
-
A HandleFactoryRegistry associates IO representation classes with handle factories.
- DatabaseClientFactory.KerberosAuthContext - Class in com.marklogic.client
-
- DatabaseClientFactory.SecurityContext - Interface in com.marklogic.client
-
- DatabaseClientFactory.SSLHostnameVerifier - Interface in com.marklogic.client
-
An SSLHostnameVerifier checks whether a hostname is acceptable during SSL authentication.
- DatabaseClientFactory.SSLHostnameVerifier.Builtin - Class in com.marklogic.client
-
Builtin supports builtin implementations of SSLHostnameVerifier.
- DatabaseClientSingleton - Class in com.marklogic.client.example.cookbook.datamovement
-
- DataMovementException - Exception in com.marklogic.client.datamovement
-
The generic base exception used throughout the Data Movement SDK.
- DataMovementException(String, Throwable) - Constructor for exception com.marklogic.client.datamovement.DataMovementException
-
- DataMovementManager - Interface in com.marklogic.client.datamovement
-
DataMovementManager is the starting point for getting new instances of QueryBatcher and WriteBatcher, configured with a DatabaseClient and ForestConfiguration.
- datatype(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns the name of the simple type of the atomic value argument as a SPARQL style IRI.
- date(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:date server data type.
- date(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a date in a string format based on ISO 8601 and constructs an xs:date value
- date(Calendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a date as a Calendar value and constructs an xs:date value
- date(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a date as an XMLGregorianCalendar value and constructs an xs:date value
- dateadd(XsStringExpr, int, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
- dateadd(XsStringExpr, XsIntExpr, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
- datediff(XsStringExpr, ItemExpr, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.
- datepart(XsStringExpr, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an integer that represents the specified datepart of the specified date.
- dateSeq(XsDateExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsDateExpr items.
- dateSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of dates in a string format based on ISO 8601 and constructs an xs:date sequence
- dateSeq(Calendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of dates as Calendar values and constructs an xs:date sequence
- dateSeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of dates as XMLGregorianCalendar values and constructs an xs:date sequence
- dateSeq(XsDateVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:date values and constructs an xs:date sequence
- dateTime(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:dateTime server data type.
- dateTime(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp in a string format based on ISO 8601 and constructs an xs:dateTime value
- dateTime(Date) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp as a Date value and constructs an xs:dateTime value
- dateTime(Calendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp as a Calendar value and constructs an xs:dateTime value
- dateTime(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp as an XMLGregorianCalendar value and constructs an xs:dateTime value
- dateTimeSeq(XsDateTimeExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsDateTimeExpr items.
- dateTimeSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps in a string format based on ISO 8601 and constructs an xs:dateTime sequence
- dateTimeSeq(Date...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps as Date values and constructs an xs:dateTime sequence
- dateTimeSeq(Calendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps as Calendar values and constructs an xs:dateTime sequence
- dateTimeSeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps as XMLGregorianCalendar values and constructs an xs:dateTime sequence
- dateTimeSeq(XsDateTimeVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:dateTime values and constructs an xs:dateTime sequence
- day(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
- dayFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
- dayFromDateTime(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
- dayname(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:string representing the dayname value in the localized value of arg.
- daynameFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an xs:string representing the dayname value in the localized value of arg.
- daysFromDuration(XsDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer representing the days component in the canonical lexical representation of the value of arg.
- dayTimeDuration(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:dayTimeDuration server data type.
- dayTimeDuration(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a duration of increments of a day or less in a string format based on ISO 8601 and constructs an xs:dayTimeDuration value
- dayTimeDuration(Duration) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a duration in increments of a day or less as a Duration value and constructs an xs:dayTimeDuration value
- dayTimeDurationSeq(XsDayTimeDurationExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsDayTimeDurationExpr items.
- dayTimeDurationSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of duration in increments of a day or less as a string and constructs an xs:dayTimeDuration sequence
- dayTimeDurationSeq(Duration...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of duration in increments of a day or less as a Duration and constructs an xs:dayTimeDuration sequence
- dayTimeDurationSeq(XsDayTimeDurationVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:dayTimeDuration values and constructs an xs:dayTimeDuration sequence
- decimal(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:decimal server data type.
- decimal(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a decimal string and constructs an xs:decimal value
- decimal(long) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a long primitive and constructs an xs:decimal value
- decimal(double) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a double primitive and constructs an xs:decimal value
- decimal(BigDecimal) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a BigDecimal value and constructs an xs:decimal value
- decimalSeq(XsDecimalExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsDecimalExpr items.
- decimalSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a string and constructs an xs:decimal sequence
- decimalSeq(long...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a long primitive and constructs an xs:decimal sequence
- decimalSeq(double...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a double primitive and constructs an xs:decimal sequence
- decimalSeq(BigDecimal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a BigDecimal value and constructs an xs:decimal sequence
- decimalSeq(XsDecimalVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:decimal values and constructs an xs:decimal sequence
- decodeFromNCName(XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
- deepEqual(ItemSeqExpr, ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
This function assesses whether two sequences are deep-equal to each other.
- deepEqual(ItemSeqExpr, ItemSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
This function assesses whether two sequences are deep-equal to each other.
- deepEqual(ItemSeqExpr, ItemSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
This function assesses whether two sequences are deep-equal to each other.
- DEFAULT_GRAPH - Static variable in interface com.marklogic.client.semantics.GraphManager
-
Use with any GraphManager method in place of the uri to work against
the default graph.
- DEFAULT_PAGE_LENGTH - Static variable in interface com.marklogic.client.query.QueryManager
-
The default maximum number of documents in a page of search results.
- defaultCollation() - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of the default collation property from the static context.
- degrees(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns numeric expression converted from radians to degrees.
- delete(String) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Removes a library asset from the server.
- delete(ExtensionLibraryDescriptor) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Removes a library asset from the server.
- delete(String) - Method in interface com.marklogic.client.alerting.RuleManager
-
Removes a rule from the server.
- delete(DocumentDescriptor, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- delete(String, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- delete(DocumentDescriptor, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
delete but delete document at a specified system time
- delete(String, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
delete but delete document at a specified system time
- delete(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from the database
- delete(String, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from an open database transaction
- delete(String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the documents’ metadata and content
- delete(Transaction, String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the documents’ metadata and content from an open database transaction
- delete(DocumentDescriptor) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from the database
- delete(DocumentDescriptor, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from an open database transaction
- delete(String) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies an operation to delete an existing JSON or XML fragment.
- delete(String, DocumentMetadataPatchBuilder.Cardinality) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies an operation to delete an existing JSON or XML fragment.
- delete(RequestParameters, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Deletes content by calling a DELETE service.
- delete(RequestParameters, Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Deletes content by calling a DELETE service.
- delete(ID...) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Deletes from the database the persisted pojo instances with the corresponding ids
- delete(ID[], Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
As part of transaction, deletes from the database the documents with the corresponding ids
- delete(DeleteQueryDefinition) - Method in interface com.marklogic.client.query.QueryManager
-
Deletes documents based on the query criteria.
- delete(DeleteQueryDefinition, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Deletes documents based on the query criteria as part of the specified transaction.
- delete(String) - Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete the specified graph from the server.
- delete(String, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete the specified graph from the server.
- deleteAll() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Deletes all namespace bindings on the server.
- deleteAll() - Method in interface com.marklogic.client.pojo.PojoRepository
-
Deletes from the database all documents of the type managed by this PojoRepositoryof type T persisted by the pojo facade
- deleteAll(Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
As part of transaction, deletes from the database all documents of the type managed by this PojoRepositoryof type T persisted by the pojo facade
- deleteCollection(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified collections.
- deleteDictionary(String) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- deleteDocuments() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- deleteGraph(DatabaseClient) - Static method in class com.marklogic.client.example.extension.GraphSPARQLExample
-
- deleteGraphs() - Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete all quads from all graphs.
- deleteGraphs(Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete all quads from all graphs.
- DeleteListener - Class in com.marklogic.client.datamovement
-
Sends a Java API bulk
delete request for all the documents from each batch.
- DeleteListener() - Constructor for class com.marklogic.client.datamovement.DeleteListener
-
- deleteMetadataValue(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata-value with the given key.
- deleteOptions(String) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Remove a search configuration from the REST server.
- deletePermission(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified roles.
- deletePermissions(String) - Method in interface com.marklogic.client.semantics.GraphManager
-
Delete all permissions for the graph.
- deletePermissions(String, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Delete all permissions for the graph.
- deletePrefix(String) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Deletes a namespace binding on the server.
- deleteProperty(String...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata properties with simple names.
- deleteProperty(QName...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata properties with namespaced names.
- DeleteQueryDefinition - Interface in com.marklogic.client.query
-
A DeleteQueryDefinition is a query definition suitable for use in performing a delete query.
- deleteServices(String) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Uninstalls the services that implement a resource.
- deleteTransform(String) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Uninstalls the transform.
- desc(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the specified columndef in descending order.
- desc(PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the specified columndef in descending order.
- describe(ItemSeqExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the description of a given item sequence.
- describe(ItemSeqExpr, XsUnsignedIntExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the description of a given item sequence.
- describe(ItemSeqExpr, XsUnsignedIntExpr, XsUnsignedIntExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the description of a given item sequence.
- diacriticLess(XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the specified string, converting all of the characters with diacritics to characters without diacritics.
- DictionaryManager(DatabaseClient) - Constructor for class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- DigestAuthContext(String, String) - Constructor for class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- directory(boolean, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents at the specified depth within at least one of the criteria directories.
- directory(int, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents at the specified depth within at least one of the criteria directories.
- directoryQuery(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the directories with the given URIs.
- directoryQuery(XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the directories with the given URIs.
- directoryQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the directories with the given URIs.
- directoryQuery(XsStringSeqVal, XsStringVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the directories with the given URIs.
- disableDefault() - Method in interface com.marklogic.client.document.DocumentWriteSet
-
Removes the default metadata for this write set for all documents added after this call
- distinctValues(XsAnyAtomicTypeSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence that results from removing from arg all but one of a set of values that are eq to one other.
- distinctValues(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence that results from removing from arg all but one of a set of values that are eq to one other.
- distinctValues(XsAnyAtomicTypeSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence that results from removing from arg all but one of a set of values that are eq to one other.
- divide(XsNumericExpr, XsNumericExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function divides the left numericExpression by the right numericExpression and returns the value.
- divideBy(Number) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to divide an existing value by the supplied number.
- document(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the specified documents.
- DocumentDelete - Class in com.marklogic.client.example.cookbook
-
DocumentDelete illustrates how to delete a database document.
- DocumentDelete() - Constructor for class com.marklogic.client.example.cookbook.DocumentDelete
-
- DocumentDescriptor - Interface in com.marklogic.client.document
-
A Document Descriptor describes a database document.
- DocumentFormats - Class in com.marklogic.client.example.cookbook
-
DocumentFormats illustrates working with documents in multiple or unknown formats.
- DocumentFormats() - Constructor for class com.marklogic.client.example.cookbook.DocumentFormats
-
- documentFragment(StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the content of documents (as opposed to the properties of documents).
- documentFragmentQuery(CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches all documents where query matches any document fragment.
- DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle> - Interface in com.marklogic.client.document
-
A Document Manager provides database operations on a document.
- DocumentManager.Metadata - Enum in com.marklogic.client.document
-
The Metadata enumeration specifies the categories of metadata read from or written to the database.
- DocumentMetadataHandle - Class in com.marklogic.client.io
-
A DocumentMetadataHandle represents the metadata for a database document.
- DocumentMetadataHandle() - Constructor for class com.marklogic.client.io.DocumentMetadataHandle
-
Zero-argument constructor.
- DocumentMetadataHandle.Capability - Enum in com.marklogic.client.io
-
A document operation restricted to users with a role.
- DocumentMetadataHandle.DocumentCollections - Interface in com.marklogic.client.io
-
Represents the collections for a database document.
- DocumentMetadataHandle.DocumentMetadataValues - Interface in com.marklogic.client.io
-
Represents the metadata-values for a database document.
- DocumentMetadataHandle.DocumentPermissions - Interface in com.marklogic.client.io
-
Represents the permissions for a database document.
- DocumentMetadataHandle.DocumentProperties - Interface in com.marklogic.client.io
-
Represents the properties for a database document.
- DocumentMetadataPatchBuilder - Interface in com.marklogic.client.document
-
A DocumentMetadataPatchBuilder specifies changes to the metadata of a database document.
- DocumentMetadataPatchBuilder.Call - Interface in com.marklogic.client.document
-
A Call specifies how to apply a built-in or library function when replacing an existing fragment.
- DocumentMetadataPatchBuilder.CallBuilder - Interface in com.marklogic.client.document
-
A CallBuilder constructs a Call to a built-in or library function to produce the replacement for an existing fragment.
- DocumentMetadataPatchBuilder.Cardinality - Enum in com.marklogic.client.document
-
The Cardinality enumeration indicates the number of times that a path can match without error (which defaults to ZERO_OR_MORE, meaning any number of matches).
- DocumentMetadataPatchBuilder.PatchHandle - Interface in com.marklogic.client.document
-
A PatchHandle produced by the builder can produce a string representation of the patch for saving, logging, or other uses.
- DocumentMetadataRead - Class in com.marklogic.client.example.cookbook
-
DocumentMetadataReader illustrates how to read the metadata and content of a database document in a single request.
- DocumentMetadataRead() - Constructor for class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- DocumentMetadataReadHandle - Interface in com.marklogic.client.io.marker
-
A Metadata Read Handle can represent metadata read from the database.
- DocumentMetadataWrite - Class in com.marklogic.client.example.cookbook
-
DocumentMetadataWriter illustrates how to write metadata and content to a database document in a single request.
- DocumentMetadataWrite() - Constructor for class com.marklogic.client.example.cookbook.DocumentMetadataWrite
-
- DocumentMetadataWriteHandle - Interface in com.marklogic.client.io.marker
-
A Document Metadata Write Handle can represent document metadata written to the database.
- DocumentNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON or XML document node expression.
- DocumentNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON or XML document node expressions.
- DocumentOutputStream - Class in com.marklogic.client.example.cookbook
-
DocumentOutputStream illustrates how to write content to a document using an OutputStream.
- DocumentOutputStream() - Constructor for class com.marklogic.client.example.cookbook.DocumentOutputStream
-
- DocumentPage - Interface in com.marklogic.client.document
-
Allows iteration over documents in the page as
DocumentRecord instances.
- DocumentPatchBuilder - Interface in com.marklogic.client.document
-
A DocumentPatchBuilder specifies changes to the metadata, content, or both of a database document.
- DocumentPatchBuilder.PathLanguage - Enum in com.marklogic.client.document
-
MarkLogic’s REST API patch operations support two path languages for JSON, XPATH and JSONPATH.
- DocumentPatchBuilder.Position - Enum in com.marklogic.client.document
-
The Position enumeration indicates the location relative to the context for inserting content.
- DocumentPatchHandle - Interface in com.marklogic.client.io.marker
-
A Document Patch Handle can represent a patch with changes to document metadata or structured content.
- documentQuery(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with the given URIs.
- documentQuery(XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with the given URIs.
- DocumentRead - Class in com.marklogic.client.example.cookbook
-
DocumentReader illustrates how to read the content of a database document.
- DocumentRead() - Constructor for class com.marklogic.client.example.cookbook.DocumentRead
-
- DocumentReadTransform - Class in com.marklogic.client.example.cookbook
-
DocumentReadTransform installs a server transform for converting XML documents with a known vocabulary to HTML documents for presentation.
- DocumentReadTransform() - Constructor for class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- DocumentRecord - Interface in com.marklogic.client.document
-
Each DocumentRecord represents one document, its uri, format, mime-type and possibly its metadata (collections, properties, quality, and permissions).
- DocumentSplitter - Class in com.marklogic.client.example.extension
-
DocumentSplitter provides an extension for splitting an input XML document into multiple documents.
- DocumentSplitter(DatabaseClient) - Constructor for class com.marklogic.client.example.extension.DocumentSplitter
-
- documentUri(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of the document-uri property for the specified node.
- DocumentUriTemplate - Interface in com.marklogic.client.document
-
A DocumentUriTemplate specifies how the server should construct a name for a document.
- DocumentWrite - Class in com.marklogic.client.example.cookbook
-
DocumentWriter illustrates how to write content to a database document.
- DocumentWrite() - Constructor for class com.marklogic.client.example.cookbook.DocumentWrite
-
- DocumentWriteOperation - Interface in com.marklogic.client.document
-
- DocumentWriteOperation.OperationType - Enum in com.marklogic.client.document
-
- DocumentWriteServerURI - Class in com.marklogic.client.example.cookbook
-
DocumentWriterServerURI illustrates how to write content, letting MarkLogic assign a server URI
- DocumentWriteServerURI() - Constructor for class com.marklogic.client.example.cookbook.DocumentWriteServerURI
-
- DocumentWriteSet - Interface in com.marklogic.client.document
-
- DocumentWriteTransform - Class in com.marklogic.client.example.cookbook
-
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.
- DocumentWriteTransform() - Constructor for class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- DOM4JHandle - Class in com.marklogic.client.extra.dom4j
-
A DOM4JHandle represents XML content as a dom4j document for reading or writing.
- DOM4JHandle() - Constructor for class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Zero-argument constructor.
- DOM4JHandle(Document) - Constructor for class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Provides a handle on XML content as a dom4j document structure.
- DOM4JHandleExample - Class in com.marklogic.client.example.handle
-
DOM4JHandleExample illustrates writing and reading content as a dom4j structure using the dom4j extra library.
- DOM4JHandleExample() - Constructor for class com.marklogic.client.example.handle.DOM4JHandleExample
-
- DOMAIN - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- DOMHandle - Class in com.marklogic.client.io
-
A DOM Handle represents XML content as a DOM document for reading or writing.
- DOMHandle() - Constructor for class com.marklogic.client.io.DOMHandle
-
Zero-argument constructor.
- DOMHandle(Document) - Constructor for class com.marklogic.client.io.DOMHandle
-
Initializes the handle with a DOM document for the content.
- doubleExpr(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:double server data type.
- doubleExprSeq(XsDoubleExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsDoubleExpr items.
- doubleMetaphone(XsStringExpr) - Method in interface com.marklogic.client.expression.SpellExpr
-
Given a word returns the two metaphone keys.
- doubleSeq(double...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of double primitives and constructs an xs:double sequence
- doubleSeq(XsDoubleVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:double values and constructs an xs:double sequence
- doubleVal(double) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a double primitive and constructs an xs:double value
- DraconianErrorHandler() - Constructor for class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
- EditableNamespaceContext - Class in com.marklogic.client.util
-
EditableNamespaceContext provides access to namespace bindings of prefixes and URIs and can act as a NamespaceContext.
- EditableNamespaceContext() - Constructor for class com.marklogic.client.util.EditableNamespaceContext
-
Constructs a NamespaceContext.
- element(QName) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a namespaced element to match with a query.
- element(String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a simple element to match with a query.
- elementAttribute(StructuredQueryBuilder.Element, StructuredQueryBuilder.Attribute) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies an element having an attribute to match with a query.
- elementAttributePairGeospatialQuery(String, String, String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(String, String, String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(String, String, String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementAttributeRangeQuery(String, String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
- elementAttributeRangeQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
- elementAttributeRangeQuery(String, String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
- elementAttributeRangeQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
- elementAttributeRangeQuery(String, String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
- elementAttributeRangeQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
- elementAttributeReference(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeReference(XsQNameVal, XsQNameVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeReference(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeReference(XsQNameVal, XsQNameVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeValueQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content equal a given phrase.
- elementAttributeWordQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content containing a given phrase.
- elementAttributeWordQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content containing a given phrase.
- elementAttributeWordQuery(String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content containing a given phrase.
- elementAttributeWordQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content containing a given phrase.
- elementAttributeWordQuery(String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content containing a given phrase.
- elementAttributeWordQuery(XsQNameSeqVal, XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with attributes by name with text content containing a given phrase.
- elementChildGeospatialQuery(String, String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(String, String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(String, String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementContentType(ElementNodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the schema-defined content-type of an element (“empty”, “simple”, “element-only”, or “mixed”).
- elementGeospatialQuery(String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(XsQNameSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- ElementNodeExpr - Interface in com.marklogic.client.type
-
An instance of an XML element node expression.
- ElementNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of XML element node expressions.
- elementPairGeospatialQuery(String, String, String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(String, String, String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(String, String, String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(XsQNameSeqVal, XsQNameSeqVal, XsQNameSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- elementQuery(String, CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with the content constrained by the given cts:query in the second parameter.
- elementQuery(XsQNameSeqVal, CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with the content constrained by the given cts:query in the second parameter.
- elementRangeQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
- elementRangeQuery(XsQNameSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
- elementRangeQuery(String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
- elementRangeQuery(XsQNameSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
- elementRangeQuery(String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
- elementRangeQuery(XsQNameSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching elements by name with a range-index entry equal to a given value.
- elementReference(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
- elementReference(XsQNameVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
- elementReference(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
- elementReference(XsQNameVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
- elementValueQuery(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(XsQNameSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(XsQNameSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementValueQuery(XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content equal a given phrase.
- elementWordQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content containing a given phrase.
- elementWordQuery(XsQNameSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content containing a given phrase.
- elementWordQuery(String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content containing a given phrase.
- elementWordQuery(XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content containing a given phrase.
- elementWordQuery(String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content containing a given phrase.
- elementWordQuery(XsQNameSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with text content containing a given phrase.
- elseExpr(ItemExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
- empty(ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
If the value of arg is the empty sequence, the function returns true; otherwise, the function returns false.
- encodeForNCName(XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Invertible function that escapes characters required to be part of an NCName.
- encodeForUri(XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Invertible function that escapes characters required to be escaped inside path segments of URIs.
- endsWith(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
- endsWith(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
- endsWith(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
- endsWith(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
- entry(XsStringExpr, ItemSeqExpr) - Method in interface com.marklogic.client.expression.MapExpr
-
Constructs a new map with a single entry consisting of the key and value specified as arguments.
- entrySet() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Gets the namespace bindings.
- entrySet() - Method in class com.marklogic.client.util.RequestParameters
-
Returns a set of parameter-list entries.
- eq(XsAnyAtomicTypeExpr, XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the left and right expressions return the same value.
- equals(Object) - Method in class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Returns whether the method declaration is the same.
- EQUIVALENT_CLASS - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- EQUIVALENT_PROPERTY - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- error(SAXParseException) - Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Throws the error as a parse exception.
- escapeHtmlUri(XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
%-escapes everything except printable ASCII characters.
- ETRS89 - Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to “etrs89”
- ETRS89DOUBLE - Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to “etrs89/double”
- eval(H) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Provides the single result of the server-side eval or invoke call, wrapped in an io handle.
- eval() - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Provides all results returned by the server-side eval or invoke call.
- evalAs(Class<T>) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Conveneince method to get the response serialized to a particular type by an io handle.
- EvalResult - Interface in com.marklogic.client.eval
-
Represents the content and metadata of a result from a call to
eval.
- EvalResult.Type - Enum in com.marklogic.client.eval
-
Convenience enum useful for strongly-typed comparison to ensure the result is of the type expected.
- EvalResultIterator - Interface in com.marklogic.client.eval
-
- evaluateXPath(String, Class<T>) - Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a string XPath expression against the retrieved document.
- evaluateXPath(String, Node, Class<T>) - Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a string XPath expression relative to a node such as a node returned by a previous XPath expression.
- evaluateXPath(XPathExpression, Class<T>) - Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a compiled XPath expression against the retrieved document.
- evaluateXPath(XPathExpression, Node, Class<T>) - Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a compiled XPath expression relative to a node such as a node returned by a previous XPath expression.
- ExampleProperties(Properties) - Constructor for class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- except(PlanBuilder.ModifyPlan) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method restricts the left row set to rows where a row with the same columns and values doesn’t exist in the right row set.
- executeAsk(SPARQLQueryDefinition) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “ASK” statement.
- executeAsk(SPARQLQueryDefinition, Transaction) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “ASK” statement.
- executeConstruct(SPARQLQueryDefinition, T) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “CONSTRUCT” statement.
- executeConstruct(SPARQLQueryDefinition, T, Transaction) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “CONSTRUCT” statement.
- executeDescribe(SPARQLQueryDefinition, T) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “DESCRIBE” query (which implements the Concise Bounded Description specification).
- executeDescribe(SPARQLQueryDefinition, T, Transaction) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “DESCRIBE” query (which implements the Concise Bounded Description specification).
- executeSelect(SPARQLQueryDefinition, T) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “SELECT” query.
- executeSelect(SPARQLQueryDefinition, T, Transaction) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “SELECT” query.
- executeSelect(SPARQLQueryDefinition, T, long) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “SELECT” query.
- executeSelect(SPARQLQueryDefinition, T, long, Transaction) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL “SELECT” query.
- executeUpdate(SPARQLQueryDefinition) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL update statement.
- executeUpdate(SPARQLQueryDefinition, Transaction) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL update statement.
- exists(String) - Method in interface com.marklogic.client.alerting.RuleManager
-
Tests for existence of rule on the REST server.
- exists(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Checks whether a document exists and gets its byte length, format, mimetype, and version if it does.
- exists(String, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Checks whether a document exists in an open transaction and gets its byte length, format, mimetype, and version if it does.
- exists(ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
If the value of arg is not the empty sequence, the function returns true; otherwise, the function returns false.
- exists(ID) - Method in interface com.marklogic.client.pojo.PojoRepository
-
True if a document exists in the database with the specified id
- exists(ID, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
True if in the context of transaction, a document exists in the database with the specified id
- exp(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns e (approximately 2.71828182845905) to the xth power.
- explain(PlanBuilder.Plan, T) - Method in interface com.marklogic.client.row.RowManager
-
Constructs a plan for retrieving a set of database rows and returns a handle for the explanation of the plan as a JSON or XML structure.
- explainAs(PlanBuilder.Plan, Class<T>) - Method in interface com.marklogic.client.row.RowManager
-
Constructs a plan for retrieving a set of database rows and returns an explanation of the plan in the representation specified by the IO class.
- ExportListener - Class in com.marklogic.client.datamovement
-
Reads document contents (and optionally metadata) for each batch, then sends each document to any listeners registered with
onDocumentReady for further processing or writing to any target supported by Java.
- ExportListener() - Constructor for class com.marklogic.client.datamovement.ExportListener
-
- exportQueryDefinition(T) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Exports the embedded query definitions and options to a handle
- ExportToWriterListener - Class in com.marklogic.client.datamovement
-
An extension of ExportListener which facilitates writing all documents to a single Writer output stream.
- ExportToWriterListener(Writer) - Constructor for class com.marklogic.client.datamovement.ExportToWriterListener
-
- ExportToWriterListener.OutputListener - Interface in com.marklogic.client.datamovement
-
The listener interface required by onGenerateOutput.
- ExtensionLibrariesManager - Interface in com.marklogic.client.admin
-
ExtensionLibrariesManager provides methods to read, list and update server-side XQuery modules that reside in the REST instanance’s modules database.
- ExtensionLibraryDescriptor - Class in com.marklogic.client.admin
-
Identifies a module in the REST server’s modules database.
- ExtensionLibraryDescriptor() - Constructor for class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
No-argument constructor.
- ExtensionLibraryDescriptor.Permission - Class in com.marklogic.client.admin
-
Wraps assigned permissions for an extension into a Java object.
- ExtensionMetadata - Class in com.marklogic.client.admin
-
Extension Metadata provides detail about a transform or resource services extension.
- ExtensionMetadata() - Constructor for class com.marklogic.client.admin.ExtensionMetadata
-
Zero-argument constructor.
- ExtensionMetadata.ScriptLanguage - Enum in com.marklogic.client.admin
-
The ScriptLanguage enumeration specifies the categories of metadata read from or written to the database.
- ExtractedItem - Interface in com.marklogic.client.query
-
Access the extracted XML or JSON node using any StructureReadHandle or class registered by a ContentHandle.
- ExtractedResult - Interface in com.marklogic.client.query
-
Surfaces the data sent from the server-side XQuery search:search API.
- fabs(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the absolute value of x.
- FacetHeatmapValue - Interface in com.marklogic.client.query
-
A FacetHeatmapValue is a facet value returned by a geospatial query heatmap.
- FacetResult - Interface in com.marklogic.client.query
-
A FacetResult represents a single facet as returned by a search.
- FacetValue - Interface in com.marklogic.client.query
-
A FacetValue represents a single value returned in a set of facet results.
- FailedRequestException - Exception in com.marklogic.client
-
A FailedRequestException is used to capture and report on problems from the REST API.
- FailedRequestException(String) - Constructor for exception com.marklogic.client.FailedRequestException
-
- FailedRequestException(String, Throwable) - Constructor for exception com.marklogic.client.FailedRequestException
-
- FailedRequestException(String, FailedRequest) - Constructor for exception com.marklogic.client.FailedRequestException
-
- FailureListener<T extends Throwable> - Interface in com.marklogic.client.datamovement
-
A generic base interface for listeners implemented by QueryFailureListener for processing a Throwable that caused a failure.
- falseExpr() - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the xs:boolean value false.
- falseQuery() - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches no fragments.
- fatalError(SAXParseException) - Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Throws the fatal error as a parse exception.
- field(String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a field to match with a query.
- fieldRangeQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
- fieldRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
- fieldRangeQuery(String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
- fieldRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
- fieldRangeQuery(String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
- fieldRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with a range-index entry equal to a given value.
- fieldReference(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
- fieldReference(XsStringVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
- fieldReference(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
- fieldReference(XsStringVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
- fieldValueQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given value in the specified field.
- fieldValueQuery(XsStringSeqVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given value in the specified field.
- fieldValueQuery(String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given value in the specified field.
- fieldValueQuery(XsStringSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given value in the specified field.
- fieldValueQuery(String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given value in the specified field.
- fieldValueQuery(XsStringSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given value in the specified field.
- fieldWordQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase in the specified field.
- fieldWordQuery(XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase in the specified field.
- fieldWordQuery(String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase in the specified field.
- fieldWordQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase in the specified field.
- fieldWordQuery(String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase in the specified field.
- fieldWordQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase in the specified field.
- FileHandle - Class in com.marklogic.client.io
-
A File Handle represents document content as a file for reading or writing.
- FileHandle() - Constructor for class com.marklogic.client.io.FileHandle
-
Zero-argument constructor.
- FileHandle(File) - Constructor for class com.marklogic.client.io.FileHandle
-
Initializes the handle with a file containing the content.
- FilteredForestConfiguration - Class in com.marklogic.client.datamovement
-
- FilteredForestConfiguration(ForestConfiguration) - Constructor for class com.marklogic.client.datamovement.FilteredForestConfiguration
-
- filteredQuery(StructuredQueryDefinition) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- findOne(QueryDefinition) - Method in interface com.marklogic.client.query.QueryManager
-
The findOne method is a convenience.
- findOne(QueryDefinition, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
The findOne method is a convenience.
- floatExpr(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:float server data type.
- floatExprSeq(XsFloatExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsFloatExpr items.
- floatSeq(float...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of float primitives and constructs an xs:float sequence
- floatSeq(XsFloatVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:float values and constructs an xs:float sequence
- floatVal(float) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a float primitive and constructs an xs:float value
- floor(XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of arg.
- floor(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the largest integer less than or equal to x.
- flush() - Method in interface com.marklogic.client.util.RequestLogger
-
Send buffered output to the log destination.
- flushAndWait() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Create a batch from any unbatched documents and write that batch, then wait for all batches to complete (the same as awaitCompletion().
- flushAsync() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Create a batch from any unbatched documents and write that batch asynchronously.
- fmod(XsDoubleExpr, double) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the remainder of x/y.
- fmod(XsDoubleExpr, XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the remainder of x/y.
- fn - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with fn server functions.
- FnExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the fn server library for a row pipeline.
- ForbiddenUserException - Exception in com.marklogic.client
-
Thrown when the credentials used to connect to a MarkLogic REST instance are not sufficient for the task requested.
- ForbiddenUserException(String) - Constructor for exception com.marklogic.client.ForbiddenUserException
-
- ForbiddenUserException(String, FailedRequest) - Constructor for exception com.marklogic.client.ForbiddenUserException
-
- Forest - Interface in com.marklogic.client.datamovement
-
Some details about a MarkLogic forest.
- ForestConfiguration - Interface in com.marklogic.client.datamovement
-
A reflection of the forest configuration associated with the specified database (or the default database for the specified port) in the MarkLogic cluster.
- Format - Enum in com.marklogic.client.io
-
The Format enumerates different kinds of document content.
- formatDate(XsDateExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, String, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDate(XsDateExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the picture argument.
- formatDateTime(XsDateTimeExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, String, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatDateTime(XsDateTimeExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of value argument based on the supplied picture.
- formatNumber(XsNumericSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of value argument based on the supplied picture.
- formatNumber(XsNumericSeqExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of value argument based on the supplied picture.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of value argument based on the supplied picture.
- formatNumber(XsNumericExpr...) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String, String, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String, String, String, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, String, String, String, String, String, String, long) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatNumber(XsNumericSeqExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsIntegerExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the picture argument.
- formatTime(XsTimeExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, String, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- formatTime(XsTimeExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the picture argument.
- fragmentIdCol(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
- fragmentIdCol(XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
- frexp(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent.
- fromBuffer(byte[]) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.BytesHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
fromBuffer() populates DocumentMetadataHandle from a byte array buffer.
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.DOMHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.InputSourceHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.InputStreamHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.JAXBHandle
-
fromBuffer() unmarshals a JAXB POJO from a byte array buffer.
- fromBuffer(byte[]) - Method in interface com.marklogic.client.io.marker.BufferableHandle
-
Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.ReaderHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.SourceHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.StringHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- fromBuffer(byte[]) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- fromJson(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Atomizes a JSON node, returning a JSON value.
- fromLexicons(Map<String, CtsReferenceExpr>) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, String, PlanSystemColumn) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, XsStringVal, PlanSystemColumn) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
- fromLiterals(Map<String, Object>[], String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
- fromLiterals(Map<String, Object>[], XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
- fromTriples(PlanTriplePattern...) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq, String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq, XsStringVal, XsStringSeqVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq, String, String, PlanTripleOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromTriples(PlanTriplePatternSeq, XsStringVal, XsStringSeqVal, PlanTripleOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple index.
- fromView(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
- fromView(XsStringVal, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
- fromView(String, String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
- fromView(XsStringVal, XsStringVal, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
- fromView(String, String, String, PlanSystemColumn) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
- fromView(XsStringVal, XsStringVal, XsStringVal, PlanSystemColumn) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
- FUNCTIONAL_PROPERTY - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- gDay(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:gDay server data type.
- gDay(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a day as a string and constructs an xs:gDay value
- gDay(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a day as a XMLGregorianCalendar value and constructs an xs:gDay value
- GDaySeq(XsGDayExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsGDayExpr items.
- gDaySeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days as a string and constructs an xs:gDay sequence
- gDaySeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days as a XMLGregorianCalendar value and constructs an xs:gDay sequence
- gDaySeq(XsGDayVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gDay values and constructs an xs:gDay sequence
- ge(XsAnyAtomicTypeExpr, XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the value of the left expression is greater than or equal to the value of the right expression.
- generateId(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string that uniquely identifies a given node.
- GenerateIndexConfig - Class in com.marklogic.client.pojo.util
-
Generates a MarkLogic index configuration file in JSON format describing the indexes
required by the annotations on the specific classes.
- GenerateIndexConfig() - Constructor for class com.marklogic.client.pojo.util.GenerateIndexConfig
-
- generateOutput(DocumentRecord) - Method in interface com.marklogic.client.datamovement.ExportToWriterListener.OutputListener
-
Given the DocumentRecord, generate the desired String output to send to the writer.
- generateOutput(String) - Method in interface com.marklogic.client.datamovement.UrisToWriterListener.OutputListener
-
- GenericDocumentManager - Interface in com.marklogic.client.document
-
A Generic Document Manager supports database operations on documents with an unknown format.
- GenericReadHandle - Interface in com.marklogic.client.io.marker
-
A Generic Read Handle can represent content of an unknown format read from the database.
- GenericWriteHandle - Interface in com.marklogic.client.io.marker
-
A Generic Write Handle can represent content of an unknown format written to the database.
- geoAttributePair(StructuredQueryBuilder.Element, StructuredQueryBuilder.Attribute, StructuredQueryBuilder.Attribute) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with child latitude and longitude attributes to match with a geospatial query.
- geoElement(StructuredQueryBuilder.Element) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies an element whose text has the latitude and longitude coordinates to match with a geospatial query.
- geoElement(StructuredQueryBuilder.Element, StructuredQueryBuilder.Element) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with a child element whose text has the latitude and longitude coordinates to match with a geospatial query.
- geoElementPair(StructuredQueryBuilder.Element, StructuredQueryBuilder.Element, StructuredQueryBuilder.Element) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with child latitude and longitude elements to match with a geospatial query.
- geoJSONProperty(StructuredQueryBuilder.JSONProperty) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a json property whose text has the point format latitude and longitude coordinates to match with a geospatial query.
- geoJSONProperty(StructuredQueryBuilder.JSONProperty, StructuredQueryBuilder.JSONProperty) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent json property with a child json property whose text has the latitude and longitude coordinates to match with a geospatial query.
- geoJSONPropertyPair(StructuredQueryBuilder.JSONProperty, StructuredQueryBuilder.JSONProperty, StructuredQueryBuilder.JSONProperty) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent json property with child latitude and longitude json properties to match with a geospatial query.
- geoPair(String, String) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
For use in a
geospatial query, reference a pair of properties.
- geoPath(String) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
For use in a
geospatial query, reference a geo property which has a corresponding Geospatial Path Range Index configured in the database.
- geoPath(StructuredQueryBuilder.PathIndex) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with the latitude and longitude to match with a geospatial query.
- geoRegionPath(StructuredQueryBuilder.PathIndex) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with regions to match with a geospatial query.
- geoRegionPath(StructuredQueryBuilder.PathIndex, StructuredQueryBuilder.CoordinateSystem) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with regions to match with a geospatial query.
- geospatial(StructuredQueryBuilder.GeospatialIndex, String[], StructuredQueryBuilder.Region...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element attribute, pair, or path specifying a geospatial point that appears within one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialRegionIndex, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialRegionIndex, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a path specifying a geospatial region, which is indexed via geospatial region index, that has the relationship given by the operator with at least one of the criteria regions.
- geospatialConstraint(String, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint whose geospatial point appears within one of the criteria regions.
- GeospatialLatitude - Annotation Type in com.marklogic.client.pojo.annotation
-
Use this annotation in combination with
GeospatialLongitude on a sibling property to specify that a Geospatial Element Pair Index is needed for these pojo properties.
- GeospatialLongitude - Annotation Type in com.marklogic.client.pojo.annotation
-
Use this annotation in combination with
GeospatialLatitude on a sibling property to specify that a Geospatial Element Pair Index is needed for these pojo properties.
- GeospatialPathIndexProperty - Annotation Type in com.marklogic.client.pojo.annotation
-
Use this annotation to specify that a Geospatial Path Index is needed for this pojo property.
- geospatialRegionConstraint(String, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.Region...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint whose geospatial region appears within one of the criteria regions.
- get(H) - Method in interface com.marklogic.client.eval.EvalResult
-
Use a handle to retrieve the contents of this result.
- get() - Static method in class com.marklogic.client.example.cookbook.datamovement.DatabaseClientSingleton
-
- get() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- get() - Method in class com.marklogic.client.example.handle.URIHandle
-
- get(MapMapExpr, String) - Method in interface com.marklogic.client.expression.MapExpr
-
Get a value from a map.
- get(MapMapExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.MapExpr
-
Get a value from a map.
- get(RequestParameters, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads resource content by calling a GET service.
- get(RequestParameters, Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads resource content by calling a GET service.
- get(RequestParameters, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads multiple resource content by calling a GET service.
- get(RequestParameters, Transaction, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads multiple resource content by calling a GET service.
- get() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the XML document structure.
- get() - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the root node of the JSON tree.
- get() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the XML document structure.
- get() - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Returns the XML document structure.
- get() - Method in class com.marklogic.client.io.BytesHandle
-
Returns the byte array for the handle content.
- get() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the DOM document for the content.
- get() - Method in class com.marklogic.client.io.FileHandle
-
Returns the file for the handle content.
- get() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the input source for the content.
- get() - Method in class com.marklogic.client.io.InputStreamHandle
-
Returns an input stream for a resource read from the database.
- get() - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Returns the content.
- get() - Method in class com.marklogic.client.io.JacksonHandle
-
Returns the root node of the JSON tree.
- get() - Method in class com.marklogic.client.io.JacksonParserHandle
-
JsonParser allows streaming access to content as it arrives.
- get() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the root object of the JAXB structure for the content.
- get(Class<T>) - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the root object of the JAXB structure for the content cast to a more specific class.
- get() - Method in interface com.marklogic.client.io.marker.ContentHandle
-
Returns the content.
- get() - Method in class com.marklogic.client.io.OutputStreamHandle
-
Returns the output stream sender that writes the content.
- get() - Method in class com.marklogic.client.io.ReaderHandle
-
Returns a character reader for reading content.
- get() - Method in class com.marklogic.client.io.SourceHandle
-
Returns the transform source that produces the content.
- get() - Method in class com.marklogic.client.io.StringHandle
-
Returns the string for the content.
- get() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns an XML Event Reader for for reading a resource from the database as a series of StAX events.
- get() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns an XML Stream Reader for for reading a resource from the database as a StAX pull stream.
- get(String, Class<T>) - Method in class com.marklogic.client.query.AggregateResult
-
Returns the value cast to the specified type.
- get(String, Class<T>) - Method in class com.marklogic.client.query.CountedDistinctValue
-
Returns the value cast to the specified type.
- get(T) - Method in interface com.marklogic.client.query.ExtractedItem
-
Get the item using the specified handle.
- get(Class<T>) - Method in class com.marklogic.client.query.TypedDistinctValue
-
Returns the value as an instance of the specified class.
- get(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the URI for a prefix.
- get(String) - Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the string name.
- get(QName, Class<T>) - Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the QName, cast to the supplied type.
- get(String, Class<T>) - Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the string name, cast to the supplied type.
- get(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Gets the values for a parameter name.
- getAggregate(String) - Method in class com.marklogic.client.io.TuplesHandle
-
- getAggregate(String) - Method in class com.marklogic.client.io.ValuesHandle
-
- getAggregate(String) - Method in interface com.marklogic.client.query.TuplesResults
-
Returns the aggregate result for the named aggregate function.
- getAggregate() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the aggregate function applied to this query.
- getAggregate(String) - Method in interface com.marklogic.client.query.ValuesResults
-
Returns the aggregate result for the named aggregate function.
- getAggregatePath() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the aggregate path.
- getAggregateResolutionTime() - Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the facet resolution time in milliseconds.
- getAggregates() - Method in class com.marklogic.client.io.TuplesHandle
-
- getAggregates() - Method in class com.marklogic.client.io.ValuesHandle
-
- getAggregates() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns an array of the aggregates.
- getAggregates() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns an array of the aggregates.
- getAllPrefixes() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns all bound prefixes.
- getAllPrefixes() - Method in interface com.marklogic.client.util.IterableNamespaceContext
-
Returns all bound prefixes.
- getAllSnippetText() - Method in interface com.marklogic.client.query.MatchLocation
-
Returns the entire text only of the snippet, excluding any highlight tags.
- getAlternateHost() - Method in interface com.marklogic.client.datamovement.Forest
-
The alternate host name associated with the forest in the MarkLogic server.
- getAnyAtomicTypeItems() - Method in interface com.marklogic.client.type.XsAnyAtomicTypeSeqVal
-
- getAnySimpleTypeItems() - Method in interface com.marklogic.client.type.XsAnySimpleTypeSeqVal
-
- getAnyURIItems() - Method in interface com.marklogic.client.type.XsAnyURISeqVal
-
- getAs(Class<T>) - Method in interface com.marklogic.client.eval.EvalResult
-
An io shortcut method to get the contents as an object of the specified type, which must be a registered type.
- getAs(Class<T>) - Method in interface com.marklogic.client.query.ExtractedItem
-
Get the item using the handle registered for the specified class.
- getAuthentication() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- getAuthType() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getBase64BinaryItems() - Method in interface com.marklogic.client.type.XsBase64BinarySeqVal
-
- getBaseUri() - Method in class com.marklogic.client.example.handle.URIHandle
-
- getBaseUri() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getBatcher() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
- getBatcher() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
- getBatcher() - Method in interface com.marklogic.client.datamovement.WriteBatch
-
- getBatchFailureListeners() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Get the array of WriteFailureListener instances registered via onBatchFailure including the HostAvailabilityListener registered by default.
- getBatchRecordNumber() - Method in interface com.marklogic.client.datamovement.WriteEvent
-
Within the context of the batch, the numeric position of this document.
- getBatchSize() - Method in interface com.marklogic.client.datamovement.Batcher
-
- getBatchSize() - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- getBatchSuccessListeners() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Get the array of WriteBatchListener instances registered via onBatchSuccess.
- getBigDecimal() - Method in interface com.marklogic.client.type.XsDecimalVal
-
- getBigInteger() - Method in interface com.marklogic.client.type.XsIntegerVal
-
- getBindings() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Get the child SPARQLBindings instance (normally populated by calls to withBinding methods).
- getBoolean() - Method in interface com.marklogic.client.eval.EvalResult
-
This result parsed to a Boolean.
- getBoolean(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:boolean schema data type as a Java boolean primitive value.
- getBoolean(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:boolean schema data type as a Java boolean primitive value.
- getBoolean() - Method in interface com.marklogic.client.type.XsBooleanVal
-
- getBooleanItems() - Method in interface com.marklogic.client.type.XsBooleanSeqVal
-
- getBox() - Method in interface com.marklogic.client.query.FacetHeatmapValue
-
Returns the box associated with the heatmap as an array.
- getBuilder() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the JDOM structure builder for XML content.
- getBuilder() - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Returns the XOM structure builder for XML content.
- getByte(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:byte schema data type as a Java byte primitive value.
- getByte(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:byte schema data type as a Java byte primitive value.
- getByte() - Method in interface com.marklogic.client.type.XsByteVal
-
- getByte() - Method in interface com.marklogic.client.type.XsUnsignedByteVal
-
- getByteItems() - Method in interface com.marklogic.client.type.XsByteSeqVal
-
- getByteLength() - Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the length of the content in bytes as returned by the server.
- getByteLength() - Method in class com.marklogic.client.io.BaseHandle
-
- getBytes() - Method in interface com.marklogic.client.type.XsBase64BinaryVal
-
- getBytes() - Method in interface com.marklogic.client.type.XsHexBinaryVal
-
- getCalendar() - Method in interface com.marklogic.client.type.XsDateTimeVal
-
- getCalendar() - Method in interface com.marklogic.client.type.XsDateVal
-
- getCalendar() - Method in interface com.marklogic.client.type.XsTimeVal
-
- getCapability() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
gets the capability of this permission
- getCertificate() - Method in class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
- getCertificatePassword() - Method in class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
- getClient() - Method in interface com.marklogic.client.datamovement.Batch
-
The DatabaseClient used to send or retrieve this batch.
- getClient() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
The DatabaseClient used to retrieve this batch (if it’s a job based on a QueryDefinition).
- getClient() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
The DatabaseClient used to retrieve this batch (if it’s a job based on a QueryDefinition).
- getClient() - Method in class com.marklogic.client.example.handle.URIHandle
-
- getClientImplementation() - Method in interface com.marklogic.client.DatabaseClient
-
Returns the client object from the library that implements communication with the server.
- getCollections() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the collections for the document as read from the server or modified locally.
- getCollections() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the array of collections to which the query is limited.
- getColumnNames() - Method in interface com.marklogic.client.row.RowSet
-
Identifies the columns in the row set.
- getColumnTypes() - Method in interface com.marklogic.client.row.RowSet
-
Identifies the data types of the columns.
- getConfidence() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the confidence messsure associated with the document.
- getConfiguration() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getConstrainingQueryDefinition() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getConstraint(String, T) - Method in class com.marklogic.client.io.SearchHandle
-
- getConstraint(String, T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the named constraint used in the search (if requested).
- getConstraintIterator(T) - Method in class com.marklogic.client.io.SearchHandle
-
- getConstraintIterator(T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns an iterator over the constraints used in the search (if requested).
- getConstraintNames() - Method in class com.marklogic.client.io.SearchHandle
-
- getConstraintNames() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of constraint names used in the search (if requested).
- getContent() - Method in interface com.marklogic.client.datamovement.WriteEvent
-
The content written to the server.
- getContent(T) - Method in interface com.marklogic.client.document.DocumentRecord
-
Given a handle, populates the handle with the document contents directly from the server (or the transformed contents if a ServerTransform was used).
- getContent() - Method in interface com.marklogic.client.document.DocumentWriteOperation
-
The handle with the content as set by your call to
add or
add.
- getContent(R) - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getContent(R) - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns a handle on the content.
- getContent(String, T) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or other content node value.
- getContent(PlanExprCol, T) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or other content node value.
- getContentAs(Class<T>) - Method in interface com.marklogic.client.document.DocumentRecord
-
Reads the document content from the multipart response into the representation specified by the IO class.
- getContentAs(String, Class<T>) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or other content node value.
- getContentAs(PlanExprCol, Class<T>) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or other content node value.
- getContentFormat() - Method in interface com.marklogic.client.document.DocumentManager
-
Gets the default format of the managed documents
- getContentFormat(String) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
- getContentFormat(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
- getContentMax() - Method in interface com.marklogic.client.util.RequestLogger
-
Returns how much content is copied to the log.
- getContentMimetype() - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getContentMimetype(String) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
- getContentMimetype(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
- getContext() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- getContext() - Method in class com.marklogic.client.example.handle.URIHandle
-
- getCookies() - Method in interface com.marklogic.client.Transaction
-
Returns any cookies sent in the response to open the transaction.
- getCoordinateSystem() - Method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
- getCount() - Method in class com.marklogic.client.query.CountedDistinctValue
-
Returns the frequency associated with this value.
- getCount() - Method in interface com.marklogic.client.query.FacetValue
-
Returns the count of items for that facet value.
- getCount() - Method in class com.marklogic.client.query.Tuple
-
Returns the frequency of this tuple in the database.
- getCriteria() - Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Returns the query criteria, that is the query string.
- getCriteria() - Method in interface com.marklogic.client.query.StringQueryDefinition
-
Returns the query criteria, that is the query string.
- getCriteria() - Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Returns the query criteria, that is the query string.
- getCurrentUser() - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the name of the current user.
- getCursorPosition() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the cursor position for the suggest call.
- getDatabase() - Method in interface com.marklogic.client.DatabaseClient
-
- getDatabase() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the database for clients created with a DatabaseClientFactory.Bean object.
- getDatabase() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getDatabaseName() - Method in interface com.marklogic.client.datamovement.Forest
-
The database name associated with the forest in the MarkLogic server.
- getDatatype(String) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies the server data type for a column.
- getDatatype(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies the server data type for a column.
- getDatatype() - Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getDatatypeStyle() - Method in interface com.marklogic.client.row.RowManager
-
Returns whether data types should be emitted in each row (the default) or in the header in the response for requests made with the row manager.
- getDateItems() - Method in interface com.marklogic.client.type.XsDateSeqVal
-
- getDateTimeItems() - Method in interface com.marklogic.client.type.XsDateTimeSeqVal
-
- getDayTimeDurationItems() - Method in interface com.marklogic.client.type.XsDayTimeDurationSeqVal
-
- getDecimalItems() - Method in interface com.marklogic.client.type.XsDecimalSeqVal
-
- getDefaultDocumentReadTransform() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the name of the default transform for reading documents.
- getDefaultDocumentReadTransformAll() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the default transform for reading documents applies to all users or only users with the rest-reader role.
- getDefaultGraphUris() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getDefaultMimetype() - Method in enum com.marklogic.client.io.Format
-
Returns the default mime type for the format.
- getDefaultMimetype() - Method in interface com.marklogic.client.semantics.GraphManager
-
Get the mimetype set by calling setDefaultMimetype.
- getDefaultNamespaceURI() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the namespace URI bound to the empty prefix.
- getDefaultWriteSchema() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the default schema for validating the input source while writing to the database.
- getDescription() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the description of the extension.
- getDescription() - Method in class com.marklogic.client.alerting.RuleDefinition
-
Returns the rule’s definition.
- getDescription() - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- getDirection() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the direction of the results in this values query.
- getDirectory() - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Returns the directory that should prefix the document uri.
- getDirectory() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the directory to which the query is limited.
- getDistributor_id() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- getDocumentRepair() - Method in interface com.marklogic.client.document.XMLDocumentManager
-
Returns the repair policy for XML documents written by the manager.
- getDocumentUri(T) - Method in interface com.marklogic.client.pojo.PojoRepository
-
- getDouble(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:double schema data type as a Java double primitive value.
- getDouble(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:double schema data type as a Java double primitive value.
- getDouble() - Method in interface com.marklogic.client.type.XsDoubleVal
-
- getDoubleItems() - Method in interface com.marklogic.client.type.XsDoubleSeqVal
-
- getDoublePrecision() - Method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
- getDuration() - Method in interface com.marklogic.client.type.XsDayTimeDurationVal
-
- getDuration() - Method in interface com.marklogic.client.type.XsYearMonthDurationVal
-
- getDurationItems() - Method in interface com.marklogic.client.type.XsDurationSeqVal
-
- getErrorHandler() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the error handler for errors discovered while parsing the input source.
- getException(R) - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getExtension() - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Returns the extension that should suffix the document uri.
- getExternalName() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the external name for Kerberos clients created with a DatabaseClientFactory.Bean object.
- getExtracted() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
- getExtractResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the extract resolution time in milliseconds.
- getFacetNames() - Method in class com.marklogic.client.io.SearchHandle
-
Returns a list of the facet names returned in this search.
- getFacetNames() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of facet names returned by this search.
- getFacetResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the facet resolution time in milliseconds.
- getFacetResult(String) - Method in class com.marklogic.client.io.SearchHandle
-
Returns the named facet results.
- getFacetResult(String) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the facet results for the named facet.
- getFacetResults() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of facet results for this search.
- getFacetResults() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of facet results.
- getFacetValues() - Method in interface com.marklogic.client.query.FacetResult
-
Returns an array of the facet values.
- getFactory() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the factory for building DOM documents.
- getFactory() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the factory for parsing SAX events.
- getFactory() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns the factory for parsing StAX events.
- getFactory() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns the factory for parsing StAX streams.
- getFailedRequest() - Method in exception com.marklogic.client.MarkLogicServerException
-
- getFailureBatchesCount() - Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher : gets the number of batches that the job failed to write
QueryBatcher : gets the number of query attempts that failed (same as getFailureEventsCount)
- getFailureEventsCount() - Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher : gets the number of documents that were sent but failed to write
QueryBatcher : gets the number of query attempts that failed (same as getFailureBatchesCount)
- getFirstSnippet(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the content of the first snippet for the matched result document as a convenience, especially for a raw snippet that contains the entire result document.
- getFirstSnippetAs(Class<T>) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Reads the content of the first snippet for the matched result document in the representation specified by the IO class.
- getFirstSnippetText() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the text of the first snippet as a convenience, especially for a raw snippet that contains an entire document in JSON or text format.
- getFitness() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the fitness of the document.
- getFloat(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:float schema data type as a Java float primitive value.
- getFloat(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:float schema data type as a Java float primitive value.
- getFloat() - Method in interface com.marklogic.client.type.XsFloatVal
-
- getFloatItems() - Method in interface com.marklogic.client.type.XsFloatSeqVal
-
- getForest() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
The forest queried for this event if this job is based on a QueryDefinition.
- getForest() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
The forest queried for this event if this job is based on a QueryDefinition.
- getForestBatchNumber() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of this forest within the job, the numeric position of this batch.
- getForestBatchNumber() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of this forest within the job, the numeric position of this batch.
- getForestConfig() - Method in interface com.marklogic.client.datamovement.Batcher
-
- getForestId() - Method in interface com.marklogic.client.datamovement.Forest
-
The id for the forest as provided by the MarkLogic server.
- getForestName() - Method in interface com.marklogic.client.datamovement.Forest
-
The name of the forest as provided by the MarkLogic server.
- getForestResultsSoFar() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of this forest within the job, the number of uris processed including the uris in this event if this is a QueryBatch.
- getForestResultsSoFar() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of this forest within the job, the number of uris processed including the uris in this event if this is a QueryBatch.
- getFormat() - Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the format of the content.
- getFormat() - Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the format of the document in the server
- getFormat() - Method in interface com.marklogic.client.eval.EvalResult
-
The format of this result from the Content-Type header provided by the REST API eval endpoint.
- getFormat() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the format of the content.
- getFormat() - Method in class com.marklogic.client.io.BaseHandle
-
- getFormat() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the format associated with this document
- getFrequency() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the frequency of the results.
- getFromMimetype(String) - Static method in enum com.marklogic.client.io.Format
-
- getGDayItems() - Method in interface com.marklogic.client.type.XsGDaySeqVal
-
- getGMonthDayItems() - Method in interface com.marklogic.client.type.XsGMonthDaySeqVal
-
- getGMonthItems() - Method in interface com.marklogic.client.type.XsGMonthSeqVal
-
- getGroup() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getGYearItems() - Method in interface com.marklogic.client.type.XsGYearSeqVal
-
- getGYearMonthItems() - Method in interface com.marklogic.client.type.XsGYearMonthSeqVal
-
- getHandle() - Method in interface com.marklogic.client.query.RawQueryDefinition
-
Returns the handle for the JSON or XML representation of the query.
- getHandle() - Method in interface com.marklogic.client.row.RawPlanDefinition
-
Returns the handle for the JSON representation of the plan.
- getHandledClasses() - Method in interface com.marklogic.client.io.marker.ContentHandleFactory
-
Returns classes that the handle always supports;
- getHandleRegistry() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the registry for associating IO representation classes with handle factories.
- getHandleRegistry() - Static method in class com.marklogic.client.DatabaseClientFactory
-
Returns the default registry with factories for creating handles as adapters for IO representations.
- getHasHeader() - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- getHexBinaryItems() - Method in interface com.marklogic.client.type.XsHexBinarySeqVal
-
- getHost() - Method in interface com.marklogic.client.DatabaseClient
-
- getHost() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the host for clients created with a DatabaseClientFactory.Bean object.
- getHost() - Method in interface com.marklogic.client.datamovement.Forest
-
The host name associated with the forest in the MarkLogic server.
- getHost() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getHostId() - Method in interface com.marklogic.client.Transaction
-
Returns the host identifier for the transaction that binds this transaction with the host e-node for the transaction.
- getHostUnavailableExceptions() - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
- getId() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- getId() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the ID of the message.
- getId() - Method in class com.marklogic.client.io.SearchHandle.Warning
-
Returns the ID of the warning.
- getId(T) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Get the value of the id field (the field marked with the @Id annotation).
- getIncludeDefaultRulesets() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getIndustry() - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- getInt(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:int schema data type as a Java int primitive value.
- getInt(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:int schema data type as a Java int primitive value.
- getInt() - Method in interface com.marklogic.client.type.XsIntVal
-
- getInt() - Method in interface com.marklogic.client.type.XsUnsignedIntVal
-
- getIntegerItems() - Method in interface com.marklogic.client.type.XsIntegerSeqVal
-
- getIntItems() - Method in interface com.marklogic.client.type.XsIntSeqVal
-
- getIriItems() - Method in interface com.marklogic.client.type.SemIriSeqVal
-
- getItems() - Method in interface com.marklogic.client.datamovement.Batch
-
The documents read by WriteBatcher or the uris retrieved by QueryBatcher.
- getItems() - Method in interface com.marklogic.client.type.ItemSeqVal
-
- getJobBatchNumber() - Method in interface com.marklogic.client.datamovement.Batch
-
Within the context of the job, the numeric position of this batch.
- getJobBatchNumber() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of the job, the numeric position of this batch.
- getJobBatchNumber() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of the job, the numeric position of this batch.
- getJobId() - Method in interface com.marklogic.client.datamovement.JobTicket
-
- getJobName() - Method in interface com.marklogic.client.datamovement.Batcher
-
- getJobRecordNumber() - Method in interface com.marklogic.client.datamovement.WriteEvent
-
Within the context of the job, the numric position of this document.
- getJobReport(JobTicket) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Get a snapshot report of the state of the job when the call is made.
- getJobResultsSoFar() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of the job, the number of uris processed including the uris in this event if this is a QueryBatch.
- getJobResultsSoFar() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of the job, the number of uris processed including the uris in this event if this is a QueryBatch.
- getJobTicket() - Method in interface com.marklogic.client.datamovement.Batch
-
The ticket for this job.
- getJobTicket() - Method in interface com.marklogic.client.datamovement.Batcher
-
After the job has been started, returns the JobTicket generated when the job was started.
- getJobTicket() - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
After the job has been started, returns the JobTicket generated when the job was started.
- getJobTicket() - Method in exception com.marklogic.client.datamovement.QueryBatchException
-
The ticket for this job.
- getJobTicket() - Method in interface com.marklogic.client.datamovement.QueryEvent
-
The ticket for this job.
- getJobTicket() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
After the job has been started, returns the JobTicket generated when the job was started.
- getJobType() - Method in interface com.marklogic.client.datamovement.JobTicket
-
- getJobWritesSoFar() - Method in interface com.marklogic.client.datamovement.WriteBatch
-
In the context of this job, the number of documents written so far.
- getKind() - Method in interface com.marklogic.client.query.ExtractedResult
-
The xquery type of the extracted data.
- getKind(String) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies whether the value of a column is an atomic value, a document or other content structure, or a null.
- getKind(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Identifies whether the value of a column is an atomic value, a document or other content structure, or a null.
- getLabel() - Method in interface com.marklogic.client.query.FacetValue
-
Returns the label associated with that facet value.
- getLang() - Method in interface com.marklogic.client.type.RdfLangStringVal
-
- getLangStringItems() - Method in interface com.marklogic.client.type.RdfLangStringSeqVal
-
- getLanguageTag() - Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getLatitude() - Method in interface com.marklogic.client.query.StructuredQueryBuilder.Point
-
- getLength() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the length of the content in bytes.
- getLimit() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the maximum number of suggestions to fetch.
- getLong(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:long schema data type as a Java long primitive value.
- getLong(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:long schema data type as a Java long primitive value.
- getLong() - Method in interface com.marklogic.client.type.XsLongVal
-
- getLong() - Method in interface com.marklogic.client.type.XsUnsignedLongVal
-
- getLongItems() - Method in interface com.marklogic.client.type.XsLongSeqVal
-
- getLongitude() - Method in interface com.marklogic.client.query.StructuredQueryBuilder.Point
-
- getMapper() - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Provides access to the ObjectMapper used internally so you can configure it to fit your JSON.
- getMapper() - Method in class com.marklogic.client.io.JacksonParserHandle
-
Provides access to the ObjectMapper used internally so you can configure it to fit your JSON.
- getMarshaller() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the marshaller that converts a tree data structure from Java objects to XML, reusing any existing marshaller.
- getMarshaller(boolean) - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the marshaller that converts a tree data structure from Java objects to XML.
- getMatchLocations() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an array of match locations.
- getMatchResults() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of summaries for the matched documents.
- getMatchResults() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the match results.
- getMessage() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the text of the message.
- getMessage() - Method in class com.marklogic.client.io.SearchHandle.Warning
-
Returns the text of the warning message.
- getMessage() - Method in exception com.marklogic.client.MarkLogicServerException
-
- getMetadata() - Method in class com.marklogic.client.alerting.RuleDefinition
-
Gets the metadata object associated with this rule
- getMetadata() - Method in interface com.marklogic.client.datamovement.WriteEvent
-
The metadata written to the server.
- getMetadata(T) - Method in interface com.marklogic.client.document.DocumentRecord
-
Given a handle, populates the handle with the structured metadata directly from the REST API.
- getMetadata() - Method in interface com.marklogic.client.document.DocumentWriteOperation
-
The handle with the metadata as set by your call to
add or
add.
- getMetadata() - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getMetadata(R) - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getMetadata() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata associated with this document.
- getMetadata(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata extracted from the result document.
- getMetadataAs(Class<T>) - Method in interface com.marklogic.client.document.DocumentRecord
-
Reads the metadata from the multipart response into the representation specified by the IO class.
- getMetadataAs(Class<T>) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Reads the metadata extracted from the matched result document in the representation specified by the IO class.
- getMetadataCategories() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the categories of metadata to read, write, patch, or search.
- getMetadataExtraction() - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Returns the metadata extraction policy.
- getMetadataResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
- getMetadataValues() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the metadata-values for the document as read from the server or modified locally.
- getMethod() - Method in class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Returns the method for the parameters.
- getMetrics() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the metrics associated with this search.
- getMetrics() - Method in class com.marklogic.client.io.TuplesHandle
-
- getMetrics() - Method in class com.marklogic.client.io.ValuesHandle
-
- getMetrics() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the search metrics.
- getMetrics() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns performance metrics about the query.
- getMetrics() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns performance metrics about the query.
- getMimetype() - Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the mimetype of the content.
- getMimetype() - Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the mime-type (“Content-Type” header) of the document as specified by the server (uses the server’s mime-type mapping for file extensions)
- getMimetype(String...) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- getMimetype() - Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the mimetype of the content.
- getMimetype() - Method in class com.marklogic.client.io.BaseHandle
-
- getMimeType() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the mime type associated with this document.
- getMinHosts() - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
- getModulesDatabase() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getName() - Method in class com.marklogic.client.alerting.RuleDefinition
-
Gets the name of the rule.
- getName() - Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.Builtin
-
Returns the name of the built-in.
- getName() - Method in class com.marklogic.client.document.ServerTransform
-
Gets the name of the invoked transform.
- getName() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- getName() - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- getName() - Method in class com.marklogic.client.extensions.ResourceManager
-
Returns the name of the resource.
- getName() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the name of the message.
- getName() - Method in class com.marklogic.client.io.TuplesHandle
-
- getName() - Method in class com.marklogic.client.io.ValuesHandle
-
- getName() - Method in class com.marklogic.client.query.AggregateResult
-
Returns the name of this aggregate.
- getName() - Method in interface com.marklogic.client.query.FacetResult
-
Returns the facet name.
- getName() - Method in interface com.marklogic.client.query.FacetValue
-
Returns the name of the facet value.
- getName() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns the name of the tuples.
- getName() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the values constraint.
- getName() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns the name of the values.
- getName() - Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getName() - Method in class com.marklogic.client.semantics.SPARQLRuleset
-
- getNamedGraphUris() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getNamespaceContext() - Method in interface com.marklogic.client.util.NameMap
-
Returns the namespace context (if any) that declares the namespace bindings used to convert prefixed string names into QNames.
- getNamespaces() - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Returns the namespaces available for the paths of a patch against XML documents.
- getNamespaces() - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Gets the namespace bindings used for the query.
- getNamespaceURI(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the URI for a namespace binding.
- getNonDocumentFormat() - Method in interface com.marklogic.client.document.DocumentManager
-
- getNonNegativeIntegerItems() - Method in interface com.marklogic.client.type.XsNonNegativeIntegerSeqVal
-
- getNumber() - Method in interface com.marklogic.client.eval.EvalResult
-
This result parsed to a Number.
- getNumericItems() - Method in interface com.marklogic.client.type.XsNumericSeqVal
-
- getOpenReplicaHost() - Method in interface com.marklogic.client.datamovement.Forest
-
The replica host name associated with the forest in the MarkLogic server.
- getOperationType() - Method in interface com.marklogic.client.document.DocumentWriteOperation
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.DeleteOutput
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.ReadOutput
-
- getOperationType() - Method in class com.marklogic.client.example.extension.BatchManager.WriteOutput
-
- getOptimizeLevel() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getOptionsMap() - Method in class com.marklogic.client.query.QueryOptionsListBuilder.OptionsList
-
- getOptionsName() - Method in class com.marklogic.client.io.ValuesListHandle
-
Returns the name of the query options used for this query.
- getOptionsName() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the name of the query options used for this query.
- getOptionsName() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the name of the query options used for this query.
- getOptionsName() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the options node used for this values query.
- getOptionsName() - Method in interface com.marklogic.client.query.ValuesListDefinition
-
Returns the name of the options node associated with this query.
- getOther(String) - Static method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
This method creates a CoordinateSystem with the specified string and sets doublePrecision to false
- getOther(String, boolean) - Static method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
This method creates a CoordinateSystem with the specified string and sets doublePrecision to the specified isDoublePrecision boolean
- getOutputFormat() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the dom4j output format for serializing XML content.
- getOutputter() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the JDOM serializer for XML content.
- getPageLength() - Method in interface com.marklogic.client.document.DocumentManager
-
Get the maximum number of records to return in a page from calls to
search
- getPageLength() - Method in class com.marklogic.client.example.extension.SearchCollector
-
- getPageLength() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the page length for this search.
- getPageLength() - Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of instances per page returned when calling
readAll or
search (Default: 50).
- getPageLength() - Method in interface com.marklogic.client.query.QueryManager
-
Returns the maximum number of documents that can appear in any page of query results.
- getPageLength() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the maximum number of results in the search response page.
- getPageLength() - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
- getPageNumber() - Method in interface com.marklogic.client.Page
-
The page number within the count of all possible pages.
- getPageSize() - Method in interface com.marklogic.client.Page
-
The page size which is the maximum number of items allowed in one page.
- getParser() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getParser() - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the parser used to construct element objects from JSON.
- getPassword() - Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- getPassword() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- getPassword() - Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- getPassword() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getPath() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
gets the path of this module/asset
- getPath() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the path of the match.
- getPath() - Method in interface com.marklogic.client.query.MatchLocation
-
Returns the path to the matching location in the document.
- getPermissions() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
gets the list of permissions assigned to this module, beyond the default permissions.
- getPermissions() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the permissions on the document as read from the server or modified locally.
- getPermissions(String) - Method in interface com.marklogic.client.semantics.GraphManager
-
Retrieve permissions for a graph.
- getPermissions(String, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Retrieve permissions for a graph.
- getPlan() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the query plan associated with this search.
- getPlan(T) - Method in class com.marklogic.client.io.SearchHandle
-
- getPlan() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the query plan.
- getPlan(T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the plan for the search (if requested).
- getPort() - Method in interface com.marklogic.client.DatabaseClient
-
- getPort() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the port for clients created with a DatabaseClientFactory.Bean object.
- getPort() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getPort() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getPreferredHost() - Method in interface com.marklogic.client.datamovement.Forest
-
Returns the host your application should talk to for this forest.
- getPreferredHosts() - Method in interface com.marklogic.client.datamovement.ForestConfiguration
-
A utility method to return the list of hosts a Batcher should use when talking to this database.
- getPrefix(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the prefix for a namespace binding.
- getPrefixes(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns all prefixes with a namespace binding.
- getPrintStream() - Method in interface com.marklogic.client.util.RequestLogger
-
Returns the underlying PrintStream used for logging.
- getProperties() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the properties of the document as read from the server or modified locally.
- getProvider() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the name of the organization providing the extension.
- getQName() - Method in interface com.marklogic.client.type.XsQNameVal
-
- getQNameItems() - Method in interface com.marklogic.client.type.XsQNameSeqVal
-
- getQuality() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns the quality of the document.
- getQuery(T) - Method in class com.marklogic.client.io.SearchHandle
-
- getQuery(T) - Method in interface com.marklogic.client.query.SearchResults
-
Returns the cts:query used in the search (if requested).
- getQueryBuilder() - Method in interface com.marklogic.client.pojo.PojoRepository
-
Get a PojoQueryBuilder for the type managed by this PojoRepository.
- getQueryCriteria() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the query definition used for the search represented by this handle.
- getQueryCriteria() - Method in class com.marklogic.client.io.TuplesHandle
-
Returns the tuples query definition used to identify this set of tuples.
- getQueryCriteria() - Method in class com.marklogic.client.io.ValuesHandle
-
- getQueryCriteria() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the query definition associated with this query.
- getQueryCriteria() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns the query used to locate these tuples.
- getQueryCriteria() - Method in interface com.marklogic.client.query.ValuesResults
-
Return the query definition for this set of results.
- getQueryDefinition() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the query definition associated with this values query.
- getQueryFailureListeners() - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Get the array of QueryFailureListener instances registered via onBatchFailure including the HostAvailabilityListener registered by default.
- getQueryOptionValidation() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server validates query options before storing them.
- getQueryResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the query resolution time in milliseconds.
- getQueryStrings() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the array of strings set for this SuggestDefinition.
- getQuerySuccessListeners() - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Get the array of QueryBatchListener instances registered via onBatchSuccess.
- getQueryValidation() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server validates queries before running them.
- getReader() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the dom4j reader for XML content.
- getReadTransform() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the transform for read requests that don’t specify a transform.
- getRelevanceInfo() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Get relevance info for a particular result.
- getRelevanceInfo(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the relevance information for the result.
- getReports() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of any reports associated with this search.
- getReports() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of reports returned by this search.
- getReportTimestamp() - Method in interface com.marklogic.client.datamovement.JobReport
-
Gets the timestamp at which this instance of JobReport was created
- getRequestLogger() - Method in interface com.marklogic.client.extensions.ResourceServices
-
Returns the logger for debugging client requests.
- getResolver() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the resolver for resolving references while parsing the document.
- getResolver() - Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the resolver for resolving references while parsing the input source.
- getResolver() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns the resolver for resolving references while parsing the event reader source.
- getResolver() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns the resolver for resolving references while parsing the event reader source.
- getResourceName() - Method in interface com.marklogic.client.extensions.ResourceServices
-
Returns the name of the resource.
- getResponseTransform() - Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the transform that modifies responses to this query on the server.
- getRoleName() - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
gets the role name for this permission.
- getRowStructureStyle() - Method in interface com.marklogic.client.row.RowManager
-
Returns whether each row should have an array or object structure in the response for requests made with the row manager.
- getRulesets() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getRulesProvider() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getScore() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the score associated with the document.
- getScriptLanguage() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the script language for this resource extension, either XQUERY (default) or JAVASCRIPT.
- getSearchResult(R) - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- getSearchView() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the view types included in a SearchReadHandle populated by calls to
search
- getSecurityContext() - Method in interface com.marklogic.client.DatabaseClient
-
- getSecurityContext() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the security context for clients created with a DatabaseClientFactory.Bean object - BasicAuthContext, DigestAuthContext or KerberosAuthContext
- getSerializer() - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- getServer() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- getServerRequestLogging() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server logs requests to the error log on the server.
- getServerTimestamp() - Method in interface com.marklogic.client.datamovement.QueryBatch
-
The server timestamp at which this query was run (if this job is running withConsistentSnapshot()).
- getServerTimestamp() - Method in class com.marklogic.client.io.BaseHandle
-
- getShort(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:short schema data type as a Java short primitive value.
- getShort(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:short schema data type as a Java short primitive value.
- getShort() - Method in interface com.marklogic.client.type.XsShortVal
-
- getShort() - Method in interface com.marklogic.client.type.XsUnsignedShortVal
-
- getShortItems() - Method in interface com.marklogic.client.type.XsShortSeqVal
-
- getSimilarDocumentUris() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the uris for documents similar to the result (if requested).
- getSnippetIterator(T) - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an iterator over the snippets matched for the result.
- getSnippetResolutionTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the snippet resolution time in milliseconds.
- getSnippets() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an array of snippets.
- getSnippets() - Method in interface com.marklogic.client.query.MatchLocation
-
Returns the array of elements in the snippet.
- getSnippetTransformType() - Method in class com.marklogic.client.io.SearchHandle
-
Identifies whether results have default, raw document, customer, or no snippets.
- getSnippetTransformType() - Method in interface com.marklogic.client.query.SearchResults
-
The type of transform used to produce the result snippets.
- getSparql() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Get the SPARQL query or update statement
- getSSLContext() - Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- getSSLHostnameVerifier() - Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- getStart() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the start page for this search.
- getStart() - Method in interface com.marklogic.client.Page
-
The start position of this page within all possible items.
- getStart() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the offset of the first result in the search reponse page.
- getString() - Method in interface com.marklogic.client.eval.EvalResult
-
This result directly as a string.
- getString(String) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:string schema data type as a Java String literal value.
- getString(PlanExprCol) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:string schema data type as a Java String literal value.
- getString() - Method in interface com.marklogic.client.type.RdfLangStringVal
-
- getString() - Method in interface com.marklogic.client.type.SemIriVal
-
- getString() - Method in interface com.marklogic.client.type.XsAnyURIVal
-
- getString() - Method in interface com.marklogic.client.type.XsStringVal
-
- getString() - Method in interface com.marklogic.client.type.XsUntypedAtomicVal
-
- getStringCriteria() - Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the text of the suggestion call.
- getStringItems() - Method in interface com.marklogic.client.type.XsStringSeqVal
-
- getStringQueries() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the list of string queries, if specified by the query options.
- getStringQueries() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the string query input (if provided and requested).
- getSuccess() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- getSuccess() - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getSuccessBatchesCount() - Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher : gets the number of batches written to the database
QueryBatcher : gets the number of batches of URIs read from the database
- getSuccessEventsCount() - Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher : gets the number of documents written to the database
QueryBatcher : gets the number of uris read from the database
- getSuspendTimeForHostUnavailable() - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
- getTargetUri() - Method in interface com.marklogic.client.datamovement.WriteEvent
-
The uri written to the server.
- getTemporalCollection() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
The temporal collection configured for temporal document inserts
- getTemporalDocumentURI() - Method in interface com.marklogic.client.document.DocumentWriteOperation
-
The logical temporal document URI of the document as set by your call to one of the ‘add’ methods which adds a document to a
DocumentWriteSet
- getTemporalSystemTime() - Method in interface com.marklogic.client.bitemporal.TemporalDescriptor
-
Returns the temporal system time when the document was written or deleted.
- getText() - Method in interface com.marklogic.client.query.MatchSnippet
-
Returns the string value of the run of text in this part of the snippet.
- getThreadCount() - Method in interface com.marklogic.client.datamovement.Batcher
-
- getTimeItems() - Method in interface com.marklogic.client.type.XsTimeSeqVal
-
- getTimestamp() - Method in interface com.marklogic.client.datamovement.Batch
-
The client-side timestamp when this batch completed writing or reading.
- getTitle() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the title of the extension.
- getTotalPages() - Method in interface com.marklogic.client.Page
-
The number of pages covering all possible items.
- getTotalResults() - Method in class com.marklogic.client.io.SearchHandle
-
Returns the total number of results in this search.
- getTotalResults() - Method in interface com.marklogic.client.query.SearchResults
-
Returns an estimate of the total number of results, which is accurate for unfiltered queries.
- getTotalSize() - Method in interface com.marklogic.client.Page
-
The total count (most likely an
estimate) of all possible items in the set.
- getTotalTime() - Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the total time taken by the query in milliseconds.
- getTotalTime() - Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the total time taken by the query in milliseconds.
- getTransactionId() - Method in interface com.marklogic.client.Transaction
-
Returns the identifier for the transaction.
- getTransform() - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- getTransformer() - Method in class com.marklogic.client.io.SourceHandle
-
Returns a transformer for modifying the content.
- getTuples() - Method in class com.marklogic.client.io.TuplesHandle
-
Returns an array of the Tuples returned by this query.
- getTuples() - Method in interface com.marklogic.client.query.TuplesResults
-
Returns an array of Tuples.
- getType() - Method in interface com.marklogic.client.eval.EvalResult
-
The
EvalResult.Type of this result from the X-Primitive header provided by the REST API eval endpoint.
- getType() - Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the type of the message.
- getType() - Method in class com.marklogic.client.io.ValuesHandle
-
- getType() - Method in class com.marklogic.client.query.TypedDistinctValue
-
Returns the type of the value.
- getType() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns the type of the values.
- getUnmarshaller() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the unmarshaller that converts a tree data structure from XML to Java objects, reusing any existing unmarshaller.
- getUnmarshaller(boolean) - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the unmarshaller that converts a tree data structure from XML to Java objects.
- getUnsignedByteItems() - Method in interface com.marklogic.client.type.XsUnsignedByteSeqVal
-
- getUnsignedIntItems() - Method in interface com.marklogic.client.type.XsUnsignedIntSeqVal
-
- getUnsignedLongItems() - Method in interface com.marklogic.client.type.XsUnsignedLongSeqVal
-
- getUnsignedShortItems() - Method in interface com.marklogic.client.type.XsUnsignedShortSeqVal
-
- getUntypedAtomicItems() - Method in interface com.marklogic.client.type.XsUntypedAtomicSeqVal
-
- getUpdatePermissions() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Get any permissions set on this instance.
- getUpdatePolicy() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the policy for updating or deleting documents in the database.
- getUri() - Method in interface com.marklogic.client.bitemporal.TemporalDescriptor
-
Returns the URI identifier for the database document.
- getUri() - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Returns the URI identifier for the database document.
- getUri() - Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the uri (unique identifier) of the document in the server
- getUri() - Method in interface com.marklogic.client.document.DocumentWriteOperation
-
- getUri() - Method in class com.marklogic.client.example.extension.BatchManager.OutputItem
-
- getUri() - Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the URI of the document.
- getUsage() - Static method in class com.marklogic.client.example.util.Bootstrapper
-
- getUser() - Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- getUser() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- getUser() - Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- getUser() - Method in class com.marklogic.client.example.util.Bootstrapper.ConfigServer
-
- getUsingGraphUris() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getUsingNamedGraphUris() - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getValue() - Method in class com.marklogic.client.query.AggregateResult
-
Returns the value of this aggregate as a string.
- getValue() - Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getValueAs(String, Class<T>) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an atomic schema data type.
- getValueAs(PlanExprCol, Class<T>) - Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an atomic schema data type.
- getValueOf(String) - Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
- getValues() - Method in class com.marklogic.client.io.ValuesHandle
-
- getValues() - Method in class com.marklogic.client.query.Tuple
-
Returns an array of all the values in this tuple.
- getValues() - Method in interface com.marklogic.client.query.ValuesResults
-
Returns an array of the values.
- getValuesMap() - Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Returns a HashMap of the named query options from the server.
- getValuesMap() - Method in class com.marklogic.client.io.ValuesListHandle
-
Returns a HashMap of the named lexicon configurations.
- getValuesMap() - Method in interface com.marklogic.client.query.QueryOptionsListResults
-
Returns a HashMap of the named query options from the server.
- getValuesMap() - Method in interface com.marklogic.client.query.ValuesListResults
-
Returns the map of value results.
- getValuesResolutionTime() - Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the query resolution time in milliseconds.
- getVerifier() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- getVersion() - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the version identifier for the extension implementation.
- getVersion() - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Returns the version for the database document.
- getView() - Method in interface com.marklogic.client.query.QueryManager
-
Returns the type of view results produced by queries.
- getView() - Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the view for this values query.
- getWarnings() - Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of any warnings associated with this search.
- getWarnings() - Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of warnings returned by this search.
- getWriteTransform() - Method in interface com.marklogic.client.document.DocumentManager
-
Returns the transform for write requests that don’t specify a transform.
- getXMLGregorianCalendar() - Method in interface com.marklogic.client.type.XsGDayVal
-
- getXMLGregorianCalendar() - Method in interface com.marklogic.client.type.XsGMonthDayVal
-
- getXMLGregorianCalendar() - Method in interface com.marklogic.client.type.XsGMonthVal
-
- getXMLGregorianCalendar() - Method in interface com.marklogic.client.type.XsGYearMonthVal
-
- getXMLGregorianCalendar() - Method in interface com.marklogic.client.type.XsGYearVal
-
- getXPathProcessor() - Method in class com.marklogic.client.io.DOMHandle
-
Get the processor used to evaluate XPath expressions.
- getYearMonthDurationItems() - Method in interface com.marklogic.client.type.XsYearMonthDurationSeqVal
-
- gMonth(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:gMonth server data type.
- gMonth(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a month as a string and constructs an xs:gMonth value
- gMonth(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a month as a XMLGregorianCalendar value and constructs an xs:gMonth value
- gMonthDay(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:gMonthDay server data type.
- gMonthDay(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a day and month as a string and constructs an xs:gMonthDay value
- gMonthDay(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a day and month as a XMLGregorianCalendar value and constructs an xs:gMonthDay value
- GMonthDaySeq(XsGMonthDayExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsGMonthDayExpr items.
- gMonthDaySeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days and months as a string and constructs an xs:gMonthDay sequence
- gMonthDaySeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days and months as a XMLGregorianCalendar value and constructs an xs:gMonthDay sequence
- gMonthDaySeq(XsGMonthDayVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gMonthDay values and constructs an xs:gMonthDay sequence
- GMonthSeq(XsGMonthExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsGMonthExpr items.
- gMonthSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months as a string and constructs an xs:gMonth sequence
- gMonthSeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months as a XMLGregorianCalendar value and constructs an xs:gMonth sequence
- gMonthSeq(XsGMonthVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gMonth values and constructs an xs:gMonth sequence
- graphCol(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies the graph for a triple providing one or more columns for a row.
- graphCol(XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies the graph for a triple providing one or more columns for a row.
- GraphManager - Interface in com.marklogic.client.semantics
-
A manager for CRUD operations on semantic graphs which reside in
MarkLogic Server.
- GraphPermissions - Interface in com.marklogic.client.semantics
-
A Map of permissions for a graph, where the keys are roles and the values
are the Set of capabilities available to that role (one of READ, UPDATE, or
EXECUTE).
- GraphSPARQLExample - Class in com.marklogic.client.example.extension
-
- GraphSPARQLExample() - Constructor for class com.marklogic.client.example.extension.GraphSPARQLExample
-
- groupBy(PlanExprColSeq) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method collapses a group of rows into a single row.
- groupBy(PlanExprColSeq, PlanAggregateColSeq) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method collapses a group of rows into a single row.
- groupConcat(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function concatenates the non-null values of the column for the rows in the group or row set.
- groupConcat(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function concatenates the non-null values of the column for the rows in the group or row set.
- groupConcat(String, String, PlanGroupConcatOptionSeq) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function concatenates the non-null values of the column for the rows in the group or row set.
- groupConcat(PlanColumn, PlanExprCol, PlanGroupConcatOptionSeq) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function concatenates the non-null values of the column for the rows in the group or row set.
- GSONHandle - Class in com.marklogic.client.extra.gson
-
A GSONHandle represents JSON content as a GSON JsonElement for reading or writing.
- GSONHandle() - Constructor for class com.marklogic.client.extra.gson.GSONHandle
-
Zero-argument constructor.
- GSONHandle(JsonElement) - Constructor for class com.marklogic.client.extra.gson.GSONHandle
-
Provides a handle on JSON content as a tree.
- GSONHandleExample - Class in com.marklogic.client.example.handle
-
GSONHandleExample illustrates writing and reading content as a JSON structure using the GSON extra library.
- GSONHandleExample() - Constructor for class com.marklogic.client.example.handle.GSONHandleExample
-
- gt(XsAnyAtomicTypeExpr, XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the value of the left expression is greater than the value of the right expression.
- gYear(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:gYear server data type.
- gYear(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a year as a string and constructs an xs:gYear value
- gYear(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a year as a XMLGregorianCalendar value and constructs an xs:gYear value
- gYearMonth(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:gYearMonth server data type.
- gYearMonth(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a month and year as a string and constructs an xs:gYearMonth value
- gYearMonth(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a month and year as a XMLGregorianCalendar value and constructs an xs:gYearMonth value
- GYearMonthSeq(XsGYearMonthExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsGYearMonthExpr items.
- gYearMonthSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months and years as a string and constructs an xs:gYearMonth sequence
- gYearMonthSeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months and years as a XMLGregorianCalendar value and constructs an xs:gYearMonth sequence
- gYearMonthSeq(XsGYearMonthVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gYearMonth values and constructs an xs:gYearMonth sequence
- GYearSeq(XsGYearExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsGYearExpr items.
- gYearSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of years as a string and constructs an xs:gYear sequence
- gYearSeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of years as a XMLGregorianCalendar value and constructs an xs:gYear sequence
- gYearSeq(XsGYearVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gYear values and constructs an xs:gYear sequence
- JacksonDatabindHandle<T> - Class in com.marklogic.client.io
-
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.
- JacksonDatabindHandle(Class<T>) - Constructor for class com.marklogic.client.io.JacksonDatabindHandle
-
Specify the type of content this JacksonDatabindHandle will manage.
- JacksonDatabindHandle(T) - Constructor for class com.marklogic.client.io.JacksonDatabindHandle
-
Provides a handle on POJO content.
- JacksonHandle - Class in com.marklogic.client.io
-
An adapter for using the Jackson Open Source library for JSON; represents JSON content as a Jackson JsonNode for reading or writing.
- JacksonHandle() - Constructor for class com.marklogic.client.io.JacksonHandle
-
Zero-argument constructor.
- JacksonHandle(JsonNode) - Constructor for class com.marklogic.client.io.JacksonHandle
-
Provides a handle on JSON content as a Jackson tree.
- JacksonHandleExample - Class in com.marklogic.client.example.handle
-
JacksonHandleExample illustrates writing and reading content as a JSON structure using the Jackson extra library.
- JacksonHandleExample() - Constructor for class com.marklogic.client.example.handle.JacksonHandleExample
-
- JacksonParserHandle - Class in com.marklogic.client.io
-
An adapter for using the streaming capabilities of the Jackson Open Source library.
- JacksonParserHandle() - Constructor for class com.marklogic.client.io.JacksonParserHandle
-
- JAVASCRIPT - Static variable in class com.marklogic.client.admin.ExtensionMetadata
-
Convenience constant to provide something shorter than ExtensionMetadata.ScriptLanguage.JAVASCRIPT
- javascript(String) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side eval with javascript-syntax source code.
- javascript(TextWriteHandle) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side eval call with javascript-syntax source code.
- JavascriptResourceExtension - Class in com.marklogic.client.example.cookbook
-
JavascriptResourceExtension installs an extension for managing spelling dictionary resources.
- JavascriptResourceExtension() - Constructor for class com.marklogic.client.example.cookbook.JavascriptResourceExtension
-
- JavascriptResourceExtension.HelloWorld - Class in com.marklogic.client.example.cookbook
-
HelloWorld provides an example of a class that implements a resource extension client, exposing a method for each service.
- JAXBDocument - Class in com.marklogic.client.example.cookbook
-
JAXBDocument illustrates how to write and read a POJO structure as a database document.
- JAXBDocument() - Constructor for class com.marklogic.client.example.cookbook.JAXBDocument
-
- JAXBDocument.Product - Class in com.marklogic.client.example.cookbook
-
Product provides an example of a class with JAXB annotations.
- JAXBHandle<C> - Class in com.marklogic.client.io
-
A JAXB Handle roundtrips a POJO (a Java data structure) to and from a database document.
- JAXBHandle(JAXBContext) - Constructor for class com.marklogic.client.io.JAXBHandle
-
Initializes the JAXB handle with the JAXB context for the classes of the marshalled or unmarshalled structure.
- JDOMHandle - Class in com.marklogic.client.extra.jdom
-
A JDOM Handle represents XML content as a JDOM document for reading or writing.
- JDOMHandle() - Constructor for class com.marklogic.client.extra.jdom.JDOMHandle
-
Zero-argument constructor.
- JDOMHandle(Document) - Constructor for class com.marklogic.client.extra.jdom.JDOMHandle
-
Provides a handle on XML content as a JDOM document structure.
- JDOMHandleExample - Class in com.marklogic.client.example.handle
-
JDOMHandleExample illustrates writing and reading content as a JDOM structure using the JDOM extra library.
- JDOMHandleExample() - Constructor for class com.marklogic.client.example.handle.JDOMHandleExample
-
- JobReport - Interface in com.marklogic.client.datamovement
-
A Job report is used to report status on a
WriteBatcher or a
QueryBatcher job at any point of time after it is started and provide a snapshot of the job’s status at that time.
- JobTicket - Interface in com.marklogic.client.datamovement
-
JobTicket is used to uniquely identify a job.
- JobTicket.JobType - Enum in com.marklogic.client.datamovement
-
- joinCrossProduct(PlanBuilder.ModifyPlan) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set that concatenates every left row with every right row.
- joinCrossProduct(PlanBuilder.ModifyPlan, boolean) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set that concatenates every left row with every right row.
- joinCrossProduct(PlanBuilder.ModifyPlan, XsBooleanExpr) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set that concatenates every left row with every right row.
- joinDoc(String, String) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function specifies a document column to add to the rows by reading the documents for an existing source column having a value of a document uri (which can be used to read other documents) or a fragment id (which can be used to read the source documents for rows).
- joinDoc(PlanColumn, PlanColumn) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function specifies a document column to add to the rows by reading the documents for an existing source column having a value of a document uri (which can be used to read other documents) or a fragment id (which can be used to read the source documents for rows).
- joinDocUri(String, String) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row.
- joinDocUri(PlanColumn, PlanColumn) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKey...) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKeySeq) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKeySeq, XsBooleanExpr) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple tables where the join condition is met.
- joinKeySeq(PlanJoinKey...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKey...) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the rows from an inner join as well as rows from the left row set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the rows from an inner join as well as rows from the left row set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the rows from an inner join as well as rows from the left row set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq, XsBooleanExpr) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the rows from an inner join as well as rows from the left row set.
- joinList(List<String>) - Static method in class com.marklogic.client.example.util.Bootstrapper
-
- joinList(List<String>, String) - Static method in class com.marklogic.client.example.util.Bootstrapper
-
- json - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with json server functions.
- jsonArray(JsonContentNodeExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON array during row processing.
- JsonArrayExpr - Interface in com.marklogic.client.type
-
An instance of a JSON array expression.
- JsonArraySeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON array expressions.
- jsonBoolean(boolean) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON boolean node with the specified value.
- jsonBoolean(XsBooleanExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON boolean node with the specified value.
- JsonContentNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON boolean, null, number, or text node expression.
- JsonContentNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON boolean, null, number, or text node expressions.
- jsonDocument(JsonRootNodeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON document with the root content, which must be exactly one JSON object or array node.
- JSONDocumentManager - Interface in com.marklogic.client.document
-
A JSON Document Manager supports database operations on JSON documents.
- JSONErrorParser - Class in com.marklogic.client.io
-
This class is provided as a convenience method for parsing MarkLogic errors that are serialized as JSON.
- JSONErrorParser() - Constructor for class com.marklogic.client.io.JSONErrorParser
-
- JsonExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the json server library for a row pipeline.
- jsonNull() - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON null node.
- jsonNumber(double) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON number node with the specified value.
- jsonNumber(XsNumericExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON number node with the specified value.
- jsonObject(PlanJsonProperty...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON object with the specified properties.
- JsonObjectExpr - Interface in com.marklogic.client.type
-
An instance of a JSON object expression.
- JsonObjectSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON object expressions.
- jsonProperty(String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a JSON property to match with a query.
- jsonPropertyChildGeospatialQuery(String, String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(XsStringSeqVal, XsStringSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(String, String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(XsStringSeqVal, XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(String, String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(XsStringSeqVal, XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(XsStringSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(String, String, String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(String, String, String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(String, String, String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- jsonPropertyRangeQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
- jsonPropertyReference(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyReference(XsStringVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyReference(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyReference(XsStringVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyScopeQuery(String, CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with the content constrained by the given cts:query in the second parameter.
- jsonPropertyScopeQuery(XsStringSeqVal, CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by name with the content constrained by the given cts:query in the second parameter.
- jsonPropertyValueQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with value equal the given value.
- jsonPropertyValueQuery(XsStringSeqVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with value equal the given value.
- jsonPropertyValueQuery(String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with value equal the given value.
- jsonPropertyValueQuery(XsStringSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with value equal the given value.
- jsonPropertyValueQuery(String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with value equal the given value.
- jsonPropertyValueQuery(XsStringSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with value equal the given value.
- jsonPropertyWordQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with text content containing a given phrase.
- jsonPropertyWordQuery(XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with text content containing a given phrase.
- jsonPropertyWordQuery(String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with text content containing a given phrase.
- jsonPropertyWordQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with text content containing a given phrase.
- jsonPropertyWordQuery(String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with text content containing a given phrase.
- jsonPropertyWordQuery(XsStringSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name with text content containing a given phrase.
- JSONReadHandle - Interface in com.marklogic.client.io.marker
-
A JSON Read Handle can represent JSON content read from the database.
- JsonRootNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON array or object node expression.
- JsonRootNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON array or object node expressions.
- jsonString(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON text node with the specified value.
- jsonString(XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON text node with the specified value.
- JSONWriteHandle - Interface in com.marklogic.client.io.marker
-
A JSON Write Handle can represent JSON content written to the database.
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.AllCookbookExamples
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.ClientCreator
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentDelete
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentFormats
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataWrite
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentOutputStream
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteServerURI
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.JavascriptResourceExtension
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.KerberosSSLClientCreator
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.ResourceExtension
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.SSLClientCreator
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- main(String[]) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- main(String[]) - Static method in class com.marklogic.client.example.extension.BatchManagerExample
-
- main(String...) - Static method in class com.marklogic.client.example.extension.GraphSPARQLExample
-
- main(String[]) - Static method in class com.marklogic.client.example.extension.OpenCSVBatcherExample
-
- main(String[]) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.HTMLCleanerHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.URIHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- main(String[]) - Static method in class com.marklogic.client.example.util.Bootstrapper
-
Command-line invocation.
- main(String[]) - Static method in class com.marklogic.client.example.util.BootstrapperExample
-
- main(String[]) - Static method in class com.marklogic.client.pojo.util.GenerateIndexConfig
-
Reads the annotations from the specified classes and generates MarkLogic index configurations specified by the annotations.
- makeHandle(Class<C>) - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Creates a ContentHandle if the registry has a factory for the class of the IO representation.
- makeSampleServer() - Method in class com.marklogic.client.example.util.BootstrapperExample
-
- makeServer(Properties) - Method in class com.marklogic.client.example.util.Bootstrapper
-
Invocation based on properties.
- makeServer(Bootstrapper.ConfigServer, Bootstrapper.RESTServer) - Method in class com.marklogic.client.example.util.Bootstrapper
-
Programmatic invocation.
- mangleToNCName(String) - Static method in class com.marklogic.client.example.extension.NameConverter
-
- map() - Method in interface com.marklogic.client.expression.MapExpr
-
Creates a map.
- map(ElementNodeExpr) - Method in interface com.marklogic.client.expression.MapExpr
-
Creates a map.
- map - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with map server functions.
- map(PlanFunction) - Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies the specified function to each row returned by the plan to produce a different result row.
- MapExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the map server library for a row pipeline.
- MapMapExpr - Interface in com.marklogic.client.type
-
An instance of a map expression.
- MapMapSeqExpr - Interface in com.marklogic.client.type
-
A sequence of map expressions.
- mapSeq(MapMapExpr...) - Method in interface com.marklogic.client.expression.MapExpr
-
Constructs a sequence of MapMapExpr items.
- MarkLogicBindingException - Exception in com.marklogic.client
-
A Binding Exception indicates a problem converting between a Java object and XML representation of the data.
- MarkLogicBindingException(String, Throwable) - Constructor for exception com.marklogic.client.MarkLogicBindingException
-
- MarkLogicBindingException(Exception) - Constructor for exception com.marklogic.client.MarkLogicBindingException
-
- MarkLogicBindingException(String) - Constructor for exception com.marklogic.client.MarkLogicBindingException
-
- MarkLogicInternalException - Exception in com.marklogic.client
-
An InternalException suggests a defect in the API.
- MarkLogicInternalException(String) - Constructor for exception com.marklogic.client.MarkLogicInternalException
-
- MarkLogicInternalException(Throwable) - Constructor for exception com.marklogic.client.MarkLogicInternalException
-
- MarkLogicInternalException(String, Throwable) - Constructor for exception com.marklogic.client.MarkLogicInternalException
-
- MarkLogicIOException - Exception in com.marklogic.client
-
An IO Exception indicates that there was a problem on input or output (similar to a java.lang.IOException but defined as a runtime rather than checked exception).
- MarkLogicIOException(String) - Constructor for exception com.marklogic.client.MarkLogicIOException
-
- MarkLogicIOException(Throwable) - Constructor for exception com.marklogic.client.MarkLogicIOException
-
- MarkLogicIOException(String, Throwable) - Constructor for exception com.marklogic.client.MarkLogicIOException
-
- MarkLogicServerException - Exception in com.marklogic.client
-
Abstract class that implements functionality for errors returned from a MarkLogic REST API instance.
- MarkLogicServerException(String, FailedRequest) - Constructor for exception com.marklogic.client.MarkLogicServerException
-
- MarkLogicServerException(String) - Constructor for exception com.marklogic.client.MarkLogicServerException
-
- MarkLogicServerException(String, Throwable) - Constructor for exception com.marklogic.client.MarkLogicServerException
-
- match(QueryDefinition, T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on the results of a search.
- match(QueryDefinition, long, long, String[], T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on results of a search, with pagination applied to search.
- match(QueryDefinition, long, long, String[], T, ServerTransform) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on results of a search, with pagination applied to search.
- match(String[], T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on an array of document IDS.
- match(String[], String[], T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on an array of document IDs and an array of rule names.
- match(String[], String[], T, ServerTransform) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on an array of document IDs and an array of rule names.
- match(StructureWriteHandle, T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on a document supplied in a write handle.
- match(StructureWriteHandle, String[], T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on a document supplied in a write handle.
- match(StructureWriteHandle, String[], T, ServerTransform) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on a document supplied in a write handle.
- match(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- matchAs(Object, T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.
- matchAs(Object, String[], T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.
- matchAs(Object, String[], T, ServerTransform) - Method in interface com.marklogic.client.alerting.RuleManager
-
Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.
- MatchDocumentSummary - Interface in com.marklogic.client.query
-
A MatchDocumentSummary is the information returned for each document found by a search.
- matches(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified input matches the specified pattern, otherwise returns false.
- matches(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified input matches the specified pattern, otherwise returns false.
- matches(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified input matches the specified pattern, otherwise returns false.
- matches(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified input matches the specified pattern, otherwise returns false.
- MatchLocation - Interface in com.marklogic.client.query
-
A MatchLocation represents a location in a document matched by a search.
- MatchSnippet - Interface in com.marklogic.client.query
-
A MatchSnippet is a Java object representation of a part of a snippet.
- math - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with math server functions.
- MathExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the math server library for a row pipeline.
- MathLinearModelExpr - Interface in com.marklogic.client.type
-
An instance of a math.linearModel expression.
- MathLinearModelSeqExpr - Interface in com.marklogic.client.type
-
A sequence of math.linearModel expressions.
- max(XsAnyAtomicTypeSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Selects an item from the input sequence arg whose value is greater than or equal to the value of every other item in the input sequence.
- max(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Selects an item from the input sequence arg whose value is greater than or equal to the value of every other item in the input sequence.
- max(XsAnyAtomicTypeSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Selects an item from the input sequence arg whose value is greater than or equal to the value of every other item in the input sequence.
- max(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the largest non-null value of the column for the rows in the group or row set.
- max(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the largest non-null value of the column for the rows in the group or row set.
- max(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the largest non-null value of the column for the rows in the group or row set.
- max(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the largest non-null value of the column for the rows in the group or row set.
- md5(ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the md5 hash of the given argument.
- md5(ItemExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the md5 hash of the given argument.
- md5(ItemExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the md5 hash of the given argument.
- median(XsDoubleSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the median of a sequence of values.
- merge(Map<String, List<String>>) - Method in class com.marklogic.client.document.ServerTransform
-
Merges the transform and its parameters with other parameters of the request.
- merge(String, TriplesWriteHandle) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the handle to the specified graph.
- merge(String, TriplesWriteHandle, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the handle to the specified graph.
- merge(String, TriplesWriteHandle, GraphPermissions) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the handle and add specified permissions to the
specified graph.
- merge(String, TriplesWriteHandle, GraphPermissions, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the handle and add specified permissions to the
specified graph.
- mergeAs(String, Object) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the graphData object to the specified graph.
- mergeAs(String, Object, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the graphData object to the specified graph.
- mergeAs(String, Object, GraphPermissions) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the graphData object and add specified permissions
to the specified graph.
- mergeAs(String, Object, GraphPermissions, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add triples from the graphData object and add specified permissions
to the specified graph.
- mergeGraphs(QuadsWriteHandle) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add quads from the handle to the graphs specified in the quads data.
- mergeGraphs(QuadsWriteHandle, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add quads from the handle to the graphs specified in the quads data.
- mergeGraphsAs(Object) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add quads from the object to the graphs specified in the quads data.
- mergeGraphsAs(Object, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add quads from the object to the graphs specified in the quads data.
- mergePermissions(String, GraphPermissions) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add to permissions on the graph.
- mergePermissions(String, GraphPermissions, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Add to permissions on the graph.
- MethodParameters(MethodType) - Constructor for class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Declares the parameters for a method the provides services for a resource.
- MethodType - Enum in com.marklogic.client.admin
-
The Method Type enumerates a kind of operation.
- min(XsAnyAtomicTypeSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Selects an item from the input sequence arg whose value is less than or equal to the value of every other item in the input sequence.
- min(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Selects an item from the input sequence arg whose value is less than or equal to the value of every other item in the input sequence.
- min(XsAnyAtomicTypeSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Selects an item from the input sequence arg whose value is less than or equal to the value of every other item in the input sequence.
- min(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the smallest non-null value of the column for the rows in the group or row set.
- min(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the smallest non-null value of the column for the rows in the group or row set.
- min(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the smallest non-null value of the column for the rows in the group or row set.
- min(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function gets the smallest non-null value of the column for the rows in the group or row set.
- minutes(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
- minutesFromDateTime(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of arg.
- minutesFromDuration(XsDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of arg.
- minutesFromTime(XsTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
- mode(XsAnyAtomicTypeSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the mode of a sequence.
- mode(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the mode of a sequence.
- mode(XsAnyAtomicTypeSeqExpr, XsStringSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the mode of a sequence.
- modf(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns x broken up into fraction and integer.
- modifyDatabase(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- modulePath(String) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side invoke call with a path to the module to invoke.
- modulo(double, double) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns the remainder afer the division of the dividend and divisor expressions.
- modulo(XsNumericExpr, XsNumericExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns the remainder afer the division of the dividend and divisor expressions.
- month(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
- monthFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
- monthFromDateTime(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
- monthname(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns month name, calculated from the localized value of arg.
- monthNameFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns month name, calculated from the localized value of arg.
- monthsFromDuration(XsDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer representing the months component in the canonical lexical representation of the value of arg.
- mul64(XsUnsignedLongExpr, XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Muliply two 64-bit integer values, discarding overflow.
- multiply(Number) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to multiply an existing value.
- multiply(XsNumericExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function multipies the left numericExpression by the right numericExpression and returns the value.
- MultiStatementTransaction - Class in com.marklogic.client.example.cookbook
-
MultiStatementTransaction illustrates how to open a transaction, execute multiple statements under the transaction, and commit the transaction.
- MultiStatementTransaction() - Constructor for class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- N3 - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- NAME - Static variable in class com.marklogic.client.example.cookbook.JavascriptResourceExtension.HelloWorld
-
- NAME - Static variable in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- NAME - Static variable in class com.marklogic.client.example.extension.BatchManager
-
- NAME - Static variable in class com.marklogic.client.example.extension.DocumentSplitter
-
- NAME - Static variable in class com.marklogic.client.example.extension.SearchCollector
-
- name(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the name of a node, as an xs:string that is either the zero-length string, or has the lexical form of an xs:QName.
- Name(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:Name server data type.
- NameConverter - Class in com.marklogic.client.example.extension
-
NameConverter mangles and unmangles strings as local names for XML elements.
- NameConverter() - Constructor for class com.marklogic.client.example.extension.NameConverter
-
- NameMap<V> - Interface in com.marklogic.client.util
-
A NameMap defines the interface for maps where the key is a QName (a name qualified by a URI for global uniqueness or for association with a domain).
- NameSeq(XsNameExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNameExpr items.
- namespaceContext(EditableNamespaceContext) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this call with namespaces so variables with prefixes can be sent with their prefixes translated to uris that will match the uris in the code to be executed on the server.
- NamespacesManager - Interface in com.marklogic.client.admin
-
The NamespacesManager provides access and editing for the namespaces defined on the server.
- namespaceUri(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the namespace URI of the xs:QName of the node specified by arg.
- namespaceUriForPrefix(XsStringExpr, ElementNodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the namespace URI of one of the in-scope namespaces for element, identified by its namespace prefix.
- namespaceUriFromQName(XsQNameExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the namespace URI for arg as an xs:string.
- NCName(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:NCName server data type.
- NCNameSeq(XsNCNameExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNCNameExpr items.
- ne(XsAnyAtomicTypeExpr, XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the value of the left expression is not equal to the value of the right expression.
- near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- near(StructuredQueryDefinition...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- near(StructuredQueryDefinition...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query definitions with default parameters.
- near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query definitions with specified parameters.
- nearQuery(CtsQueryExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr, double, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr, XsDoubleVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr, double, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- nearQuery(CtsQuerySeqExpr, XsDoubleVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
- negativeInteger(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:negativeInteger server data type.
- negativeIntegerSeq(XsNegativeIntegerExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNegativeIntegerExpr items.
- newBatchRequest() - Method in class com.marklogic.client.example.extension.BatchManager
-
- newBinaryDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents with a binary format such as images.
- newClient() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Creates a client for bean applications based on the properties.
- newClient(String, int) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server without any authentication.
- newClient(String, int, String) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server without any authentication.
- newClient(String, int, DatabaseClientFactory.SecurityContext) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server.
- newClient(String, int, String, DatabaseClientFactory.SecurityContext) - Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means of a REST server.
- newClient(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.DatabaseClientFactory
-
- newClient(String, int, String, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.DatabaseClientFactory
-
- newClient(String, int, String, String, DatabaseClientFactory.Authentication, SSLContext) - Static method in class com.marklogic.client.DatabaseClientFactory
-
- newClient(String, int, String, String, String, DatabaseClientFactory.Authentication, SSLContext) - Static method in class com.marklogic.client.DatabaseClientFactory
-
- newClient(String, int, String, String, DatabaseClientFactory.Authentication, SSLContext, DatabaseClientFactory.SSLHostnameVerifier) - Static method in class com.marklogic.client.DatabaseClientFactory
-
- newClient(String, int, String, String, String, DatabaseClientFactory.Authentication, SSLContext, DatabaseClientFactory.SSLHostnameVerifier) - Static method in class com.marklogic.client.DatabaseClientFactory
-
- newDataMovementManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for long-running asynchronous write or query jobs.
- newDeleteDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for deleting documents.
- newDescriptor(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a document descriptor for identifying the uri of a document, its format and mimetype, and its version.
- newDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents with unknown or heterogeneous formats.
- newDocumentUriTemplate(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Creates a document uri template for assigning a uri to a document.
- newExtensionLibrariesManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for writing and reading assets in the REST server’s modules database.
- newFactory() - Static method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Creates a factory to create a DOM4JHandle instance for a dom4j document.
- newFactory() - Static method in class com.marklogic.client.extra.gson.GSONHandle
-
Creates a factory to create a GSONHandle instance for a JsonElement node.
- newFactory() - Static method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Creates a factory to create a JDOMHandle instance for a JDOM document.
- newFactory() - Static method in class com.marklogic.client.extra.xom.XOMHandle
-
Creates a factory to create a XOMHandle instance for a XOM document.
- newFactory() - Static method in class com.marklogic.client.io.BytesHandle
-
Creates a factory to create a BytesHandle instance for a byte[] array.
- newFactory() - Static method in class com.marklogic.client.io.DOMHandle
-
Creates a factory to create a DOMHandle instance for a DOM document.
- newFactory() - Static method in class com.marklogic.client.io.FileHandle
-
Creates a factory to create a FileHandle for a file.
- newFactory() - Static method in class com.marklogic.client.io.InputSourceHandle
-
Creates a factory to create a InputSourceHandle instance for a SAX InputSource.
- newFactory() - Static method in class com.marklogic.client.io.InputStreamHandle
-
Creates a factory to create an InputStreamHandle instance for an input stream.
- newFactory(Class<?>...) - Static method in class com.marklogic.client.io.JacksonDatabindHandle
-
Creates a factory to create a JacksonDatabindHandle instance for POJO instances of the specified classes.
- newFactory(ObjectMapper, Class<?>...) - Static method in class com.marklogic.client.io.JacksonDatabindHandle
-
Creates a factory to create a JacksonDatabindHandle instance for POJO instances of the specified classes.
- newFactory() - Static method in class com.marklogic.client.io.JacksonHandle
-
Creates a factory to create a JacksonHandle instance for a JSON node.
- newFactory() - Static method in class com.marklogic.client.io.JacksonParserHandle
-
Creates a factory to create a JacksonParserHandle instance for a JsonParser.
- newFactory(Class<?>...) - Static method in class com.marklogic.client.io.JAXBHandle
-
Creates a factory to create a JAXBHandle instance for POJO instances of the specified classes.
- newFactory(JAXBContext, Class<?>...) - Static method in class com.marklogic.client.io.JAXBHandle
-
Creates a factory to create a JAXBHandle instance for POJO instances of the specified classes.
- newFactory() - Static method in class com.marklogic.client.io.ReaderHandle
-
Creates a factory to create a ReaderHandle instance for a Reader.
- newFactory() - Static method in class com.marklogic.client.io.SourceHandle
-
Creates a factory to create a SourceHandle instance for a Transformer Source.
- newFactory() - Static method in class com.marklogic.client.io.StringHandle
-
Creates a factory to create a StringHandle instance for a string.
- newFactory() - Static method in class com.marklogic.client.io.XMLEventReaderHandle
-
Creates a factory to create an XMLEventReaderHandle instance for a StAX event reader.
- newFactory() - Static method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Creates a factory to create an XMLStreamReaderHandle instance for a StAX stream reader.
- newGraphManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for CRUD operations on semantic graphs.
- newGraphPermissions() - Method in interface com.marklogic.client.semantics.GraphManager
-
Get an empty GraphPermissions instance.
- newHandle(Class<C>) - Method in interface com.marklogic.client.io.marker.ContentHandleFactory
-
Instantiates a handle for an IO class recognized by the factory.
- newJSONDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents containing a JSON structure.
- newLogger(OutputStream) - Method in interface com.marklogic.client.DatabaseClient
-
Creates a logger for document and query requests.
- newNamespacesManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting namespace bindings.
- newPatchBuilder(Format) - Method in interface com.marklogic.client.document.DocumentManager
-
For XMLDocumentManager or JSONDocumentManager, creates a builder for specifying changes to the document and metadata of a document.
- newPatchBuilder() - Method in interface com.marklogic.client.document.JSONDocumentManager
-
Creates a builder for specifying changes to the content and metadata of a JSON document.
- newPatchBuilder() - Method in interface com.marklogic.client.document.XMLDocumentManager
-
Creates a builder for specifying changes to the content and metadata of an XML document.
- newPlanBuilder() - Method in interface com.marklogic.client.row.RowManager
-
Creates a builder to define a plan for constructing and retrieving database rows.
- newPojoRepository(Class<T>, Class<ID>) - Method in interface com.marklogic.client.DatabaseClient
-
Creates a PojoRepository specific to the specified class and its id type.
- newQueryBatcher(StructuredQueryDefinition) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to retrieve uris that match this query.
- newQueryBatcher(RawStructuredQueryDefinition) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to retrieve uris that match this query.
- newQueryBatcher(StringQueryDefinition) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to retrieve uris that match this query.
- newQueryBatcher(RawCombinedQueryDefinition) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to retrieve uris that match this query.
- newQueryBatcher(Iterator<String>) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to retrieve uris from this Iterator.
- newQueryDefinition() - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Instantiate a new SPARQLQueryDefinition.
- newQueryDefinition(String) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Instantiate a new SPARQLQueryDefinition with provided SPARQL.
- newQueryDefinition(TextWriteHandle) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Instantiate a new SPARQLQueryDefinition with the SPARQL from the provided TextWriteHandle.
- newQueryManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager to query for database documents.
- newQueryOptionsManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting query options.
- newRawCombinedQueryDefinition(StructureWriteHandle) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation.
- newRawCombinedQueryDefinition(StructureWriteHandle, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation.
- newRawCombinedQueryDefinitionAs(Format, Object) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation provided as an object of an IO class.
- newRawCombinedQueryDefinitionAs(Format, Object, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML representation provided as an object of an IO class.
- newRawPlanDefinition(JSONWriteHandle) - Method in interface com.marklogic.client.row.RowManager
-
Defines a plan from a JSON serialization of the plan AST (Abstract Syntax Tree).
- newRawQueryByExampleDefinition(StructureWriteHandle) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation.
- newRawQueryByExampleDefinition(StructureWriteHandle, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation.
- newRawQueryByExampleDefinitionAs(Format, Object) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.
- newRawQueryByExampleDefinitionAs(Format, Object, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or XML representation provided as an object of an IO class.
- newRawStructuredQueryDefinition(StructureWriteHandle) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation.
- newRawStructuredQueryDefinition(StructureWriteHandle, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation.
- newRawStructuredQueryDefinitionAs(Format, Object) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation provided as an object of an IO class.
- newRawStructuredQueryDefinitionAs(Format, Object, String) - Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML representation provided as an object of an IO class.
- newResourceExtensionsManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting resource service extensions.
- newRowManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager to retrieve rows from the database.
- newRuleManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for building rules and rules-matching applications.
- newServerConfigManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for configuring the REST server for the database.
- newServerEval() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a ServerEvaluationCall for eval and invoke of server-side xquery or javascript code.
- newSPARQLQueryManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for executing SPARQL queries and retrieving results.
- newStringDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a string and the default query options.
- newStringDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a string and on named query options saved previously.
- newStructuredQueryBuilder() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a structure that identifies clauses and conjunctions and the default query options.
- newStructuredQueryBuilder(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a structure and on named query options saved previously.
- newSuggestDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a single string for completion, using the default options node.
- newSuggestDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a query options name.
- newSuggestDefinition(String, String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a single string for completion, using the default options node.
- newTextDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents containing unstructured text.
- newTransformExtensionsManager() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing, and deleting transform extensions.
- newValuesDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving values based on a named constraint on an index and the default query options.
- newValuesDefinition(String, String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving values based on a named constraint and on named query options saved previously.
- newValuesListDefinition() - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving the list of available named lexicon configurations from the default query options.
- newValuesListDefinition(String) - Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving the list of available named lexicon configurations from the named query options.
- newWriteBatcher() - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new WriteBatcher instance.
- newWriteSet() - Method in interface com.marklogic.client.document.DocumentManager
-
- newXMLDocumentManager() - Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents containing XML.
- next() - Method in interface com.marklogic.client.eval.EvalResultIterator
-
- next() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- next() - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- next(R) - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- next() - Method in interface com.marklogic.client.Page
-
Returns the next element in the internal iterator, which is separate from any new iterator created by calls to iterator().
- next() - Method in interface com.marklogic.client.query.ExtractedResult
-
Returns the next element in the internal iterator, which is separate from any new iterator created by calls to iterator().
- nextContent(T) - Method in interface com.marklogic.client.document.DocumentPage
-
Convenience method combines the functionality of Page.next() and DocumentRecord.getContent().
- nilled(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Summary: Returns an xs:boolean indicating whether the argument node is “nilled”.
- NMTOKEN(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:NMTOKEN server data type.
- NMTOKENSeq(XsNMTOKENExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNMTOKENExpr items.
- NO_CONTENT - Static variable in interface com.marklogic.client.util.RequestLogger
-
Indicates that no content is copied to the log (the default).
- nodeCollections(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns any collections for the node’s document in the database.
- NodeExpr - Interface in com.marklogic.client.type
-
An instance of a node expression.
- nodeKind(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an xs:string representing the node’s kind: either “document”, “element”, “attribute”, “text”, “namespace”, “processing-instruction”, “binary”, or “comment”.
- nodeMetadata(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the metadata value of a given node.
- nodeMetadataValue(NodeExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the metadata value of a node for a particular key.
- nodeMetadataValue(NodeExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the metadata value of a node for a particular key.
- nodeName(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an expanded-QName for node kinds that can have names.
- nodePermissions(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the permissions to a node’s document.
- nodePermissions(NodeExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the permissions to a node’s document.
- nodePermissions(NodeExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the permissions to a node’s document.
- NodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of node expressions.
- nodeUri(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the document-uri property of the parameter or its ancestor.
- nonNegativeInteger(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:nonNegativeInteger server data type.
- nonNegativeIntegerSeq(XsNonNegativeIntegerExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNonNegativeIntegerExpr items.
- nonPositiveInteger(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:nonPositiveInteger server data type.
- nonPositiveIntegerSeq(XsNonPositiveIntegerExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNonPositiveIntegerExpr items.
- normalizedString(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:normalizedString server data type.
- normalizedStringSeq(XsNormalizedStringExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNormalizedStringExpr items.
- normalizeSpace(XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the specified string with normalized whitespace, which strips off any leading or trailing whitespace and replaces any other sequences of more than one whitespace characters with a single space character (#x20).
- normalizeUnicode(XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Return the argument normalized according to the normalization criteria for a normalization form identified by the value of normalizationForm.
- normalizeUnicode(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Return the argument normalized according to the normalization criteria for a normalization form identified by the value of normalizationForm.
- normalizeUnicode(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Return the argument normalized according to the normalization criteria for a normalization form identified by the value of normalizationForm.
- not(ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the effective boolean value is false, and false if the effective boolean value is true.
- not(XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if neither of the specified boolean expressions return true.
- not(StructuredQueryDefinition) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- not(StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NOT query for a query definition.
- not64(XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
NOT a 64-bit integer value.
- notIn(StructuredQueryDefinition, StructuredQueryDefinition) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- notIn(StructuredQueryDefinition, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a not-in query for the positive and negative query definitions.
- notInQuery(CtsQueryExpr, CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching the first subquery, where those matches do not occur within 0 distance of the other query.
- notQuery(CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the matches not specified by its sub-query.
- NQUADS - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- NTRIPLES - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- NullNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON null node expression.
- NullNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON null node expressions.
- number(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value indicated by arg or, if arg is not specified, the context item after atomization, converted to an xs:double.
- NumberNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON number node expression.
- NumberNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON number node expressions.
- numeric(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:numeric server data type.
- numericSeq(XsNumericExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsNumericExpr items.
- Page<T> - Interface in com.marklogic.client
-
A generic interface for pagination through large sets of items of type <T>.
- param(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
- param(XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
- parseDateTime(XsStringExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, String, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseDateTime(XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseFailedRequest(int, InputStream) - Method in class com.marklogic.client.io.JSONErrorParser
-
- parseYymmdd(XsStringExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, String, String, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- parseYymmdd(XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
- patch(String, String, DocumentPatchHandle) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Modifies the content of a temporal JSON or XML document in the temporal collection.
- patch(String, String, DocumentPatchHandle, Transaction) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Modifies the content of a temporal JSON or XML document in the temporal collection.
- patch(String, String, String, String, DocumentPatchHandle) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Patches a temporal document by taking the content from the sourceDocumentURI present in the temporalDocumentURI collection with the patch handle and creates a new version identified by the uri in the temporalCollection.
- patch(String, String, String, String, DocumentPatchHandle, Transaction) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Patches a temporal document by taking the content from the sourceDocumentURI present in the temporalDocumentURI collection with the patch handle and creates a new version identified by the uri in the temporalCollection.
- patch(String, DocumentPatchHandle) - Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document within an open database transaction on the server.
- patch(String, DocumentPatchHandle, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document within an open database transaction on the server.
- patch(DocumentDescriptor, DocumentPatchHandle) - Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document.
- patch(DocumentDescriptor, DocumentPatchHandle, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document within an open database transaction on the server.
- patchAs(String, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document within an open database transaction on the server.
- path(NodeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string whose value corresponds to the path of the node.
- path(NodeExpr, boolean) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string whose value corresponds to the path of the node.
- path(NodeExpr, XsBooleanExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string whose value corresponds to the path of the node.
- pathGeospatialQuery(String, CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(XsStringSeqVal, CtsRegionSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(String, CtsRegionSeqExpr, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(String, CtsRegionSeqExpr, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(XsStringSeqVal, CtsRegionSeqExpr, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
- pathIndex(String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path index to match with a query.
- PathIndexProperty - Annotation Type in com.marklogic.client.pojo.annotation
-
Use this annotation to specify that a Path Index (required for range queries) is needed for this pojo property.
- PathIndexProperty.ScalarType - Enum in com.marklogic.client.pojo.annotation
-
- pathLanguage(DocumentPatchBuilder.PathLanguage) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies the language for this patch to use
- pathRangeQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
- pathRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
- pathRangeQuery(String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
- pathRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
- pathRangeQuery(String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
- pathRangeQuery(XsStringSeqVal, XsStringVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
- pathReference(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
- pathReference(XsStringVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
- pathReference(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
- pathReference(XsStringVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
- pathReference(String, String, MapMapExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
- pathReference(XsStringVal, XsStringSeqVal, MapMapExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
- pattern(PlanTriplePositionSeq, PlanTriplePositionSeq, PlanTriplePositionSeq) - Method in class com.marklogic.client.expression.PlanBuilder
-
- pattern(PlanTriplePositionSeq, PlanTriplePositionSeq, PlanTriplePositionSeq, PlanSystemColumnSeq) - Method in class com.marklogic.client.expression.PlanBuilder
-
- patternSeq(PlanTriplePattern...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- percentile(XsDoubleSeqExpr, double) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns a sequence of percentile(s) given a sequence of percentage(s).
- percentile(XsDoubleSeqExpr, XsDoubleSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns a sequence of percentile(s) given a sequence of percentage(s).
- percentRank(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a percentage of the data set.
- percentRank(XsAnyAtomicTypeSeqExpr, XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a percentage of the data set.
- percentRank(XsAnyAtomicTypeSeqExpr, String, String) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a percentage of the data set.
- percentRank(XsAnyAtomicTypeSeqExpr, XsAnyAtomicTypeExpr, XsStringSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a percentage of the data set.
- period(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a period value, for use as a parameter to cts:period-range-query or cts:period-compare-query.
- period(XsDateTimeVal, XsDateTimeVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a period value, for use as a parameter to cts:period-range-query or cts:period-compare-query.
- period(Calendar, Calendar) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- period(String, String) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- PERIOD_CP - Static variable in class com.marklogic.client.example.extension.NameConverter
-
- periodCompareQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have relevant pair of period values.
- periodCompareQuery(XsStringVal, XsStringVal, XsStringVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have relevant pair of period values.
- periodCompareQuery(String, String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have relevant pair of period values.
- periodCompareQuery(XsStringVal, XsStringVal, XsStringVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have relevant pair of period values.
- periodRangeQuery(String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a period value with an operator.
- periodRangeQuery(XsStringSeqVal, XsStringVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a period value with an operator.
- periodRangeQuery(String, String, CtsPeriodExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a period value with an operator.
- periodRangeQuery(XsStringSeqVal, XsStringVal, CtsPeriodSeqExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a period value with an operator.
- periodRangeQuery(String, String, CtsPeriodSeqExpr, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a period value with an operator.
- periodRangeQuery(XsStringSeqVal, XsStringVal, CtsPeriodSeqExpr, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a period value with an operator.
- periodSeq(CtsPeriodExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsPeriodExpr items.
- Permission() - Constructor for class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
- permission(String, Capability...) - Method in interface com.marklogic.client.semantics.GraphManager
-
Create a GraphPermissions builder object with the specified role and capabilities.
- permission(String, Capability...) - Method in interface com.marklogic.client.semantics.GraphPermissions
-
Add the specified role and capabilities to this GraphPermissions object.
- permission(String, Capability...) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
For use with SPARQL update, where specified permissions will apply
to any records created by the update.
- pi() - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the value of pi.
- PlanAggregateCol - Interface in com.marklogic.client.type
-
An instance of a column populated by an aggregate expression in a row pipeline.
- PlanAggregateColSeq - Interface in com.marklogic.client.type
-
A sequence of columns populated by an aggregate expressions in a row pipeline.
- PlanBuilder - Class in com.marklogic.client.expression
-
Builds the plan for a row pipeline to execute on the server.
- PlanBuilder.AccessPlan - Interface in com.marklogic.client.expression
-
Provides functions and operations in the access phase of the plan for executing a row pipeline on the server.
- PlanBuilder.ExportablePlan - Interface in com.marklogic.client.expression
-
Provides functions and operations in the exportable phase of the plan for executing a row pipeline on the server.
- PlanBuilder.ModifyPlan - Interface in com.marklogic.client.expression
-
Provides functions and operations in the modify phase of the plan for executing a row pipeline on the server.
- PlanBuilder.Plan - Interface in com.marklogic.client.expression
-
Provides functions and operations in the final phase of the plan for executing a row pipeline on the server.
- PlanBuilder.PreparePlan - Interface in com.marklogic.client.expression
-
Provides functions and operations in the prepare phase of the plan for executing a row pipeline on the server.
- PlanCase - Interface in com.marklogic.client.type
-
An instance of a when or else argument to a case expression in a row pipeline.
- PlanCaseSeq - Interface in com.marklogic.client.type
-
A sequence of when arguments to a case expression in a row pipeline.
- PlanColumn - Interface in com.marklogic.client.type
-
An instance of a column expression returned by a col() call in a row pipeline.
- PlanColumnSeq - Interface in com.marklogic.client.type
-
A sequence of column expressions returned by col() calls for a row pipeline.
- PlanExprCol - Interface in com.marklogic.client.type
-
An instance of a column expression returned by an as() or col() call in a row pipeline.
- PlanExprColSeq - Interface in com.marklogic.client.type
-
A sequence of column expressions returned by as() or col() calls in a row pipeline.
- PlanFunction - Interface in com.marklogic.client.type
-
An instance of a function used for map() or reduce() post-processing of a row pipeline on the server.
- PlanFunctionSeq - Interface in com.marklogic.client.type
-
A sequence of functions used for map() or reduce() post-processing of a row pipeline on the server.
- PlanGroupConcatOption - Interface in com.marklogic.client.type
-
An instance of a PlanValueOption or separator string for a group concat aggregate expression in a row pipeline.
- PlanGroupConcatOptionSeq - Interface in com.marklogic.client.type
-
A sequence of PlanValueOption or separator strings for a group concat aggregate expression in a row pipeline.
- PlanJoinKey - Interface in com.marklogic.client.type
-
An instance of a join key equivalence expression returned by an on() call in a row pipeline.
- PlanJoinKeySeq - Interface in com.marklogic.client.type
-
A sequence of join key equivalence expressions returned by on() calls in a row pipeline.
- PlanJsonProperty - Interface in com.marklogic.client.type
-
An instance of a JSON property returned by a prop() call or passed as an argument to a jsonObject() call in a row pipeline.
- PlanJsonPropertySeq - Interface in com.marklogic.client.type
-
A sequence of JSON properties returned by prop() calls or passed as an argument to a jsonObject() call in a row pipeline.
- PlanParamBindingSeqVal - Interface in com.marklogic.client.type
-
A sequence of literal values to pass as arguments to bind() calls to assign to placeholder parameters for a row pipeline.
- PlanParamBindingVal - Interface in com.marklogic.client.type
-
An instance of a literal value passed as an argument to a bind() call to assign to a placeholder parameter for a row pipeline.
- PlanParamExpr - Interface in com.marklogic.client.type
-
An instance of a placeholder parameter returned by a call to the param() function that can represent a literal value in expressions and can be passed on a bind() call to be assigned a literal value when invoking a row pipeline.
- PlanParamSeqExpr - Interface in com.marklogic.client.type
-
A sequence of placeholder parameters returned by calls to param() functions that can represent literal values in expressions and can be passed on bind() calls to be assigned literal values when invoking a row pipeline.
- PlanPrefixer - Interface in com.marklogic.client.type
-
An instance of a convenience that can prepend a base URL when creating iteral semantic IRI values for use in triple patterns for a row pipeline.
- PlanPrefixerSeq - Interface in com.marklogic.client.type
-
A sequence of conveniences that can prepend a base URL when creating iteral semantic IRI values for use in triple patterns for a row pipeline.
- PlanSortKey - Interface in com.marklogic.client.type
-
An instance of a column - potentially with a sort direction specified by an asc() or desc() call - for an orderBy() operation in a row pipeline.
- PlanSortKeySeq - Interface in com.marklogic.client.type
-
A sequence of columns - potentially with a sort direction specified by an asc() or desc() call - for an orderBy() operation in a row pipeline.
- PlanSystemColumn - Interface in com.marklogic.client.type
-
An instance of a fragment id, graph id, or other system column for a row pipeline.
- PlanSystemColumnSeq - Interface in com.marklogic.client.type
-
A sequence of fragment id, graph id, or other system columns for a row pipeline.
- PlanTripleOption - Enum in com.marklogic.client.type
-
An option controlling whether to check for duplicate triples (which is more expensive) or to process all triples when reading triples for a row pipeline.
- PlanTriplePattern - Interface in com.marklogic.client.type
-
An instance of a pattern for projecting rows from triples in a row pipeline.
- PlanTriplePatternSeq - Interface in com.marklogic.client.type
-
A sequence of patterns for projecting rows from triples in a row pipeline.
- PlanTriplePosition - Interface in com.marklogic.client.type
-
An instance of a literal value or column for a position within a pattern for projecting rows from triples in a row pipeline.
- PlanTriplePositionSeq - Interface in com.marklogic.client.type
-
A sequence of literal values or columns for positions within patterns for projecting rows from triples in a row pipeline.
- PlanValueOption - Enum in com.marklogic.client.type
-
An option controlling whether to calculate over all values including duplicates or over distinct values for an aggregate expression in a row pipeline.
- PlanValueOptionSeq - Interface in com.marklogic.client.type
-
A sequence of options controlling whether to calculate over all values including duplicates or over distinct values for aggregate expressions in a row pipeline.
- point(double, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a point value.
- point(XsDoubleVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a point value.
- point(double, double) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- point(double, double) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial point.
- pointSeq(CtsPointExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsPointExpr items.
- PojoPage<T> - Interface in com.marklogic.client.pojo
-
Enables pagination over objects retrieved from the server and deserialized by PojoRepository read and search methods.
- PojoQueryBuilder<T> - Interface in com.marklogic.client.pojo
-
Specific to pojos yet similar to StructuredQueryBuilder, this class generates structured queries.
- PojoQueryBuilder.Operator - Enum in com.marklogic.client.pojo
-
- PojoQueryDefinition - Interface in com.marklogic.client.pojo
-
- PojoRepository<T,ID extends Serializable> - Interface in com.marklogic.client.pojo
-
PojoRepository is the central class for the Pojo Facade.
- polygon(XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial polygon value.
- polygon(StructuredQueryBuilder.Point...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- polygon(StructuredQueryBuilder.Point...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as an arbitrary polygon.
- polygonSeq(CtsPolygonExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsPolygonExpr items.
- port - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- position(XsStringExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the starting position of a string within the search string.
- position(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the starting position of a string within the search string.
- position(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the starting position of a string within the search string.
- position(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the starting position of a string within the search string.
- positiveInteger(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:positiveInteger server data type.
- positiveIntegerSeq(XsPositiveIntegerExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsPositiveIntegerExpr items.
- post(RequestParameters, AbstractWriteHandle, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, AbstractWriteHandle, Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, W[], R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, W[], Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, AbstractWriteHandle, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST service.
- post(RequestParameters, AbstractWriteHandle, Transaction, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST service.
- post(RequestParameters, W[], String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST service.
- post(RequestParameters, W[], Transaction, String...) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST service.
- pow(XsDoubleExpr, double) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns x^y.
- pow(XsDoubleExpr, XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns x^y.
- predicateSeq(PlanTriplePosition...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- prefixer(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function factory returns a new function that takes a name parameter and returns a
sem:iri, prepending the specified base URI onto the name.
- prefixer(XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function factory returns a new function that takes a name parameter and returns a
sem:iri, prepending the specified base URI onto the name.
- prefixFromQName(XsQNameExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:NCName representing the prefix of arg.
- prepare(int) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method prepares the specified plan for execution as an optional final step before execution.
- prepare(XsIntVal) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method prepares the specified plan for execution as an optional final step before execution.
- process(ContentHandler) - Method in class com.marklogic.client.io.InputSourceHandle
-
Reads the input source, sending SAX events to the supplied content handler.
- processAndContinue(Document) - Method in interface com.marklogic.client.example.extension.OpenCSVBatcher.BatchProcessor
-
- processAndContinue(Document) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher.BatchSplitter
-
- processEvent(QueryBatch) - Method in class com.marklogic.client.datamovement.ApplyTransformListener
-
The standard BatchListener action called by QueryBatcher.
- processEvent(T) - Method in interface com.marklogic.client.datamovement.BatchListener
-
The method called by QueryBatcher or WriteBatcher to run your custom code on this batch.
- processEvent(QueryBatch) - Method in class com.marklogic.client.datamovement.DeleteListener
-
The standard BatchListener action called by QueryBatcher.
- processEvent(QueryBatch) - Method in class com.marklogic.client.datamovement.ExportListener
-
This is the method QueryBatcher calls for ExportListener to do its thing.
- processEvent(QueryBatch) - Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
- processEvent(QueryBatch) - Method in interface com.marklogic.client.datamovement.QueryBatchListener
-
The method called by QueryBatcher or WriteBatcher to run your custom code on this batch.
- processEvent(QueryBatch) - Method in class com.marklogic.client.datamovement.UrisToWriterListener
-
- processEvent(WriteBatch) - Method in interface com.marklogic.client.datamovement.WriteBatchListener
-
The method called by WriteBatcher to run your custom code on this batch.
- processFailure(T, Throwable) - Method in interface com.marklogic.client.datamovement.BatchFailureListener
-
The method called when a failure occurs.
- processFailure(T) - Method in interface com.marklogic.client.datamovement.FailureListener
-
- processFailure(WriteBatch, Throwable) - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
This implements the WriteFailureListener interface
- processFailure(QueryBatchException) - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
This implements the QueryFailureListener interface
- processFailure(QueryBatchException) - Method in interface com.marklogic.client.datamovement.QueryFailureListener
-
- processFailure(WriteBatch, Throwable) - Method in interface com.marklogic.client.datamovement.WriteFailureListener
-
- ProcessingInstructionNodeExpr - Interface in com.marklogic.client.type
-
An instance of an XML processing instruction node expression.
- ProcessingInstructionNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of XML processing instruction node expressions.
- Product() - Constructor for class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- ProductDetails() - Constructor for class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- prop(String, JsonContentNodeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the key expression and value content for a JSON property of a JSON object contructed by the
op:json-object function.
- prop(XsStringExpr, JsonContentNodeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the key expression and value content for a JSON property of a JSON object contructed by the
op:json-object function.
- properties(StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the properties of documents (as opposed to the content of documents).
- propertiesConstraint(String, StructuredQueryDefinition) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the properties of documents (as opposed to the content of documents) with the specified constraint.
- propertiesFragmentQuery(CtsQueryExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches all documents where query matches document-properties.
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete till the expiryTime provided
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete for the specified duration.
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration, Transaction) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete for the specified duration.
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar, Transaction) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete till the expiryTime provided
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration, String, Transaction) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar, String, Transaction) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
- put(RequestParameters, AbstractWriteHandle, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes content by calling a PUT service.
- put(RequestParameters, AbstractWriteHandle, Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes content by calling a PUT service.
- put(RequestParameters, W[], R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes multiple content by calling a PUT service.
- put(RequestParameters, W[], Transaction, R) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes multiple content by calling a PUT service.
- put(QName, BigDecimal) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a BigDecimal value.
- put(QName, BigInteger) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a BigInteger value.
- put(QName, Boolean) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a boolean value.
- put(QName, Byte) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a byte value.
- put(QName, byte[]) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a byte array value.
- put(QName, Calendar) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a Calendar value, which can express a date, a time, or a datetime.
- put(QName, Double) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a double value.
- put(QName, Duration) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a Duration value, which can also express a year-month or day-millisecond duration.
- put(QName, Float) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a float value.
- put(QName, Integer) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to an int value.
- put(QName, Long) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a long value.
- put(QName, NodeList) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a NodeList value, which can accommodate subelements or mixed content.
- put(QName, Short) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a short value.
- put(QName, String) - Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a string value.
- put(String, String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Adds a namespace binding between a prefix and a URI.
- put(String, V) - Method in interface com.marklogic.client.util.NameMap
-
Specifies the value of the string name.
- put(String, String) - Method in class com.marklogic.client.util.RequestParameters
-
Set a parameter to a single value.
- put(String, String...) - Method in class com.marklogic.client.util.RequestParameters
-
Sets a parameter to a list of values.
- put(String, List<String>) - Method in class com.marklogic.client.util.RequestParameters
-
Sets the values of a parameter name, returning the previous values if any.
- putAll(Map<? extends String, ? extends String>) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Adds all namespace bindings from a map.
- putAll(Map<? extends String, ? extends List<String>>) - Method in class com.marklogic.client.util.RequestParameters
-
Adds existing parameter names and values.
- radians(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns numeric expression converted from degrees to radians.
- rand(XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Return a random number.
- random() - Method in interface com.marklogic.client.expression.SemExpr
-
Returns a random double between 0 and 1.
- random() - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a random unsigned integer between 0 and a number up to 64 bits long.
- random(XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a random unsigned integer between 0 and a number up to 64 bits long.
- range(String, PojoQueryBuilder.Operator, Object...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Query a Path Range Index configured in the database for a pojo property.
- range(String, String[], PojoQueryBuilder.Operator, Object...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Query a Path Range Index configured in the database for a pojo property.
- range(StructuredQueryBuilder.RangeIndex, String, StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String[], StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, String[], StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Operator, Object...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, field, or path whose value that has the correct datatyped comparison with one of the criteria values.
- RANGE - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- rangeConstraint(String, StructuredQueryBuilder.Operator, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint whose value that has the correct datatyped comparison with one of the criteria values.
- rangeOptions(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Converts the list of options used for a range query to an array as a convenience.
- rank(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- rank(XsAnyAtomicTypeSeqExpr, XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- rank(XsAnyAtomicTypeSeqExpr, String, String) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- rank(XsAnyAtomicTypeSeqExpr, XsAnyAtomicTypeExpr, XsStringSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- RAW - Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to “raw”
- RawClientAlert - Class in com.marklogic.client.example.cookbook
-
RawClientAlert illustrates defining and finding rules that match documents.
- RawClientAlert() - Constructor for class com.marklogic.client.example.cookbook.RawClientAlert
-
- RawCombinedQueryDefinition - Interface in com.marklogic.client.query
-
A RawCombinedQueryDefinition provides access to a combined query in a JSON or XML representation.
- RawCombinedSearch - Class in com.marklogic.client.example.cookbook
-
RawCombinedSearch illustrates searching for documents and iterating over results by passing structured criteria and query options in a single request.
- RawCombinedSearch() - Constructor for class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- RAWDOUBLE - Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to “raw/double”
- RawPlanDefinition - Interface in com.marklogic.client.row
-
A Raw Plan Definition provides access to a plan in a JSON serialization of the exported AST (Abstract Syntax Tree) for the plan.
- RawQueryByExampleDefinition - Interface in com.marklogic.client.query
-
A RawQueryByExampleDefinition provides access to a simple query by example in an JSON or XML representation.
- RawQueryDefinition - Interface in com.marklogic.client.query
-
A RawQueryDefinition provides access to a query in a JSON or XML representation.
- RawStructuredQueryDefinition - Interface in com.marklogic.client.query
-
A RawStructuredQueryDefinition provides access to a structured query in a JSON or XML representation.
- rdf - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with rdf server functions.
- RdfExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the rdf server library for a row pipeline and constructs client values with rdf.* server types.
- RDFJSON - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- RdfLangStringExpr - Interface in com.marklogic.client.type
-
An instance of an RDF language string expression.
- RdfLangStringSeqExpr - Interface in com.marklogic.client.type
-
A sequence of RDF language string expressions.
- RdfLangStringSeqVal - Interface in com.marklogic.client.type
-
An instance of an RDF language string value.
- RdfLangStringVal - Interface in com.marklogic.client.type
-
A sequence of RDF language string values.
- RDFMimeTypes - Class in com.marklogic.client.semantics
-
- RDFMimeTypes() - Constructor for class com.marklogic.client.semantics.RDFMimeTypes
-
- RDFS - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFS_FULL - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFS_PLUS - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFS_PLUS_FULL - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFTypes - Enum in com.marklogic.client.semantics
-
- RdfValue - Interface in com.marklogic.client.expression
-
RdfValue takes Java values and constructs atomic values and sequences of atomic values with an rdf data type
- RDFXML - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- read(ExtensionLibraryDescriptor, Class<T>) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset as an object of an IO class.
- read(String, T) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset into a handle.
- read(ExtensionLibraryDescriptor, T) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset into a handle.
- read(String, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation provided by the handle
- read(String, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document as transformed on the server.
- read(DocumentDescriptor, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation provided by the handle
- read(DocumentDescriptor, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles
- read(String, DocumentMetadataReadHandle, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document in the representations provided by the handles
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
- read(String, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
- read(String, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(DocumentDescriptor, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
- read(DocumentDescriptor, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
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
- read(String, DocumentMetadataReadHandle, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
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
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, long, long, Transaction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
- read(String, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representation provided by the handle
- read(String, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database as transformed on the server.
- read(DocumentDescriptor, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representations provided by the handles
- read(DocumentDescriptor, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database as transformed on the server.
- read(String, DocumentMetadataReadHandle, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representations provided by the handles
- read(String, DocumentMetadataReadHandle, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representations provided by the handles
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database as transformed on the server.
- read(String, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction in the representation provided by the handle
- read(String, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction as transformed on the server.
- read(DocumentDescriptor, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction in the representation provided by the handle
- read(DocumentDescriptor, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database transaction as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction in the representations provided by the handles
- read(String, DocumentMetadataReadHandle, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction in the representations provided by the handles
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an open database transaction as transformed on the server.
- read(String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents matching the provided uris.
- read(ServerTransform, String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents matching the provided uris.
- read(Transaction, String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents matching the provided uris.
- read(ServerTransform, Transaction, String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents matching the provided uris.
- read(ID) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Read one persisted pojo by id and unmarshall its data into a new pojo instance.
- read(ID, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, read one persisted pojo by id and unmarshall its data into a new pojo instance.
- read(ID[]) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Read multiple persisted pojos by id and unmarshall their data into new pojo instances.
- read(ID[], Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, read multiple persisted pojos and unmarshall their data into new pojo instances.
- read(String, T) - Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server.
- read(String, T, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server.
- readAll() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Reads all of the namespace bindings from the server.
- readAll(long) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Read one page of persisted pojos of the type managed by this PojoRepository and unmarshall their data into new pojo instances.
- readAll(long, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, read one page of persisted pojos of the type managed by this PojoRepository and unmarshall their data into new pojo instances.
- readAs(String, Class<T>) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset as an object of an IO class.
- readAs(String, Class<T>, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>, long, long) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a binary database document in the representation specified by the IO class.
- readAs(String, Class<T>) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representation specified by the IO class.
- readAs(String, Class<T>, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the database in the representation specified by the IO class.
- readAs(String, Class<T>) - Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server as the specified type.
- readAs(String, Class<T>, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server as the specified type.
- readBulkPOJOS() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- readConfiguration() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Reads the values of the properties from the server into this object.
- readDocument(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- ReaderHandle - Class in com.marklogic.client.io
-
A Reader Handle represents a character content as a reader
for reading to or writing from the database.
- ReaderHandle() - Constructor for class com.marklogic.client.io.ReaderHandle
-
Zero-argument constructor.
- ReaderHandle(Reader) - Constructor for class com.marklogic.client.io.ReaderHandle
-
Initializes the handle with a character reader for the content.
- readerPassword - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- readerUser - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- readForestConfig() - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Update the ForestConfiguration with the latest from the server.
- readJavascriptTransform(String, T) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in Javascript.
- readJavascriptTransformAs(String, Class<T>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in Javascript in a textual representation provided as an object of an IO class.
- readMetadata(String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database the metadata for a list of documents matching the provided uris.
- readMetadata(Transaction, String...) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database the metadata for a list of documents matching the provided uris.
- readMetadata(String, T) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata from the database in the representation provided by the handle
- readMetadata(String, T, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata from an open database transaction in the representation provided by the handle
- readOptions(String, T) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Fetch a query options configuration from the REST Server by name.
- readOptionsAs(String, Format, Class<T>) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Fetch a query options configuration from the REST Server by name.
- readPOJOsWithExportListener() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- readPrefix(String) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Returns the namespace URI bound to the specified prefix on the server.
- readRule(String, T) - Method in interface com.marklogic.client.alerting.RuleManager
-
Reads a rule from the server into the provided handle.
- readRuleAs(String, Class<T>) - Method in interface com.marklogic.client.alerting.RuleManager
-
Reads a rule from the server in an XML representation provided as an object of an IO class.
- readServices(String, T) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services for a resource.
- readServicesAs(String, Class<T>) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services for a resource in a textual representation provided as an object of an IO class.
- readStatus(T) - Method in interface com.marklogic.client.Transaction
-
Reads the status for the transaction including whether the transaction has timed out.
- readXQueryTransform(String, T) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XQuery.
- readXQueryTransformAs(String, Class<T>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XQuery in a textual representation provided as an object of an IO class.
- readXSLTransform(String, T) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XSLT.
- readXSLTransformAs(String, Class<T>) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in XSLT in an XML representation provided as an object of an IO class.
- reduce(PlanFunction) - Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
- reduce(PlanFunction, String) - Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
- reduce(PlanFunction, XsAnyAtomicTypeVal) - Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
- referenceSeq(CtsReferenceExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsReferenceExpr items.
- regionSeq(CtsRegionExpr...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsRegionExpr items.
- register(ContentHandleFactory) - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Associates a factory for content handles with the classes for IO representations known to the factory.
- register(ContentHandleFactory, Class<?>...) - Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Associates a factory for content handles with the specified classes for IO representations.
- register(Class<?>...) - Static method in class com.marklogic.client.example.cookbook.datamovement.DatabaseClientSingleton
-
- registerDefaultHandles() - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Initializes a handle registry with the default associations between the content handles provided by the API and the supported IO representation classes.
- registerDefaultHandles() - Static method in class com.marklogic.client.DatabaseClientFactory
-
Initializes a handle registry with the default associations between the content handles provided by the API and the supported IO representation classes.
- release() - Method in interface com.marklogic.client.DatabaseClient
-
Closes the database client and releases associated resources.
- release() - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Calls release() on all host-specific DatabaseClient instances (but not on the DatabaseClient instance used to create this DataMovementManager instance).
- remove() - Method in class com.marklogic.client.example.extension.BatchManager.BatchResponse
-
- remove() - Method in class com.marklogic.client.example.extension.SearchCollector.CollectorResults
-
- remove(ItemSeqExpr, long) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a new sequence constructed from the value of target with the item at the position specified by the value of position removed.
- remove(ItemSeqExpr, XsIntegerExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a new sequence constructed from the value of target with the item at the position specified by the value of position removed.
- remove(Object) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Removes the namespace binding for a prefix.
- remove(String) - Method in interface com.marklogic.client.util.NameMap
-
Removes the key-value pair from the map.
- remove(Object) - Method in class com.marklogic.client.util.RequestParameters
-
Removes a parameter name, returning its values if any.
- repeat(ItemSeqExpr, double) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that concatenates the first argument as many times as specified by the second argument.
- repeat(ItemSeqExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that concatenates the first argument as many times as specified by the second argument.
- replace(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
- replace(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
- replace(XsStringExpr, String, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
- replace(XsStringExpr, XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
- replaceApply(String, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a replacement operation by applying a function to an existing JSON or XML fragment.
- replaceApply(String, DocumentMetadataPatchBuilder.Cardinality, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a replacement operation by applying a function to an existing JSON or XML fragment.
- replaceCollection(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the specified collection.
- replaceFragment(String, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment.
- replaceFragment(String, DocumentMetadataPatchBuilder.Cardinality, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment.
- replaceGraphs(QuadsWriteHandle) - Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert quads from the handle
to the graphs specified in the quads data.
- replaceGraphs(QuadsWriteHandle, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert quads from the handle
to the graphs specified in the quads data.
- replaceGraphsAs(Object) - Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert quads from the quadsData
to the graphs specified in the quads data.
- replaceGraphsAs(Object, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert quads from the quadsData
to the graphs specified in the quads data.
- replaceInsertFragment(String, String, DocumentPatchBuilder.Position, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment or (if the existing fragment doesn’t exist) to insert relative to a different existing JSON or XML fragment.
- replaceInsertFragment(String, String, DocumentPatchBuilder.Position, DocumentMetadataPatchBuilder.Cardinality, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON or XML fragment or (if the existing fragment doesn’t exist) to insert relative to a different existing JSON or XML fragment.
- replaceMetadataValue(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing metadata-value
- replaceMetadataValueApply(String, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a function to the metadata-value.
- replacePermission(String, DocumentMetadataHandle.Capability...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing capabilities of a role.
- replacePermission(String, String, DocumentMetadataHandle.Capability...) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing role with a new role.
- replacePropertyApply(String, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a function to a metadata property having a simple name.
- replacePropertyApply(QName, DocumentMetadataPatchBuilder.Call) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a function to a metadata property having a namespaced name.
- replacePropertyValue(String, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing value of a metadata property having a simple name.
- replacePropertyValue(QName, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing value of a metadata property having a namespaced name.
- replacePropertyValue(String, String, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing metadata property with a new property having a simple name.
- replacePropertyValue(QName, QName, Object) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing metadata property with a new property having a namespaced name.
- replaceRegex(String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to modify an existing string with a regular expression
- replaceRegex(String, String, String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to modify an existing string with a regular expression
- replaceValue(String, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a value to replace the existing value of a JSON or XML node.
- replaceValue(String, DocumentMetadataPatchBuilder.Cardinality, Object) - Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a value to replace the existing value of a JSON or XML node.
- RequestConstants - Class in com.marklogic.client
-
The RequestConstants class provides constants for the common namespace prefixes and URIs used in the Java API (similar to the XML constants provided by the javax.xml.XMLConstants class).
- RequestConstants() - Constructor for class com.marklogic.client.RequestConstants
-
- RequestLogger - Interface in com.marklogic.client.util
-
Request Logger records the requests sent to the server.
- RequestParameters - Class in com.marklogic.client.util
-
RequestParameters supports a map with a string as the key and a list of strings as the value, which can represent parameters of an operation including parameters transported over HTTP.
- RequestParameters() - Constructor for class com.marklogic.client.util.RequestParameters
-
Zero-argument constructor.
- requireOptimisticLocking(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- resolveFunction(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
- resolveFunction(XsQNameVal, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
- resolveQName(XsStringExpr, ElementNodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:QName value (that is, an expanded QName) by taking an xs:string that has the lexical form of an xs:QName (a string in the form “prefix:local-name” or “local-name”) and resolving it using the in-scope namespaces for a given element.
- resolveUri(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Resolves a relative URI against an absolute URI.
- resolveUri(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Resolves a relative URI against an absolute URI.
- resolveUri(XsStringExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Resolves a relative URI against an absolute URI.
- resolveUri(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Resolves a relative URI against an absolute URI.
- ResourceExtension - Class in com.marklogic.client.example.cookbook
-
ResourceExtension installs an extension for managing spelling dictionary resources.
- ResourceExtension() - Constructor for class com.marklogic.client.example.cookbook.ResourceExtension
-
- ResourceExtension.DictionaryManager - Class in com.marklogic.client.example.cookbook
-
DictionaryManager provides an example of a class that implements a resource extension client, exposing a method for each service.
- ResourceExtensionsManager - Interface in com.marklogic.client.admin
-
A Resource Extensions Manager supports writing, reading, and deleting a Resource Services extension as well as listing the installed Resource Services extensions.
- ResourceExtensionsManager.MethodParameters - Class in com.marklogic.client.admin
-
Method Parameters declare the parameters accepted by the Resource Services extension.
- ResourceManager - Class in com.marklogic.client.extensions
-
ResourceManager is the base class for a client interface to resource services.
- ResourceNotFoundException - Exception in com.marklogic.client
-
Exception thrown when the server responds with HTTP status code 404.
- ResourceNotFoundException(String) - Constructor for exception com.marklogic.client.ResourceNotFoundException
-
- ResourceNotFoundException(String, FailedRequest) - Constructor for exception com.marklogic.client.ResourceNotFoundException
-
- ResourceNotResendableException - Exception in com.marklogic.client
-
Exception thrown when the server responds with HTTP status code 503 and a Retry-After header of 1 but the request is a PUT or POST and the payload is streaming.
- ResourceNotResendableException(String) - Constructor for exception com.marklogic.client.ResourceNotResendableException
-
- ResourceServices - Interface in com.marklogic.client.extensions
-
A ResourceServices object supports calling the services for a resource.
- ResourceServices.ServiceResult - Interface in com.marklogic.client.extensions
-
ServiceResult provides one content response from a service.
- ResourceServices.ServiceResultIterator - Interface in com.marklogic.client.extensions
-
ServiceResultIterator provides an iterator over content responses from the server.
- RESTAPI_NS - Static variable in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- RESTAPI_NS - Static variable in class com.marklogic.client.RequestConstants
-
The namespace URI for vocabularies implemented by the REST API.
- RESTAPI_PREFIX - Static variable in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- RESTAPI_PREFIX - Static variable in class com.marklogic.client.RequestConstants
-
The conventional namespace prefix for vocabularies implemented by the REST API.
- RESTServer(Properties) - Constructor for class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
Construct the REST server specification based on properties.
- RESTServer(String, String, String, String, int) - Constructor for class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
Construct the REST server specification programmatically.
- resultDoc(PlanBuilder.Plan, T) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a handle to get the set of rows as a single JSON or XML structure.
- resultDoc(PlanBuilder.Plan, T, Transaction) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a handle to get the set of rows as a single JSON or XML structure and reflecting documents written or deleted by an uncommitted transaction.
- resultDocAs(PlanBuilder.Plan, Class<T>) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan in the representation specified by the IO class.
- resultDocAs(PlanBuilder.Plan, Class<T>, Transaction) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan in the representation specified by the IO class and reflecting documents written or deleted by an uncommitted transaction.
- resultRows(PlanBuilder.Plan) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a map interface for the column values in each row.
- resultRows(PlanBuilder.Plan, Transaction) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a map interface and reflecting documents written or deleted by an uncommitted transaction.
- resultRows(PlanBuilder.Plan, T) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row.
- resultRows(PlanBuilder.Plan, T, Transaction) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.
- resultRowsAs(PlanBuilder.Plan, Class<T>) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.
- resultRowsAs(PlanBuilder.Plan, Class<T>, Transaction) - Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows based on a plan using a JSON or XML handle for each row and reflecting documents written or deleted by an uncommitted transaction.
- retry(QueryEvent) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Retry in the same thread to query a batch that failed.
- retry(WriteBatch) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Retry in the same thread to send a batch that failed.
- reverse(ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Reverses the order of items in a sequence.
- right(ItemSeqExpr, double) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that is the rightmost characters of the target string.
- right(ItemSeqExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that is the rightmost characters of the target string.
- rollback() - Method in interface com.marklogic.client.Transaction
-
Cancels the transaction, reverting the database to its state prior to the writes and deletes made in the transaction.
- romanize(XsStringExpr) - Method in interface com.marklogic.client.expression.SpellExpr
-
Returns the romanization of the string, substituting basic Latin letters for the letters in the string, according to their sound.
- root(NodeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the root of the tree to which arg belongs.
- round(XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number with no fractional part that is closest to the argument.
- roundHalfToEven(XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
- roundHalfToEven(XsNumericExpr, long) - Method in interface com.marklogic.client.expression.FnExpr
-
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
- roundHalfToEven(XsNumericExpr, XsIntegerExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
- RowManager - Interface in com.marklogic.client.row
-
A Row Manager provides database operations on rows projected from documents.
- RowManager.RowSetPart - Enum in com.marklogic.client.row
-
Distinguishes between the header and rows that constitute a row set.
- RowManager.RowStructure - Enum in com.marklogic.client.row
-
Distinguishes between rows in an object structure or array structure.
- RowRecord - Interface in com.marklogic.client.row
-
A Row Record provides an extended, read-only map interface to the column values in a row.
- RowRecord.ColumnKind - Enum in com.marklogic.client.row
-
Distinguishes an atomic value, a content structure such as a document or other node, and a null value.
- RowSet<T> - Interface in com.marklogic.client.row
-
A Row Set represents a set of rows produced by a plan and read from the database.
- rshift64(XsUnsignedLongExpr, long) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Right-shift a 64-bit integer value.
- rshift64(XsUnsignedLongExpr, XsLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Right-shift a 64-bit integer value.
- rtrim(XsStringExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Return a string that removes trailing empty spaces in the input string.
- RuleDefinition - Class in com.marklogic.client.alerting
-
A RuleDefinition represents a set of criteria that describe a named condition.
- RuleDefinition(String, String) - Constructor for class com.marklogic.client.alerting.RuleDefinition
-
Make a new rule definition
- RuleDefinition() - Constructor for class com.marklogic.client.alerting.RuleDefinition
-
Make a new rule definition, no argument constructor.
- RuleDefinition.RuleMetadata - Interface in com.marklogic.client.alerting
-
A RuleMetadata represents optional client-supplied metadata that is stored alongside a RuleDefinition.
- RuleDefinitionList - Class in com.marklogic.client.alerting
-
Models a list of RuleDefinitions.
- RuleDefinitionList() - Constructor for class com.marklogic.client.alerting.RuleDefinitionList
-
- RuleListReadHandle - Interface in com.marklogic.client.io.marker
-
- RuleManager - Interface in com.marklogic.client.alerting
-
Manages CRUD of rules for the REST API alerting capability, as well as match operations against installed rules.
- RuleReadHandle - Interface in com.marklogic.client.io.marker
-
- ruleset(String) - Static method in class com.marklogic.client.semantics.SPARQLRuleset
-
- rulesetStore(String...) - Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store with additional triples inferred based on rules.
- rulesetStore(XsStringSeqVal, SemStoreExpr...) - Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store with additional triples inferred based on rules and a base store providing triples as input for the rules.
- rulesetStore(XsStringSeqVal, SemStoreSeqExpr, String...) - Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store with additional triples inferred based on rules and a base store providing triples as input for the rules.
- RuleWriteHandle - Interface in com.marklogic.client.io.marker
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.ClientCreator
-
- run() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentDelete
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentFormats
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataWrite
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentOutputStream
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteServerURI
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JavascriptResourceExtension
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.KerberosSSLClientCreator
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.ResourceExtension
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.SSLClientCreator
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.extension.BatchManagerExample
-
- run(DatabaseClient, DatabaseClient) - Static method in class com.marklogic.client.example.extension.GraphSPARQLExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.extension.OpenCSVBatcherExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.HTMLCleanerHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.URIHandleExample
-
- run(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- runQuery(DatabaseClient) - Static method in class com.marklogic.client.example.extension.GraphSPARQLExample
-
- runShortcut(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- runShortcut(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- runShortcut(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- runShortcut(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- runStrongTyped(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- runStrongTyped(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.cookbook.JAXBDocument
-
- runStrongTyped(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.QueryOptions
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.DOM4JHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.GSONHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JacksonHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.JDOMHandleExample
-
- runStrongTyped(Util.ExampleProperties) - Static method in class com.marklogic.client.example.handle.XOMHandleExample
-
- SAME_AS - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- sameTerm(XsAnyAtomicTypeExpr, String) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
- sameTerm(XsAnyAtomicTypeExpr, XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
- sample(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function randomly selects one non-null value of the column from the rows in the group or row set.
- sample(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function randomly selects one non-null value of the column from the rows in the group or row set.
- sayHello() - Method in class com.marklogic.client.example.cookbook.JavascriptResourceExtension.HelloWorld
-
- schemaCol(String, String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Unambiguously identifies a column with the schema name, view name, and column name.
- schemaCol(XsStringVal, XsStringVal, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Unambiguously identifies a column with the schema name, view name, and column name.
- scriptLanguage - Static variable in class com.marklogic.client.example.cookbook.JavascriptResourceExtension.HelloWorld
-
- search(QueryDefinition, long) - Method in interface com.marklogic.client.document.DocumentManager
-
- search(QueryDefinition, long, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
- search(QueryDefinition, long, SearchReadHandle) - Method in interface com.marklogic.client.document.DocumentManager
-
- search(QueryDefinition, long, SearchReadHandle, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
- search(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- search(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- search(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- search(long, String...) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Find all persisted pojos of the type managed by this PojoRepository also in one of the specified collections and unmarshall their data into new pojo instances.
- search(long, Transaction, String...) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, find all persisted pojos of the type managed by this PojoRepository also in one of the specified collections and unmarshall their data into new pojo instances.
- search(PojoQueryDefinition, long) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, search persisted pojos of the type managed by this PojoRepository for matches to this query and unmarshall their data into new pojo instances.
- search(PojoQueryDefinition, long, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, search persisted pojos of the type managed by this PojoRepository for matches to this query and unmarshall their data into new pojo instances.
- search(PojoQueryDefinition, long, SearchReadHandle) - Method in interface com.marklogic.client.pojo.PojoRepository
-
- search(PojoQueryDefinition, long, SearchReadHandle, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, search persisted pojos of the type managed by this PojoRepository for matches to this query and unmarshall their data into new pojo instances.
- search(QueryDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options.
- search(QueryDefinition, T, String) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options.
- search(QueryDefinition, T, long) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
- search(QueryDefinition, T, long, String) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
- search(QueryDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options.
- search(QueryDefinition, T, Transaction, String) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options.
- search(QueryDefinition, T, long, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
- search(QueryDefinition, T, long, Transaction, String) - Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
- SEARCH_API_NS - Static variable in class com.marklogic.client.query.StructuredQueryBuilder
-
- SEARCH_NS - Static variable in class com.marklogic.client.RequestConstants
-
The namespace URI for vocabularies implemented by the Search API.
- SEARCH_PREFIX - Static variable in class com.marklogic.client.RequestConstants
-
The conventional namespace prefix for vocabularies implemented by the Search API.
- SearchCollector - Class in com.marklogic.client.example.extension
-
SearchCollector provides an extension for collecting a set of database documents based on a search.
- SearchCollector(DatabaseClient) - Constructor for class com.marklogic.client.example.extension.SearchCollector
-
- SearchCollector.CollectorResults - Class in com.marklogic.client.example.extension
-
- SearchCollectorExample - Class in com.marklogic.client.example.extension
-
SearchCollectorExample illustrates reading a page of documents qualified by a query using the SearchCollector class example of a Resource Extension.
- SearchCollectorExample() - Constructor for class com.marklogic.client.example.extension.SearchCollectorExample
-
- SearchHandle - Class in com.marklogic.client.io
-
A SearchHandle represents a set of search results returned by the server.
- SearchHandle() - Constructor for class com.marklogic.client.io.SearchHandle
-
- SearchHandle.Report - Class in com.marklogic.client.io
-
Represents a report message.
- SearchHandle.Warning - Class in com.marklogic.client.io
-
Represents a warning.
- SearchMetrics - Interface in com.marklogic.client.query
-
A SearchMetrics object represents the query metrics returned by a search.
- SearchReadHandle - Interface in com.marklogic.client.io.marker
-
A SearchReadHandle represents the results of a search performed over the database.
- SearchResponseTransform - Class in com.marklogic.client.example.cookbook
-
Search illustrates adding a result transformation to a search.
- SearchResponseTransform() - Constructor for class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- SearchResults - Interface in com.marklogic.client.query
-
The SearchResults represent the set of results returned by a search.
- seconds(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:decimal value between 0 and 60.999…, both inclusive, representing the seconds and fractional seconds in the localized value of arg.
- secondsFromDateTime(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:decimal value between 0 and 60.999…, both inclusive representing the seconds and fractional seconds in the localized value of arg.
- secondsFromDuration(XsDurationExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:decimal representing the seconds component in the canonical lexical representation of the value of arg.
- secondsFromTime(XsTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:decimal value between 0 and 60.999…, both inclusive, representing the seconds and fractional seconds in the localized value of arg.
- select(PlanExprCol...) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
- select(PlanExprColSeq) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
- select(PlanExprColSeq, String) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
- select(PlanExprColSeq, XsStringVal) - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
- sem - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with sem server functions.
- SemBlankExpr - Interface in com.marklogic.client.type
-
An instance of a semantic bnode (blank node) expression.
- SemBlankSeqExpr - Interface in com.marklogic.client.type
-
A sequence of semantic bnode (blank node) expressions.
- SemExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the sem server library for a row pipeline and constructs client values with sem.* server types.
- SemInvalidExpr - Interface in com.marklogic.client.type
-
An instance of an semantic invalid expression.
- SemInvalidSeqExpr - Interface in com.marklogic.client.type
-
A sequence of semantic invalid expressions.
- SemIriExpr - Interface in com.marklogic.client.type
-
An instance of a semantic IRI expression.
- SemIriSeqExpr - Interface in com.marklogic.client.type
-
A sequence of semantic IRI expressions.
- SemIriSeqVal - Interface in com.marklogic.client.type
-
A sequence of semantic IRI values.
- SemIriVal - Interface in com.marklogic.client.type
-
An instance of a semantic IRI value.
- SemStoreExpr - Interface in com.marklogic.client.type
-
An instance of a semantic store expression.
- SemStoreSeqExpr - Interface in com.marklogic.client.type
-
A sequence of semantic store expressions.
- SemUnknownExpr - Interface in com.marklogic.client.type
-
An instance of a semantic unknown expression.
- SemUnknownSeqExpr - Interface in com.marklogic.client.type
-
A sequence of semantic unknown expressions.
- SemValue - Interface in com.marklogic.client.expression
-
SemValue takes Java values and constructs atomic values and sequences of atomic values with a semantic data type
- sequenceAggregate(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
- sequenceAggregate(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
- sequenceAggregate(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
- sequenceAggregate(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
- serialize() - Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Returns the structured query definition as a serialized XML string.
- serialize() - Method in interface com.marklogic.client.query.StructuredQueryBuilder.Point
-
- serialize() - Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Returns the structured query definition as a serialized XML string.
- ServerConfigurationManager - Interface in com.marklogic.client.admin
-
The ServerConfigurationManager reads and writes the configurable properties of the server.
- ServerConfigurationManager.Policy - Enum in com.marklogic.client.admin
-
Specifies the policy for use of a capability.
- ServerConfigurationManager.UpdatePolicy - Enum in com.marklogic.client.admin
-
Specifies the policy for updating documents in the database.
- ServerEvaluationCall - Interface in com.marklogic.client.eval
-
ServerEvaluationCall uses a fluent builder-style API to collect the parameters for a server-side
xquery or
javascript eval or invoke (
modulePath) call.
- ServerTransform - Class in com.marklogic.client.document
-
ServerTransform specifies the invocation of a transform on the server including both the name of the transform and the parameters passed to the transform.
- ServerTransform(String) - Constructor for class com.marklogic.client.document.ServerTransform
-
Specifies invocation of the named transform on the server.
- set(TagNode) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(File, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(InputStream, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(Reader) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- set(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- set(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- set(Document) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Assigns an XML document structure as the content.
- set(JsonElement) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Assigns a JSON tree as the content.
- set(Document) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Assigns an XML document structure as the content.
- set(Document) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Assigns an XML document structure as the content.
- set(byte[]) - Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array as the content.
- set(Document) - Method in class com.marklogic.client.io.DOMHandle
-
Assigns a DOM document as the content.
- set(File) - Method in class com.marklogic.client.io.FileHandle
-
Assigns a file as the content.
- set(InputSource) - Method in class com.marklogic.client.io.InputSourceHandle
-
Assigns an input source as the content.
- set(InputStream) - Method in class com.marklogic.client.io.InputStreamHandle
-
Assigns an input stream as the content.
- set(T) - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Assigns your custom POJO as the content.
- set(JsonNode) - Method in class com.marklogic.client.io.JacksonHandle
-
Assigns a JSON tree as the content.
- set(JsonParser) - Method in class com.marklogic.client.io.JacksonParserHandle
-
Available for the edge case that content from a JsonParser must be written.
- set(C) - Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure for the content.
- set(C) - Method in interface com.marklogic.client.io.marker.ContentHandle
-
Assigns the content.
- set(OutputStreamSender) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Assigns an output stream sender providing the callback that writes content to the database via an output stream.
- set(Reader) - Method in class com.marklogic.client.io.ReaderHandle
-
Assigns an character reader as the content.
- set(Source) - Method in class com.marklogic.client.io.SourceHandle
-
Assigns a transform source that produces the content.
- set(String) - Method in class com.marklogic.client.io.StringHandle
-
Assigns an string as the content.
- set(XMLEventReader) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Assigns the event reader for the content.
- set(XMLStreamReader) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Assigns the stream reader for the content.
- setAggregate(String...) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the name of the aggregate function to be applied as part of this values query.
- setAggregatePath(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the aggregate path.
- setAuthentication(DatabaseClientFactory.Authentication) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- setAuthenticationValue(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- setBaseUri(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setBaseUri(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setBaseUri(String) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
set the base IRI for the query
- setBatchFailureListeners(WriteFailureListener...) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Remove any existing WriteFailureListener instances registered via onBatchFailure including the HostAvailabilityListener registered by default and replace them with the provided listeners.
- setBatchSize(int) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- setBatchSuccessListeners(WriteBatchListener...) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Remove any existing WriteBatchListener instances registered via onBatchSuccess and replace them with the provided listeners.
- setBindings(SPARQLBindings) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the child SPARQLBindings instance.
- setBuilder(SAXBuilder) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Specifies a JDOM structure builder for XML content.
- setBuilder(Builder) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Specifies a XOM structure builder for XML content.
- setByteLength(long) - Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the length of the content in bytes or the UNKNOWN_LENGTH constant if the length of the content is not known.
- setByteLength(long) - Method in class com.marklogic.client.io.BaseHandle
-
- setCapability(String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
sets the capability for this permission
- setClient(HttpClient) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setCollections(DocumentMetadataHandle.DocumentCollections) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document collections.
- setCollections(String...) - Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the list of collections to which the query should be limited.
- setConfiguration(CleanerProperties) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setConstrainingQueryDefinition(QueryDefinition) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the search query used to constrain the set of documents included in the SPARQL query.
- setContentFormat(Format) - Method in interface com.marklogic.client.document.DocumentManager
-
Sets the default format of the managed documents
- setContentMax(long) - Method in interface com.marklogic.client.util.RequestLogger
-
Controls how much content is copied to the log (defaulting to NO_CONTENT).
- setContext(SSLContext) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- setContext(HttpContext) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setCriteria(String) - Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Sets the query criteria as a query string.
- setCriteria(String) - Method in interface com.marklogic.client.query.StringQueryDefinition
-
Sets the query criteria as a query string.
- setCriteria(String) - Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Sets the query criteria as a query string.
- setCursorPosition(Integer) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets the cursor position to use in the suggest call.
- setDatabase(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the database for clients created with a DatabaseClientFactory.Bean object.
- setDatatypeStyle(RowManager.RowSetPart) - Method in interface com.marklogic.client.row.RowManager
-
Specifies whether to emit the data type of each column in each row or only in the header in the response for requests made with the row manager.
- setDefaultDocumentReadTransform(String) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies the name of the default transform for reading documents.
- setDefaultDocumentReadTransformAll(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the default transform for reading documents applies to all users or only users with the rest-reader role.
- setDefaultGraphUris(String...) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of the graph or graphs to use as the default graph.
- setDefaultMimetype(String) - Method in interface com.marklogic.client.semantics.GraphManager
-
Set the default mimetype for data sent by write* or merge* methods and data serialized by the server in response to calls to read* or things* methods.
- setDefaultNamespaceURI(String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Specifies the namespace URI bound to the empty prefix.
- setDefaultWriteSchema(Schema) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the default schema for validating the input source.
- setDescription(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the description of the extension.
- setDescription(String) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the description of the rule.
- setDescription(String) - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- setDirection(ValuesDefinition.Direction) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the direction of the results to use in this values query.
- setDirectory(String) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the directory that should prefix the document uri.
- setDirectory(String) - Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the directory to which the query should be limited.
- setDistributor_id(int) - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- setDocumentRepair(XMLDocumentManager.DocumentRepair) - Method in interface com.marklogic.client.document.XMLDocumentManager
-
Specifies whether poorly formed XML documents written by the manager should be repaired on the server.
- setEnabled(boolean) - Method in interface com.marklogic.client.util.RequestLogger
-
Suspend or resume logging.
- setErrorHandler(ErrorHandler) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the error handler for errors discovered while parsing the input source.
- setExtension(String) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the extension that should suffix the document uri.
- setExternalName(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the external name for Kerberos clients created with a DatabaseClientFactory.Bean object.
- setFactory(DocumentBuilderFactory) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the factory for building DOM documents.
- setFactory(SAXParserFactory) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the factory for parsing SAX events.
- setFactory(XMLInputFactory) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the factory for parsing StAX events.
- setFactory(XMLInputFactory) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the factory for parsing StAX streams.
- setFormat(Format) - Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the format of the content as binary, JSON, text, or XML.
- setFormat(Format) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setFormat(Format) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Restricts the format to JSON.
- setFormat(Format) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.BaseHandle
-
- setFormat(Format) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Restricts the format used parsing and serializing the metadata.
- setFormat(Format) - Method in class com.marklogic.client.io.DOMHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.InputSourceHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.JAXBHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.SearchHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.SourceHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.TuplesHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.ValuesHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.ValuesListHandle
-
Sets the format associated with this handle.
- setFormat(Format) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Restricts the format to XML.
- setFormat(Format) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Restricts the format to XML.
- setFrequency(ValuesDefinition.Frequency) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the frequency to be used in this values query.
- setHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawQueryDefinition
-
Specifies the handle for the JSON or XML representation of the query.
- setHandle(JSONWriteHandle) - Method in interface com.marklogic.client.row.RawPlanDefinition
-
Specifies the handle for the JSON representation of the plan.
- setHandleRegistry(DatabaseClientFactory.HandleFactoryRegistry) - Method in class com.marklogic.client.io.SearchHandle
-
Makes the handle registry for this database client available to this SearchHandle during processing of the search response.
- setHasHeader(boolean) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- setHost(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the host for clients created from a DatabaseClientFactory.Bean object.
- setId(int) - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- setIncludeDefaultRulesets(Boolean) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set whether to include database-default inference or not.
- setIndustry(String) - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- setLimit(Integer) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets a limit for a suggest call.
- setMapper(ObjectMapper) - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Enables clients to specify their own ObjectMapper instance, including databinding mappers for formats other than JSON.
- setMapper(ObjectMapper) - Method in class com.marklogic.client.io.JacksonParserHandle
-
Enables clients to specify their own ObjectMapper instance, including databinding mappers for formats other than JSON.
- setMetadata(RuleDefinition.RuleMetadata) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the metadata object for this rule.
- setMetadataCategories(Set<DocumentManager.Metadata>) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read, write, patch, or search.
- setMetadataCategories(DocumentManager.Metadata...) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read, write, patch, or search.
- setMetadataExtraction(BinaryDocumentManager.MetadataExtraction) - Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Specifies the metadata extraction policy for binary documents.
- setMetadataValues(DocumentMetadataHandle.DocumentMetadataValues) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document metadata-values.
- setMimetype(String) - Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the mimetype of the content such as application/json, text/plain, or application/xml.
- setMimetype(String) - Method in class com.marklogic.client.io.BaseHandle
-
- setName(String) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the name of the rule.
- setName(String) - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs.ProductDetails
-
- setName(String) - Method in class com.marklogic.client.example.cookbook.JAXBDocument.Product
-
- setName(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the name of the values constraint.
- setNamedGraphUris(String...) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of a named graph or graphs to include in the query or update operation.
- setNamespaceContext(NamespaceContext) - Method in interface com.marklogic.client.util.NameMap
-
Specifies a namespace context that declares the namespace bindings used to convert prefixed string names into QNames.
- setNamespaces(IterableNamespaceContext) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Declares the namespaces available for the paths of a patch against XML documents.
- setNamespaces(IterableNamespaceContext) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies the namespace bindings used for the query.
- setNamespaceURI(String, String) - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Specifies a binding between a prefix and a namespace URI.
- setNonDocumentFormat(Format) - Method in interface com.marklogic.client.document.DocumentManager
-
- setOptimizeLevel(int) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set a number indicating how much time for the query engine to spend analyzing a query.
- setOptionsName(String) - Method in class com.marklogic.client.io.ValuesListHandle
-
Sets the name of the query options to be used for this query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the name of the query options to be used for this query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets the name of the query options to be used for this query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Set the name of the options node to use for this values query.
- setOptionsName(String) - Method in interface com.marklogic.client.query.ValuesListDefinition
-
Set the name of the options node to be used for this query.
- setOutputFormat(OutputFormat) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Specifies the dom4j output format for serializing XML content.
- setOutputter(XMLOutputter) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Specifies a JDOM serializer for XML content.
- setPageLength(long) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the maximum number of documents that can appear in any page of the query results, overriding any maximum specified in the query options.
- setPageLength(long) - Method in class com.marklogic.client.example.extension.SearchCollector
-
- setPageLength(long) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Set the number of instances per page returned when calling
readAll or
search.
- setPageLength(long) - Method in interface com.marklogic.client.query.QueryManager
-
Specifies the maximum number of documents that can appear in any page of the query results, overriding any maximum specified in the query options.
- setPageLength(long) - Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Set a page length for all SPARQL “SELECT” queries sent by this instance.
- setParser(HtmlCleaner) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setPassword(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- setPath(String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
Sets the path for this module descriptor.
- setPermissions(DocumentMetadataHandle.DocumentPermissions) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document permissions.
- setPort(int) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the port for clients created with a DatabaseClientFactory.Bean object.
- setProperties(DocumentMetadataHandle.DocumentProperties) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document properties.
- setProvider(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the name of the organization providing the extension.
- setQuality(int) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Sets the search quality of the document.
- setQuality(int) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Specifies the quality of the document, which affects search weighting.
- setQueryCriteria(QueryDefinition) - Method in class com.marklogic.client.io.SearchHandle
-
Sets the query definition used in the search.
- setQueryCriteria(ValuesDefinition) - Method in class com.marklogic.client.io.TuplesHandle
-
Specifies the tuples query definition used to identify this set of tuples.
- setQueryCriteria(ValuesDefinition) - Method in class com.marklogic.client.io.ValuesHandle
-
Sets the query definition used when retrieving values.
- setQueryDefinition(ValueQueryDefinition) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Set the query definition associated with this values query.
- setQueryFailureListeners(QueryFailureListener...) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Remove any existing QueryFailureListener instances registered via onBatchFailure including the HostAvailabilityListener registered by default and replace them with the provided listeners.
- setQueryOptionValidation(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server validates query options before storing them.
- setQueryStrings(String...) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets zero or more search strings to AND with the suggestion call.
- setQueryValidation(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server validates queries before running them.
- setReader(SAXReader) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Specifies a dom4j reader for XML content.
- setReadTransform(ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a transform for read requests that don’t specify a transform.
- setResendable(boolean) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies whether the content can be resent to the output stream if the request must be retried.
- setResolver(LSResourceResolver) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the resolver for resolving references while parsing the document.
- setResolver(EntityResolver) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the resolver for resolving references while parsing the input source.
- setResolver(XMLResolver) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the resolver for resolving references while parsing the event reader source.
- setResolver(XMLResolver) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the resolver for resolving references while parsing the event reader source.
- setResponseTransform(ServerTransform) - Method in interface com.marklogic.client.query.QueryDefinition
-
Specifies a transform that modifies responses to this query on the server.
- setRoleName(String) - Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
sets the role name for this permission
- setRowStructureStyle(RowManager.RowStructure) - Method in interface com.marklogic.client.row.RowManager
-
Specifies whether to get each row as an object (the default) or as an array in the response for requests made with the row manager.
- setRulesets(SPARQLRuleset...) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the name of rulesets to include for inferring triples.
- setRulesProvider(ITagInfoProvider) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setScriptLanguage(ExtensionMetadata.ScriptLanguage) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the script language for this resource extension, either XQUERY (default) or JAVASCRIPT.
- setSearchView(QueryManager.QueryView) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the view types included in a SearchReadHandle populated by calls to
search
- setSecurityContext(DatabaseClientFactory.SecurityContext) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the security context for clients created with a DatabaseClientFactory.Bean object
- setSerializer(XmlSerializer) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- setServerRequestLogging(Boolean) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server logs requests to the error log on the server.
- setServerTimestamp(long) - Method in class com.marklogic.client.io.BaseHandle
-
- setSparql(String) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- setSparql(TextWriteHandle) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- setSSLContext(SSLContext) - Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- setStringCriteria(String) - Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets one or more criteria for the suggestion call.
- setTitle(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the title of the extension.
- setTransformer(Transformer) - Method in class com.marklogic.client.io.SourceHandle
-
Specifies a transformer for modifying the content.
- setUpdatePermissions(GraphPermissions) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
For use with
SPARQL update,
where specified permissions will apply to any records created by the
update.
- setUpdatePolicy(ServerConfigurationManager.UpdatePolicy) - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies the policy for updating or deleting documents in the database.
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentDelete
-
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- setUpExample(DatabaseClient, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.extension.BatchManagerExample
-
- setUpExample(DatabaseClient) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- setUpExample(XMLDocumentManager, String, String) - Static method in class com.marklogic.client.example.handle.URIHandleExample
-
- setUri(String) - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the URI identifier for a database document.
- setUrisReadyListeners(QueryBatchListener...) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Remove any existing QueryBatchListener instances registered via onBatchSuccess and replace them with the provided listeners.
- setUsePut(boolean) - Method in class com.marklogic.client.example.handle.URIHandle
-
- setUser(String) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- setUsingGraphUris(String...) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of the graph or graphs to address as part of a SPARQL update operation.
- setUsingNamedGraphUris(String...) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of a named graph or graphs to address as part of a SPARQL update operation.
- setVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- setVersion(String) - Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the version identifier for the extension implementation.
- setVersion(long) - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the document version.
- setView(QueryManager.QueryView) - Method in interface com.marklogic.client.query.QueryManager
-
Specifies the type of view results produced by queries.
- setView(String) - Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the view for this values query.
- setWriteTransform(ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a transform for write requests that don’t specify a transform.
- setXPathProcessor(XPath) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the processor used to evaluate XPath expressions against the document.
- sha1(ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA1 hash of the given argument.
- sha1(ItemExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA1 hash of the given argument.
- sha1(ItemExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA1 hash of the given argument.
- sha256(ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA256 hash of the given argument.
- sha256(ItemExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA256 hash of the given argument.
- sha256(ItemExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA256 hash of the given argument.
- sha384(ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA384 hash of the given argument.
- sha384(ItemExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA384 hash of the given argument.
- sha384(ItemExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA384 hash of the given argument.
- sha512(ItemExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA512 hash of the given argument.
- sha512(ItemExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA512 hash of the given argument.
- sha512(ItemExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA512 hash of the given argument.
- shortExpr(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:short server data type.
- shortExprSeq(XsShortExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsShortExpr items.
- shortSeq(short...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of short primitives and constructs an xs:short sequence
- shortSeq(XsShortVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:short values and constructs an xs:short sequence
- shortVal(short) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a short primitive and constructs an xs:short value
- sign(XsNumericExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the sign of number x.
- sin(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sine of x, in the range from -1 to +1 (inclusive).
- sinh(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the hyperbolic sine of x.
- size() - Method in class com.marklogic.client.alerting.RuleDefinitionList
-
gets the number of rules in the list.
- size() - Method in interface com.marklogic.client.Page
-
The count of items in this page, which is always less than getPageSize().
- size() - Method in interface com.marklogic.client.query.ExtractedResult
-
The number of ExtractedItem objects in the Iterator.
- size() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the number of namespace bindings.
- size() - Method in class com.marklogic.client.util.RequestParameters
-
Returns the number of request parameters.
- SOME_VALUES_FROM - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- sortKeySeq(PlanSortKey...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- SourceHandle - Class in com.marklogic.client.io
-
A Source Handle represents XML content as a transform source for reading
or transforms a source into a result for writing.
- SourceHandle() - Constructor for class com.marklogic.client.io.SourceHandle
-
Zero-argument constructor.
- SourceHandle(Source) - Constructor for class com.marklogic.client.io.SourceHandle
-
Initializes the handle with a transform source for the content.
- space(XsNumericExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that is the given number of spaces.
- SPARQL_CSV - Static variable in class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQL_JSON - Static variable in class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQL_XML - Static variable in class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQLBinding - Interface in com.marklogic.client.semantics
-
Represents a binding name, value, and type or language tag.
- SPARQLBindings - Interface in com.marklogic.client.semantics
- SPARQLMimeTypes - Class in com.marklogic.client.semantics
-
- SPARQLMimeTypes() - Constructor for class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQLQueryDefinition - Interface in com.marklogic.client.semantics
-
Represents a SPARQL query.
- SPARQLQueryManager - Interface in com.marklogic.client.semantics
- SPARQLResultsReadHandle - Interface in com.marklogic.client.io.marker
-
- SPARQLRuleset - Class in com.marklogic.client.semantics
-
- spell - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with spell server functions.
- SpellExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the spell server library for a row pipeline.
- split(XMLWriteHandle) - Method in class com.marklogic.client.example.extension.DocumentSplitter
-
- sql - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with sql server functions.
- SqlExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the sql server library for a row pipeline.
- sqrt(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the square root of x.
- SSLClientCreator - Class in com.marklogic.client.example.cookbook
-
SSLClientCreator illustrates the basic approach for creating a client using SSL for database access.
- SSLClientCreator() - Constructor for class com.marklogic.client.example.cookbook.SSLClientCreator
-
- START - Static variable in interface com.marklogic.client.query.QueryManager
-
The offset of the first result in the default page.
- startJob(WriteBatcher) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Begins job tracking on the WriteBatcher.
- startJob(QueryBatcher) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Starts the QueryBatcher job.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.admin.NamespacesManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.document.DocumentManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in class com.marklogic.client.extensions.ResourceManager
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.extensions.ResourceServices
-
Starts debugging client requests.
- startLogging(RequestLogger) - Method in interface com.marklogic.client.query.QueryManager
-
Starts debugging client requests.
- startsWith(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
- startsWith(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
- startsWith(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
- startsWith(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
- stddev(XsDoubleSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sample standard deviation of a sequence of values.
- stddevP(XsDoubleSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the standard deviation of a population.
- stem(XsStringExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(XsStringExpr, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- step64(XsUnsignedLongExpr, XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Combines an initial hash with a subsequent hash.
- stopJob(JobTicket) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Immediately cancel all queued tasks, prevent new tasks from being added to the queue, and begin to free all resources.
- stopJob(Batcher) - Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Immediately cancel all queued tasks, prevent new tasks from being added to the queue, and begin to free all resources.
- stopLogging() - Method in interface com.marklogic.client.admin.NamespacesManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.document.DocumentManager
-
Stops debugging client requests.
- stopLogging() - Method in class com.marklogic.client.extensions.ResourceManager
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.extensions.ResourceServices
-
Stops debugging client requests.
- stopLogging() - Method in interface com.marklogic.client.query.QueryManager
-
Stops debugging client requests.
- store(String...) - Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store for accessing triples, modifying the triple retrieval based on the options.
- store(XsStringSeqVal, CtsQueryExpr) - Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store for accessing triples, modifying the triple retrieval based on the options with a restriction to the triples contained in documents matching the query.
- stores(SemStoreExpr...) - Method in interface com.marklogic.client.expression.SemValue
-
Takes any number of triple store specifications and constructs a store sequence
- stream() - Method in interface com.marklogic.client.row.RowSet
-
Streams each row in the set of rows.
- strftime(XsStringExpr, String) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Formats a dateTime value using POSIX strftime.
- strftime(XsStringExpr, XsDateTimeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Formats a dateTime value using POSIX strftime.
- STRICT - Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The STRICT SSLHostnameVerifier applies strict rules for checking hostnames during SSL authentication (similar to org.apache.http.conn.ssl.StrictHostnameVerifier).
- string(ItemExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of arg represented as an xs:string.
- string(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:string server data type.
- string(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a String literal and constructs an xs:string value
- StringHandle - Class in com.marklogic.client.io
-
A String Handle represents document content as a string for reading or writing.
- StringHandle() - Constructor for class com.marklogic.client.io.StringHandle
-
Zero-argument constructor.
- StringHandle(String) - Constructor for class com.marklogic.client.io.StringHandle
-
Initializes the handle with a string for the content.
- stringJoin(XsStringSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:string created by concatenating the members of the parameter1 sequence using parameter2 as a separator.
- stringJoin(XsStringSeqExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:string created by concatenating the members of the parameter1 sequence using parameter2 as a separator.
- stringLength(XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns an integer representing the length of the specified string.
- StringQueryDefinition - Interface in com.marklogic.client.query
-
A StringQueryDefinition represents the criteria associated with a simple string query.
- StringSearch - Class in com.marklogic.client.example.cookbook
-
StringSearch illustrates searching for documents and iterating over results with string criteria referencing a constraint defined by options.
- StringSearch() - Constructor for class com.marklogic.client.example.cookbook.StringSearch
-
- stringSeq(XsStringExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsStringExpr items.
- stringSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of String literals and constructs an xs:string sequence
- stringSeq(XsStringVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:string values and constructs an xs:string sequence
- stringToCodepoints(XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence of Unicode code points that constitute an xs:string.
- StructuredQueryBuilder - Class in com.marklogic.client.query
-
StructuredQueryBuilder builds a query for documents in the database.
- StructuredQueryBuilder() - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Zero-argument constructor.
- StructuredQueryBuilder(String) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries against the options persisted with the specified name.
- StructuredQueryBuilder(IterableNamespaceContext) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries using the specified namespace bindings.
- StructuredQueryBuilder(String, IterableNamespaceContext) - Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries against the options persisted with the specified name using the specified namespace bindings.
- StructuredQueryBuilder.Attribute - Interface in com.marklogic.client.query
-
An Attribute represents an attribute in database documents.
- StructuredQueryBuilder.Axis - Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.Box - Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.Circle - Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.ContainerIndex - Interface in com.marklogic.client.query
-
A ContainerIndex can be used for container queries.
- StructuredQueryBuilder.CoordinateSystem - Class in com.marklogic.client.query
-
CoordinateSystem provides a list of all known coordinate systems and it also provides a capability to add new CoordinateSystems in the future
- StructuredQueryBuilder.Element - Interface in com.marklogic.client.query
-
An Element represents an element in database documents.
- StructuredQueryBuilder.ElementAttribute - Interface in com.marklogic.client.query
-
An ElementAttribute represents an attribute on an element in database documents.
- StructuredQueryBuilder.Field - Interface in com.marklogic.client.query
-
A Field represents a field defined in the database configuration.
- StructuredQueryBuilder.FragmentScope - Enum in com.marklogic.client.query
-
Whether a query should search the document or its associated properties.
- StructuredQueryBuilder.GeospatialIndex - Interface in com.marklogic.client.query
-
A GeospatialIndex can be used for geospatial queries.
- StructuredQueryBuilder.GeospatialOperator - Enum in com.marklogic.client.query
-
Geospatial operators to be used in geospatial region index queries
- StructuredQueryBuilder.GeospatialRegionIndex - Interface in com.marklogic.client.query
-
A GeospatialRangeIndex can be used for geospatial region index queries.
- StructuredQueryBuilder.JSONProperty - Interface in com.marklogic.client.query
-
A JSONProperty represents a key in JSON database documents.
- StructuredQueryBuilder.Operator - Enum in com.marklogic.client.query
-
A comparison operator for use in range queries.
- StructuredQueryBuilder.Ordering - Enum in com.marklogic.client.query
-
Control over ordering for use in near queries.
- StructuredQueryBuilder.PathIndex - Interface in com.marklogic.client.query
-
A PathIndex represents an index defined with an XPath in the database configuration.
- StructuredQueryBuilder.Period - Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.Point - Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.Polygon - Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.RangeIndex - Interface in com.marklogic.client.query
-
A RangeIndex can be used for range queries.
- StructuredQueryBuilder.Region - Interface in com.marklogic.client.query
-
A region matched by a geospatial query.
- StructuredQueryBuilder.TemporalOperator - Enum in com.marklogic.client.query
-
- StructuredQueryBuilder.TextIndex - Interface in com.marklogic.client.query
-
A TextIndex can be used for word and value queries.
- StructuredQueryDefinition - Interface in com.marklogic.client.query
-
A StructuredQueryDefinition represents a structured query.
- StructuredSearch - Class in com.marklogic.client.example.cookbook
-
StructuredSearch illustrates searching for documents and iterating over results with structured criteria referencing a constraint defined by options.
- StructuredSearch() - Constructor for class com.marklogic.client.example.cookbook.StructuredSearch
-
- StructureReadHandle - Interface in com.marklogic.client.io.marker
-
A Structure Read Handle can represent a data structure read from the database.
- StructureWriteHandle - Interface in com.marklogic.client.io.marker
-
A Structure Write Handle can represent a data structure written to the database.
- subarray(JsonArrayExpr, double) - Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a new array.
- subarray(JsonArrayExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a new array.
- subarray(JsonArrayExpr, double, double) - Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a new array.
- subarray(JsonArrayExpr, XsNumericExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a new array.
- SUBCLASS_OF - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- subjectSeq(PlanTriplePosition...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- SUBPROPERTY_OF - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- subsequence(ItemSeqExpr, double) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the value of sourceSeq beginning at the position indicated by the value of startingLoc and continuing for the number of items indicated by the value of length.
- subsequence(ItemSeqExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the value of sourceSeq beginning at the position indicated by the value of startingLoc and continuing for the number of items indicated by the value of length.
- subsequence(ItemSeqExpr, double, double) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the value of sourceSeq beginning at the position indicated by the value of startingLoc and continuing for the number of items indicated by the value of length.
- subsequence(ItemSeqExpr, XsNumericExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the value of sourceSeq beginning at the position indicated by the value of startingLoc and continuing for the number of items indicated by the value of length.
- substring(XsStringExpr, double) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the startingLoc and continuing for length characters.
- substring(XsStringExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the startingLoc and continuing for length characters.
- substring(XsStringExpr, double, double) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the startingLoc and continuing for length characters.
- substring(XsStringExpr, XsNumericExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the startingLoc and continuing for length characters.
- substringAfter(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to reduce an existing string to a trailing substring.
- substringAfter(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur after the specified after characters.
- substringAfter(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur after the specified after characters.
- substringAfter(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur after the specified after characters.
- substringAfter(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur after the specified after characters.
- substringBefore(String) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to reduce an existing string to a leading substring.
- substringBefore(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur before the specified before characters.
- substringBefore(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur before the specified before characters.
- substringBefore(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur before the specified before characters.
- substringBefore(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of the input characters that occur before the specified before characters.
- subtract(Number) - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to subtract from an existing value.
- subtract(XsNumericExpr, XsNumericExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function subtracts the right numericExpression from the left numericExpression and returns the value.
- suggest(String, Integer, Integer, String...) - Method in class com.marklogic.client.example.cookbook.ResourceExtension.DictionaryManager
-
- Suggest - Class in com.marklogic.client.example.cookbook
-
Suggest illustrates getting suggestions for words to find in an element.
- Suggest() - Constructor for class com.marklogic.client.example.cookbook.Suggest
-
- suggest(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- suggest(SuggestDefinition) - Method in interface com.marklogic.client.query.QueryManager
-
Queries the REST server for suggested string completions based on values in the SuggestionDefinition.
- SuggestDefinition - Interface in com.marklogic.client.query
-
Represents the criteria for a suggestion call, in which the beginning of a term is supplied for possible suggested endings.
- sum(XsAnyAtomicTypeSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a value obtained by adding together the values in arg.
- sum(XsAnyAtomicTypeSeqExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a value obtained by adding together the values in arg.
- sum(XsAnyAtomicTypeSeqExpr, XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a value obtained by adding together the values in arg.
- sum(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the column for the rows in the group or row set.
- sum(PlanColumn, PlanExprCol) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the column for the rows in the group or row set.
- sum(String, String, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the column for the rows in the group or row set.
- sum(PlanColumn, PlanExprCol, PlanValueOption) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the column for the rows in the group or row set.
- SYMMETRIC_PROPERTY - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- tail(ItemSeqExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns all but the first item in a sequence.
- tan(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the tangent of x.
- tanh(XsDoubleExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
- tearDownExample(XMLDocumentManager, String) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataRead
-
- tearDownExample(XMLDocumentManager, String) - Static method in class com.marklogic.client.example.cookbook.DocumentMetadataWrite
-
- tearDownExample(XMLDocumentManager, String) - Static method in class com.marklogic.client.example.cookbook.DocumentOutputStream
-
- tearDownExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentRead
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.DocumentReadTransform
-
- tearDownExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.DocumentWrite
-
- tearDownExample(XMLDocumentManager, String) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteServerURI
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.JavascriptResourceExtension
-
- tearDownExample(XMLDocumentManager, String) - Static method in class com.marklogic.client.example.cookbook.MultiStatementTransaction
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.OptimisticLocking
-
- tearDownExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawClientAlert
-
- tearDownExample(DatabaseClient) - Static method in class com.marklogic.client.example.cookbook.RawCombinedSearch
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.ResourceExtension
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.SearchResponseTransform
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StringSearch
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.StructuredSearch
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.Suggest
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.extension.BatchManagerExample
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.extension.OpenCSVBatcherExample
-
- tearDownExample(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.extension.SearchCollectorExample
-
- tearDownExample(XMLDocumentManager, String, String, String) - Static method in class com.marklogic.client.example.handle.URIHandleExample
-
- TemporalDescriptor - Interface in com.marklogic.client.bitemporal
-
- TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle> - Interface in com.marklogic.client.bitemporal
-
- TemporalDocumentManager.ProtectionLevel - Enum in com.marklogic.client.bitemporal
-
Various protection levels to prevent updation/deletion and wiping of temporal documents.
- temporalLsqtQuery(String, Calendar, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents with LSQT prior to timestamp
- temporalLsqtQuery(String, String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents with LSQT prior to timestamp
- temporalPeriodCompare(StructuredQueryBuilder.Axis, StructuredQueryBuilder.TemporalOperator, StructuredQueryBuilder.Axis, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents that have a relevant pair of period values.
- temporalPeriodRange(StructuredQueryBuilder.Axis, StructuredQueryBuilder.TemporalOperator, StructuredQueryBuilder.Period, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents that have a value in the specified axis that matches the specified period using the specified operator.
- temporalPeriodRange(StructuredQueryBuilder.Axis[], StructuredQueryBuilder.TemporalOperator, StructuredQueryBuilder.Period[], String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents that have a value in the specified axis that matches the specified periods using the specified operator.
- term(double, String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- term(String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- term(String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents containing the specified terms.
- term(double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents containing the specified terms, modifying the contribution of the match to the score with the weight.
- TextDocumentManager - Interface in com.marklogic.client.document
-
A Text Document Manager supports database operations on text documents.
- TextNodeExpr - Interface in com.marklogic.client.type
-
An instance of a JSON or XML text node expression.
- TextNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of JSON or XML text node expressions.
- TextReadHandle - Interface in com.marklogic.client.io.marker
-
A Text Read Handle can represent text content read from the database.
- TextWriteHandle - Interface in com.marklogic.client.io.marker
-
A Text Write Handle can represent text content written to the database.
- things(T, String...) - Method in interface com.marklogic.client.semantics.GraphManager
-
Retrieves all triples related to specified subject or object iris.
- thingsAs(Class<T>, String...) - Method in interface com.marklogic.client.semantics.GraphManager
-
Retrieves all triples related to specified subject or object iris.
- time(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:time server data type.
- time(String) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a time of day in a string format based on ISO 8601 and constructs an xs:time value
- time(Calendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a time of day as a Calendar value and constructs an xs:time value
- time(XMLGregorianCalendar) - Method in interface com.marklogic.client.expression.XsValue
-
Takes a time of day as a XMLGregorianCalendar value and constructs an xs:time value
- timeSeq(XsTimeExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsTimeExpr items.
- timeSeq(String...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of times of day in a string format based on ISO 8601 and constructs an xs:time sequence
- timeSeq(Calendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of times of day as Calendar values and constructs an xs:time sequence
- timeSeq(XMLGregorianCalendar...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of times of day as XMLGregorianCalendar values and constructs an xs:time sequence
- timeSeq(XsTimeVal...) - Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:time values and constructs an xs:time sequence
- timestampadd(XsStringExpr, int, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
- timestampadd(XsStringExpr, XsIntExpr, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
- timestampdiff(XsStringExpr, ItemExpr, ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the difference in dateTimeType field of two given timestamps.
- timestampToWallclock(XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Converts a 64 bit timestamp value to an xs:dateTime.
- timezoneFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the timezone component of arg if any.
- timezoneFromDateTime(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the timezone component of arg if any.
- timezoneFromTime(XsTimeExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the timezone component of arg if any.
- timezoneString(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns the timezone of an xs:dateTime value as a string.
- toArray() - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs an array from a sequence of items.
- toArray(ItemSeqExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs an array from a sequence of items.
- toArray(ItemSeqExpr, double) - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs an array from a sequence of items.
- toArray(ItemSeqExpr, XsNumericExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs an array from a sequence of items.
- toArray(ItemSeqExpr, double, ItemExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs an array from a sequence of items.
- toArray(ItemSeqExpr, XsNumericExpr, ItemExpr) - Method in interface com.marklogic.client.expression.JsonExpr
-
Constructs an array from a sequence of items.
- toBuffer() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- toBuffer() - Method in class com.marklogic.client.extra.gson.GSONHandle
-
- toBuffer() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- toBuffer() - Method in class com.marklogic.client.extra.xom.XOMHandle
-
- toBuffer() - Method in class com.marklogic.client.io.BytesHandle
-
- toBuffer() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- toBuffer() - Method in class com.marklogic.client.io.DOMHandle
-
- toBuffer() - Method in class com.marklogic.client.io.InputSourceHandle
-
- toBuffer() - Method in class com.marklogic.client.io.InputStreamHandle
-
- toBuffer() - Method in class com.marklogic.client.io.JAXBHandle
-
- toBuffer() - Method in interface com.marklogic.client.io.marker.BufferableHandle
-
Copies the content of the handle to a byte array buffer encoded in UTF-8.
- toBuffer() - Method in class com.marklogic.client.io.ReaderHandle
-
- toBuffer() - Method in class com.marklogic.client.io.SourceHandle
-
- toBuffer() - Method in class com.marklogic.client.io.StringHandle
-
- toBuffer() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- toBuffer() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- toJson(ItemSeqExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Constructs a JSON document.
- token(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:token server data type.
- tokenize(XsStringExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Tokenizes text into words, punctuation, and spaces.
- tokenize(XsStringExpr, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Tokenizes text into words, punctuation, and spaces.
- tokenize(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Tokenizes text into words, punctuation, and spaces.
- tokenize(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Tokenizes text into words, punctuation, and spaces.
- tokenize(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.CtsExpr
-
Tokenizes text into words, punctuation, and spaces.
- tokenize(XsStringExpr, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a sequence of strings contructed by breaking the specified input into substrings separated by the specified pattern.
- tokenize(XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a sequence of strings contructed by breaking the specified input into substrings separated by the specified pattern.
- tokenize(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a sequence of strings contructed by breaking the specified input into substrings separated by the specified pattern.
- tokenize(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a sequence of strings contructed by breaking the specified input into substrings separated by the specified pattern.
- tokenSeq(XsTokenExpr...) - Method in interface com.marklogic.client.expression.XsExpr
-
Constructs a sequence of XsTokenExpr items.
- toString() - Method in enum com.marklogic.client.bitemporal.TemporalDocumentManager.ProtectionLevel
-
- toString() - Method in enum com.marklogic.client.document.DocumentManager.Metadata
-
- toString() - Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.PatchHandle
-
Returns a JSON or XML representation of the patch as a string.
- toString() - Method in enum com.marklogic.client.document.DocumentPatchBuilder.PathLanguage
-
- toString() - Method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
- toString() - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the XML document as a string.
- toString() - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the JSON tree as a string.
- toString() - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the XML document as a string.
- toString() - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Returns the XML document as a string.
- toString() - Method in class com.marklogic.client.io.BytesHandle
-
Returns a byte array as a string with the assumption that the bytes are encoded in UTF-8.
- toString() - Method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
- toString() - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns the document metadata as an XML string.
- toString() - Method in class com.marklogic.client.io.DOMHandle
-
Returns the DOM document as an XML string.
- toString() - Method in class com.marklogic.client.io.InputSourceHandle
-
Buffers the SAX input source and returns the buffer as an XML string.
- toString() - Method in class com.marklogic.client.io.InputStreamHandle
-
Buffers the input stream and returns the buffer as a string with the assumption that the stream is encoded in UTF-8.
- toString() - Method in class com.marklogic.client.io.JAXBHandle
-
Returns the JAXB structure as an XML string.
- toString() - Method in class com.marklogic.client.io.ReaderHandle
-
Buffers the character stream and returns the buffer as a string.
- toString() - Method in class com.marklogic.client.io.SourceHandle
-
Buffers the transform source and returns the buffer as a string.
- toString() - Method in class com.marklogic.client.io.StringHandle
-
Returns the content.
- toString() - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Buffers the StAX event source and returns the buffer as an XML string.
- toString() - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Buffers the StAX stream and returns the buffer as an XML string.
- toString() - Method in enum com.marklogic.client.pojo.annotation.PathIndexProperty.ScalarType
-
- toString() - Method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
- toString() - Method in enum com.marklogic.client.query.StructuredQueryBuilder.GeospatialOperator
-
- toString() - Method in enum com.marklogic.client.semantics.RDFTypes
-
- toXMLString() - Method in class com.marklogic.client.example.util.Bootstrapper.RESTServer
-
- transaction(Transaction) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this call with a transaction under which server-side execution should occur.
- Transaction - Interface in com.marklogic.client
-
Identifies and provides methods to complete a transaction.
- transform(Result) - Method in class com.marklogic.client.io.SourceHandle
-
Transforms the source for the content output to the result.
- TransformExtensionsManager - Interface in com.marklogic.client.admin
-
A Transform Extensions Manager supports writing, reading, and deleting a Transform extension as well as listing the installed Transform extensions.
- TRANSITIVE_PROPERTY - Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- translate(XsStringExpr, String, String) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string where every character in src that occurs in some position in the mapString is translated into the transString character in the corresponding location of the mapString character.
- translate(XsStringExpr, XsStringExpr, XsStringExpr) - Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string where every character in src that occurs in some position in the mapString is translated into the transString character in the corresponding location of the mapString character.
- TRIG - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- trim(XsStringExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Return a string that removes leading empty spaces in the input string.
- tripleRangeQuery(String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(String, String, String, String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(String, String, String, String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(String, String, String, String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- tripleRangeQuery(XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsAnyAtomicTypeSeqVal, XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching triples with a triple index entry equal to the given values.
- TriplesReadHandle - Interface in com.marklogic.client.io.marker
-
A marker interface for handles capable of reading semantic triples.
- TriplesWriteHandle - Interface in com.marklogic.client.io.marker
-
A marker interface for handles capable of writing semantic triples.
- TRIPLEXML - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- trueExpr() - Method in interface com.marklogic.client.expression.FnExpr
-
Returns the xs:boolean value true.
- trueQuery() - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches all fragments.
- trunc(XsNumericExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the number truncated to a certain number of decimal places.
- trunc(XsNumericExpr, long) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the number truncated to a certain number of decimal places.
- trunc(XsNumericExpr, XsIntegerExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the number truncated to a certain number of decimal places.
- Tuple - Class in com.marklogic.client.query
-
A Tuple is a single tuple value taken from a tuple/value query.
- Tuple() - Constructor for class com.marklogic.client.query.Tuple
-
- tuples(ValuesDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.
- tuples(ValuesDefinition, T, long) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.
- tuples(ValuesDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.
- tuples(ValuesDefinition, T, long, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves combinations of values for the same document from indexes based on query criteria and, potentially, previously saved query options.
- TuplesHandle - Class in com.marklogic.client.io
-
A TuplesHandle represents a set of tuples returned by a query on the server.
- TuplesHandle() - Constructor for class com.marklogic.client.io.TuplesHandle
-
- TuplesReadHandle - Interface in com.marklogic.client.io.marker
-
A TuplesReadHandle represents a set of tuples read from the database.
- TuplesResults - Interface in com.marklogic.client.query
-
TupleResults represent the values returned by a tuple values query.
- TURTLE - Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- type(XsAnyAtomicTypeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the name of the simple type of the atomic value argument as an xs:QName.
- TypedDistinctValue - Class in com.marklogic.client.query
-
A TypedDistinctValue is a value that includes a type.
- TypedDistinctValue() - Constructor for class com.marklogic.client.query.TypedDistinctValue
-
- typedLiteral(XsStringExpr, String) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns a value to represent the RDF typed literal with lexical value value and datatype IRI datatype.
- typedLiteral(XsStringExpr, SemIriExpr) - Method in interface com.marklogic.client.expression.SemExpr
-
Returns a value to represent the RDF typed literal with lexical value value and datatype IRI datatype.
- validate(RawQueryByExampleDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Checks a query by example for mistakes in expressing the criteria.
- value(String, String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching specified values.
- value(String, Boolean) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching specified value.
- value(String, Number...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching specified values.
- value(String, String[], double, String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching specified values.
- value(String, String[], double, Boolean) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching specified values.
- value(String, String[], double, Number...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching specified values.
- value(StructuredQueryBuilder.TextIndex, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or field that has a value with the same string value as at least one of the criteria values.
- value(StructuredQueryBuilder.TextIndex, Boolean) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a JSON property that has a value with the same boolean value as at least one of the criteria values.
- value(StructuredQueryBuilder.TextIndex, Number...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an JSON property that has a value with the same numeric value as at least one of the criteria values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or field that has a value with the same string value as at least one of the criteria values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, Boolean) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a JSON property that has a value with the same boolean value as at least one of the criteria values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, Number...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a JSON property that has a value with the same numeric value as at least one of the criteria values.
- valueConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it has a value with the same string value as at least one of the criteria values.
- valueConstraint(String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it has a value with the same string value as at least one of the criteria values.
- valueOf(String) - Static method in enum com.marklogic.client.admin.ExtensionMetadata.ScriptLanguage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.MethodType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.Policy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.bitemporal.TemporalDocumentManager.ProtectionLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.DatabaseClientFactory.Authentication
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.datamovement.ApplyTransformListener.ApplyResult
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.datamovement.JobTicket.JobType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentManager.Metadata
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentPatchBuilder.PathLanguage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.DocumentWriteOperation.OperationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.document.XMLDocumentManager.DocumentRepair
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.eval.EvalResult.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.example.extension.BatchManager.OperationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.io.Format
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.pojo.annotation.PathIndexProperty.ScalarType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.pojo.PojoQueryBuilder.Operator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.QueryManager.QueryView
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.FragmentScope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.GeospatialOperator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Operator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Ordering
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.TemporalOperator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.ValuesDefinition.Direction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.query.ValuesDefinition.Frequency
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.row.RowManager.RowSetPart
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.row.RowManager.RowStructure
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.row.RowRecord.ColumnKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.semantics.Capability
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.semantics.RDFTypes
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.type.PlanTripleOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.marklogic.client.type.PlanValueOption
-
Returns the enum constant of this type with the specified name.
- valueOfUncased(String) - Static method in enum com.marklogic.client.DatabaseClientFactory.Authentication
-
Deprecated.
Returns the enumerated value for the case-insensitive name.
- ValueQueryDefinition - Interface in com.marklogic.client.query
-
ValueQueryDefinitions can be used in value queries.
- values() - Static method in enum com.marklogic.client.admin.ExtensionMetadata.ScriptLanguage
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.MethodType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.Policy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.bitemporal.TemporalDocumentManager.ProtectionLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.DatabaseClientFactory.Authentication
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.datamovement.ApplyTransformListener.ApplyResult
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.datamovement.JobTicket.JobType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentManager.Metadata
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentPatchBuilder.PathLanguage
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.DocumentWriteOperation.OperationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.document.XMLDocumentManager.DocumentRepair
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.eval.EvalResult.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.example.extension.BatchManager.OperationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.io.Format
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.pojo.annotation.PathIndexProperty.ScalarType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.pojo.PojoQueryBuilder.Operator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.QueryManager.QueryView
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values(ValuesDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially, previously saved query options.
- values(ValuesDefinition, T, long) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially, previously saved query options.
- values(ValuesDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially, previously saved query options.
- values(ValuesDefinition, T, long, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query criteria and, potentially, previously saved query options.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.FragmentScope
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.GeospatialOperator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Operator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Ordering
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.StructuredQueryBuilder.TemporalOperator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.ValuesDefinition.Direction
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.query.ValuesDefinition.Frequency
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.row.RowManager.RowSetPart
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.row.RowManager.RowStructure
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.row.RowRecord.ColumnKind
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.semantics.Capability
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.semantics.RDFTypes
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.type.PlanTripleOption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.marklogic.client.type.PlanValueOption
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Method in class com.marklogic.client.util.EditableNamespaceContext
-
Gets the list of URIs from the namespace bindings.
- values() - Method in class com.marklogic.client.util.RequestParameters
-
Returns a list of value lists.
- ValuesDefinition - Interface in com.marklogic.client.query
-
A ValuesDefinition represents a values query used to retreive values from the server.
- ValuesDefinition.Direction - Enum in com.marklogic.client.query
-
The possible directions.
- ValuesDefinition.Frequency - Enum in com.marklogic.client.query
-
The kinds of frequencies.
- ValuesHandle - Class in com.marklogic.client.io
-
A ValuesHandle represents a list of values or of tuples (combination of values for the same document) retrieved from the indexes.
- ValuesHandle() - Constructor for class com.marklogic.client.io.ValuesHandle
-
Zero-argument constructor.
- valuesList(ValuesListDefinition, T) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves the list of available named lexicon configurations from the values list definition and, potentially, previously saved query options.
- valuesList(ValuesListDefinition, T, Transaction) - Method in interface com.marklogic.client.query.QueryManager
-
Retrieves the list of available named lexicon configurations from the values list definition and, potentially, previously saved query options.
- ValuesListDefinition - Interface in com.marklogic.client.query
-
A ValuesListDefinition is the base type for a values or tuples list.
- ValuesListHandle - Class in com.marklogic.client.io
-
A ValuesListHandle represents a list of available named lexicon configurations from saved query options.
- ValuesListHandle() - Constructor for class com.marklogic.client.io.ValuesListHandle
-
The constructor.
- ValuesListReadHandle - Interface in com.marklogic.client.io.marker
-
A ValuesListReadHandle represents a list of sets of values read from the database.
- ValuesListResults - Interface in com.marklogic.client.query
-
A ValuesListResults represents the results of a values query.
- ValuesMetrics - Interface in com.marklogic.client.query
-
A SearchMetrics object represents the query metrics returned by a search.
- ValuesReadHandle - Interface in com.marklogic.client.io.marker
-
A ValuesReadHandle represents a set of values read from the database.
- ValuesResults - Interface in com.marklogic.client.query
-
ValuesResults represents one set of values from a values query.
- variance(XsDoubleSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sample variance of a sequence of values.
- varianceP(XsDoubleSeqExpr) - Method in interface com.marklogic.client.expression.MathExpr
-
Returns the population variance of a sequence of values.
- verify(String, String[], String[]) - Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.Builtin
-
- verify(String, String[], String[]) - Method in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
Checks during SSL authentication that a hostname matches the Common Name or “DNS” Subject alts from the SSL certificate presented by the server.
- viewCol(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies a column where the combination of view and column name is unique.
- viewCol(XsStringVal, XsStringVal) - Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies a column where the combination of view and column name is unique.
- wallclockToTimestamp(XsDateTimeExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Converts an xs:dateTime to a 64 bit timestamp value.
- warning(SAXParseException) - Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Ignores the warning.
- week(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
- weekday(ItemExpr) - Method in interface com.marklogic.client.expression.SqlExpr
-
- weekdayFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an xs:integer between 1 and 7, both inclusive, representing the weekday value in the localized value of arg.
- weekFromDate(XsDateExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
- WGS84 - Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to “wgs84”
- WGS84DOUBLE - Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to “wgs84/double”
- when(boolean, ItemExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function executes the specified expression if the specified condition is true for the row.
- when(XsBooleanExpr, ItemExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function executes the specified expression if the specified condition is true for the row.
- whereDistinct() - Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method removes duplicate rows from the row set.
- wipe(String, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Removes all the versions of the temporal document specified by the temporal document logical URI in the temporalCollection
- wipe(String, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Removes all the versions of the temporal document specified by the temporal document logical URI in the temporalCollection
- with(TagNode) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(File, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(InputStream, String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(Reader) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(String) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- with(URI) - Method in class com.marklogic.client.example.handle.URIHandle
-
- with(String) - Method in class com.marklogic.client.example.handle.URIHandle
-
- with(Document) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Assigns an XML document structure as the content and returns the handle.
- with(JsonElement) - Method in class com.marklogic.client.extra.gson.GSONHandle
-
Assigns a JSON tree as the content and returns the handle.
- with(Document) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Assigns an XML document structure as the content and returns the handle.
- with(Document) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
Assigns an XML document structure as the content and returns the handle.
- with(byte[]) - Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array as the content and returns the handle as a fluent convenience.
- with(Document) - Method in class com.marklogic.client.io.DOMHandle
-
Assigns a DOM document as the content and returns the handle as a fluent convenience.
- with(File) - Method in class com.marklogic.client.io.FileHandle
-
Assigns a file as the content and returns the handle as a fluent convenience.
- with(InputSource) - Method in class com.marklogic.client.io.InputSourceHandle
-
Assigns an input source as the content and returns the handle as a fluent convenience.
- with(InputStream) - Method in class com.marklogic.client.io.InputStreamHandle
-
Assigns an input stream as the content and returns the handle as a fluent convenience.
- with(T) - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Assigns a your custom POJO as the content and returns the handle.
- with(JsonNode) - Method in class com.marklogic.client.io.JacksonHandle
-
Assigns a JSON tree as the content and returns the handle.
- with(C) - Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure for the content and returns the handle as a fluent convenience.
- with(OutputStreamSender) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Assigns an output stream sender providing the callback that writes content to the database and returns the handle as a fluent convenience.
- with(Reader) - Method in class com.marklogic.client.io.ReaderHandle
-
Assigns a character reader as the content and returns the handle as a fluent convenience.
- with(Source) - Method in class com.marklogic.client.io.SourceHandle
-
Assigns a transform source that produces the content and returns the handle as a fluent convenience.
- with(String) - Method in class com.marklogic.client.io.StringHandle
-
Assigns a string as the content and returns the handle as a fluent convenience.
- with(XMLEventReader) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Assigns an event reader for the content and returns the handle as a fluent convenience.
- with(XMLStreamReader) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Assigns an stream reader for the content and returns the handle as a fluent convenience.
- withApplyResult(ApplyTransformListener.ApplyResult) - Method in class com.marklogic.client.datamovement.ApplyTransformListener
-
Whether to
REPLACE each document with the result of the transform, or run the transform with each document as input, but
IGNORE the result.
- withBatchSize(int) - Method in interface com.marklogic.client.datamovement.Batcher
-
The size of each batch (usually 50-500).
- withBatchSize(int) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the number of uris to retrieve per batch.
- withBatchSize(int) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the number of documents to send per batch.
- withBinding(String, String) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Bind a variable of type iri.
- withBinding(String, String, RDFTypes) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Bind a variable of specified type.
- withBinding(String, String, Locale) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Bind a variable of type
http://www.w3.org/1999/02/22-rdf-syntax-ns#langString with the specified
language tag.
- withBlackList(String...) - Method in class com.marklogic.client.datamovement.FilteredForestConfiguration
-
Add hosts to the list of black-listed hosts (hosts which the Batcher will not see when it calls listForests).
- withCollections(String...) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the collections to the current collections for the document.
- withConsistentSnapshot() - Method in class com.marklogic.client.datamovement.ExportListener
-
Specifies that documents should be retrieved as they were when this QueryBatcher job started.
- withConsistentSnapshot() - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Specifies that matching uris should be retrieved as they were when this QueryBatcher job started.
- withConstrainingQuery(QueryDefinition) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the search query used to constrain the set of documents included in the SPARQL query.
- withCriteria(String) - Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Sets the query criteria as a query string and returns the query definition as a fluent convenience.
- withCriteria(String) - Method in interface com.marklogic.client.query.StringQueryDefinition
-
Sets the query criteria as a query string and returns the query definition as a fluent convenience.
- withCriteria(String) - Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Sets the query criteria as a query string and returns the query definition as a fluent convenience.
- withDelete(String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withDirectory(String) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the directory that should prefix the document uri and returns the template object.
- withForestConfig(ForestConfiguration) - Method in interface com.marklogic.client.datamovement.Batcher
-
Updates the ForestConfiguration used by this job to spread the writes or reads.
- withForestConfig(ForestConfiguration) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
- withForestConfig(ForestConfiguration) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- withFormat(Format) - Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the format for a database document and returns the descriptor object
- withFormat(Format) - Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the format of the document and returns the template object.
- withFormat(Format) - Method in class com.marklogic.client.example.handle.URIHandle
-
- withFormat(Format) - Method in class com.marklogic.client.io.BytesHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.FileHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.InputStreamHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.JacksonHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.JacksonParserHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.ReaderHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.SearchHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.StringHandle
-
Specifies the format of the content and returns the handle as a fluent convenience.
- withFormat(Format) - Method in class com.marklogic.client.io.TuplesHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.ValuesHandle
-
Fluent setter for the format associated with this handle.
- withFormat(Format) - Method in class com.marklogic.client.io.ValuesListHandle
-
Fluent setter for the format associated with this handle.
- withHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawCombinedQueryDefinition
-
Specifies the handle for the JSON or XML representation of a combined query and returns the query definition.
- withHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawQueryByExampleDefinition
-
Specifies the handle for the JSON or XML representation of a query by example and returns the query definition.
- withHandle(StructureWriteHandle) - Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Specifies the handle for the JSON or XML representation of a structured query and returns the query definition.
- withHandle(JSONWriteHandle) - Method in interface com.marklogic.client.row.RawPlanDefinition
-
Assigns the handle and returns the raw plan as a convenience.
- withHostUnavailableExceptions(Class<Throwable>...) - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
Overwrites the list of exceptions for which a host will be blacklisted
- withIncludeDefaultRulesets(Boolean) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set whether to include database-default inference or not.
- withJobName(String) - Method in interface com.marklogic.client.datamovement.Batcher
-
Sets the name of the job to help with managing multiple concurrent jobs.
- withJobName(String) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the job name.
- withJobName(String) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the job name.
- withMetadataCategory(DocumentManager.Metadata) - Method in class com.marklogic.client.datamovement.ExportListener
-
Adds a metadata category to retrieve and make available from
DocumentRecord.getMetadata to listeners registered with onDocumentReady.
- withMetadataCategory(DocumentManager.Metadata) - Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
Adds a metadata category to retrieve with each document.
- withMetadataValue(String, String) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the metadata-value to the current metadata-values for the document.
- withMimetype(String) - Method in class com.marklogic.client.io.BytesHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.DOMHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.FileHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.InputStreamHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.JAXBHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.ReaderHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.SourceHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.StringHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMimetype(String) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the mime type of the content and returns the handle as a fluent convenience.
- withMinHosts(int) - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
If less than minHosts are left, calls stopJob.
- withNonDocumentFormat(Format) - Method in class com.marklogic.client.datamovement.ExportListener
-
- withNonDocumentFormat(Format) - Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
The format for the metadata retrieved with each document.
- withPermission(String, DocumentMetadataHandle.Capability...) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the role and its capabilities to the current permissions for the document.
- withProperty(QName, Object) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the property name and value to the current properties for the document.
- withProperty(String, Object) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the property name and value to the current properties for the document.
- withQuality(int) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally specifies the match quality for the document.
- withRead(String, String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withRead(String, DocumentManager.Metadata, String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withRead(String, Set<DocumentManager.Metadata>, String) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withRecordPrefix(String) - Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
Sets the string prefix to send to the writer before each record.
- withRecordPrefix(String) - Method in class com.marklogic.client.datamovement.UrisToWriterListener
-
- withRecordSuffix(String) - Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
Sets the string suffix to append to the writer after each record.
- withRecordSuffix(String) - Method in class com.marklogic.client.datamovement.UrisToWriterListener
-
- withRenamedHost(String, String) - Method in class com.marklogic.client.datamovement.FilteredForestConfiguration
-
Rename hosts to network-addressable names rather than the host names known to the MarkLogic cluster.
- withResendable(boolean) - Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies whether the content can be resent to the output stream and returns the handle as a fluent convenience.
- withRuleset(SPARQLRuleset) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the name of rulesets to include for inferring triples.
- withSparql(String) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- withSparql(TextWriteHandle) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- withSSLContext(SSLContext) - Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- withSSLContext(SSLContext) - Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- withSSLContext(SSLContext) - Method in class com.marklogic.client.DatabaseClientFactory.KerberosAuthContext
-
- withSSLContext(SSLContext) - Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in class com.marklogic.client.DatabaseClientFactory.KerberosAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier) - Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- withSuspendTimeForHostUnavailable(Duration) - Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
If a host becomes unavailable (NoHttpResponseException, SocketException, SSLException, UnknownHostException), adds it to the blacklist
- withTemporalCollection(String) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
The temporal collection to use for a temporal document insert
- withThreadCount(int) - Method in interface com.marklogic.client.datamovement.Batcher
-
The number of threads to be used internally by this job to perform concurrent tasks on batches (usually > 10).
- withThreadCount(int) - Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the number of threads added to the internal thread pool for this instance to use for retrieving or processing batches of uris.
- withThreadCount(int) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the number of threads added to the internal thread pool for this instance to use for writing or reporting on batches of uris.
- withTransform(ServerTransform) - Method in class com.marklogic.client.datamovement.ApplyTransformListener
-
The ServerTransform to run on each document from each batch.
- withTransform(ServerTransform) - Method in class com.marklogic.client.datamovement.ExportListener
-
Sets the server tranform to modify the document contents.
- withTransform(ServerTransform) - Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
- withTransform(ServerTransform) - Method in interface com.marklogic.client.datamovement.WriteBatcher
-
The ServerTransform to modify each document from each batch before it is written to the database.
- withTransformer(Transformer) - Method in class com.marklogic.client.io.SourceHandle
-
Specifies a transformer for modifying the content and returns the handle as a fluent convenience.
- withUpdatePermission(String, Capability) - Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- withWhiteList(String...) - Method in class com.marklogic.client.datamovement.FilteredForestConfiguration
-
Add hosts to a white-list.
- withWrite(String, AbstractWriteHandle) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- withWrite(String, DocumentMetadataHandle, AbstractWriteHandle) - Method in class com.marklogic.client.example.extension.BatchManager.BatchRequest
-
- word(String, String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties with at least one of the specified words or phrases.
- word(String, String[], double, String...) - Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties with at least one of the specified words or phrases.
- word(StructuredQueryBuilder.TextIndex, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or field that has at least one of the criteria words.
- word(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or field that has at least one of the criteria words.
- wordConstraint(String, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it has at least one of the criteria words.
- wordConstraint(String, double, String...) - Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the constraint when it has at least one of the criteria words.
- wordQuery(String) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase.
- wordQuery(XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase.
- wordQuery(String, String...) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase.
- wordQuery(XsStringSeqVal, XsStringSeqVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase.
- wordQuery(String, String, double) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase.
- wordQuery(XsStringSeqVal, XsStringSeqVal, XsDoubleVal) - Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing a given phrase.
- write(String, AbstractWriteHandle) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server.
- write(ExtensionLibraryDescriptor, AbstractWriteHandle) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server.
- write(OutputStream) - Method in class com.marklogic.client.alerting.RuleDefinition
-
Writes a serialized RuleDefinition to an OutputStream as XML.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write but write document at a specific system time
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write but write document at a specific system time
- write(DocumentWriteSet, ServerTransform, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- write(DocumentDescriptor, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the URI in the Document descriptor
- write(String, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the docId passed.
- write(String, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write but writes document at a specific system time
- write(DocumentDescriptor, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar) - Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write but writes document at a specific system time
- write(DocumentWriteSet) - Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the server via REST API bulk capabilities.
- write(DocumentWriteSet, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the server via REST API bulk capabilities.
- write(DocumentWriteSet, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the server via REST API bulk capabilities.
- write(DocumentWriteSet, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the server via REST API bulk capabilities.
- write(String, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from the representation provided by the handle
- write(String, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database as transformed on the server.
- write(DocumentDescriptor, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from the representation provided by the handle
- write(DocumentDescriptor, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database as transformed on the server.
- write(String, DocumentMetadataWriteHandle, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database from the representations provided by the handles
- write(String, DocumentMetadataWriteHandle, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database as transformed on the server.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database from the representations provided by the handles
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the database as transformed on the server.
- write(String, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction from the representation provided by the handle
- write(String, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction as transformed on the server.
- write(DocumentDescriptor, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction from the representation provided by the handle
- write(DocumentDescriptor, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database transaction as transformed on the server.
- write(String, DocumentMetadataWriteHandle, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction from the representations provided by the handles
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction as transformed on the server.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction from the representations provided by the handles
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an open database transaction as transformed on the server.
- write(Reader) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, QName) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, String) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, QName) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, String, QName...) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(Reader, String, QName, QName...) - Method in class com.marklogic.client.example.extension.OpenCSVBatcher
-
- write(OutputStream) - Method in class com.marklogic.client.example.handle.HTMLCleanerHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.extra.xom.XOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.DOMHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.InputSourceHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.JacksonHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.JacksonParserHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.JAXBHandle
-
- write(OutputStream) - Method in interface com.marklogic.client.io.OutputStreamSender
-
Implements a callback to write content to the provided output stream for sending to the database server.
- write(OutputStream) - Method in class com.marklogic.client.io.ReaderHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.SourceHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.StringHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- write(OutputStream) - Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- write(T) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Write this instance to the database.
- write(T, String...) - Method in interface com.marklogic.client.pojo.PojoRepository
-
Does everything in
write(T) but also adds your collections to the persisted instance.
- write(T, Transaction) - Method in interface com.marklogic.client.pojo.PojoRepository
-
- write(T, Transaction, String...) - Method in interface com.marklogic.client.pojo.PojoRepository
-
- write(String, TriplesWriteHandle) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle as the
specified graph.
- write(String, TriplesWriteHandle, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle as the
specified graph.
- write(String, TriplesWriteHandle, GraphPermissions) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle and specified permissions as the
specified graph.
- write(String, TriplesWriteHandle, GraphPermissions, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle and specified permissions as the
specified graph.
- WriteandReadPOJOs - Class in com.marklogic.client.example.cookbook.datamovement
-
WriteandReadPOJOS illustrates how to write bulk POJOs into the database using WriteBatcher.
- WriteandReadPOJOs() - Constructor for class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- WriteandReadPOJOs.ProductDetails - Class in com.marklogic.client.example.cookbook.datamovement
-
A sample class which we will be using in order to demonstrate reading and writing large number of POJOs
- writeAs(String, Object) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server as an object of an IO class.
- writeAs(ExtensionLibraryDescriptor, Object) - Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided path on the REST server as an object of an IO class.
- writeAs(String, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, DocumentMetadataWriteHandle, Object) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, DocumentMetadataWriteHandle, Object, ServerTransform) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from an object of an IO class.
- writeAs(String, Object) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object as the specified graph.
- writeAs(String, Object, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object as the specified graph.
- writeAs(String, Object, GraphPermissions) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object and specified
permissions as the specified graph.
- writeAs(String, Object, GraphPermissions, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object and specified
permissions as the specified graph.
- WriteBatch - Interface in com.marklogic.client.datamovement
-
A batch of documents written successfully.
- WriteBatcher - Interface in com.marklogic.client.datamovement
-
To facilitate long-running write jobs, batches documents added by many external threads and coordinates internal threads to send the batches round-robin to all appropriate hosts in the cluster.
- WriteBatchListener - Interface in com.marklogic.client.datamovement
-
Runs processEvent on each batch as it is ready during a WriteBatcher job.
- writeBulkPOJOS() - Method in class com.marklogic.client.example.cookbook.datamovement.WriteandReadPOJOs
-
- writeConfiguration() - Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Writes the values of the properties of this object to the server.
- writeDefaultMetadata(String) - Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in the database to the defaults
- writeDefaultMetadata(String, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in an open database transaction to the defaults
- writeDocument(String, int, String, String, DatabaseClientFactory.Authentication) - Static method in class com.marklogic.client.example.cookbook.DocumentWriteTransform
-
- WriteEvent - Interface in com.marklogic.client.datamovement
-
Each WriteBatch is composed of many WriteEvents, each of which represents all the information about a single document which was written to the server.
- WriteFailureListener - Interface in com.marklogic.client.datamovement
-
The listener interface for handling exceptions occurring withing WriteBatcher.
- writeJavascriptTransform(String, TextWriteHandle) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in Javascript.
- writeJavascriptTransform(String, TextWriteHandle, ExtensionMetadata) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in Javascript.
- writeJavascriptTransformAs(String, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
- writeJavascriptTransformAs(String, ExtensionMetadata, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in Javascript in a textual representation provided as an object of an IO class.
- writeMetadata(String, DocumentMetadataWriteHandle) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata to the database from the representation provided by the handle
- writeMetadata(String, DocumentMetadataWriteHandle, Transaction) - Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata to an open database transaction from the representation provided by the handle
- writeOptions(String, QueryOptionsWriteHandle) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Write a named QueryOptions configuration to the REST server.
- writeOptionsAs(String, Format, Object) - Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Write a named QueryOptions configuration to the REST server in a JSON or XML representation provided as an object of an IO class.
- writePermissions(String, GraphPermissions) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite all permissions for the graph.
- writePermissions(String, GraphPermissions, Transaction) - Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite all permissions for the graph.
- writeReadDeleteDocument(DatabaseClient, String, String) - Static method in class com.marklogic.client.example.cookbook.DocumentFormats
-
- writerPassword - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- writeRule(RuleDefinition) - Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server from the provided handle.
- writeRule(String, RuleWriteHandle) - Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server from the provided handle.
- writeRuleAs(String, Object) - Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server in an XML representation provided as an object of an IO class.
- writerUser - Variable in class com.marklogic.client.example.cookbook.Util.ExampleProperties
-
- writeServices(String, TextWriteHandle, ExtensionMetadata, ResourceExtensionsManager.MethodParameters...) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Installs the services that implement a resource.
- writeServicesAs(String, Object, ExtensionMetadata, ResourceExtensionsManager.MethodParameters...) - Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Installs the services that implement a resource in a textual representation provided as an object of an IO class.
- writeXQueryTransform(String, TextWriteHandle) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery.
- writeXQueryTransform(String, TextWriteHandle, ExtensionMetadata) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery.
- writeXQueryTransformAs(String, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
- writeXQueryTransformAs(String, ExtensionMetadata, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
- writeXSLTransform(String, XMLWriteHandle) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL.
- writeXSLTransform(String, XMLWriteHandle, ExtensionMetadata) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL.
- writeXSLTransformAs(String, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL in an XML representation provided as an object of an IO class.
- writeXSLTransformAs(String, ExtensionMetadata, Object) - Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL in an XML representation provided as an object of an IO class.
- xdmp - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with xdmp server functions.
- XdmpExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the xdmp server library for a row pipeline.
- xmlAttribute(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
- xmlAttribute(XsQNameExpr, XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
- xmlAttributeSeq(AttributeNodeExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
- xmlComment(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML comment with the atomic value.
- xmlComment(XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML comment with the atomic value.
- XmlContentNodeExpr - Interface in com.marklogic.client.type
-
An instance of an XML comment, element, processing-instruction, or text node expression.
- XmlContentNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of XML comment, element, processing-instruction, or text node expressions.
- xmlDocument(XmlRootNodeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML document with the root content, which must be exactly one node.
- XMLDocumentManager - Interface in com.marklogic.client.document
-
A XML Document Manager supports database operations on XML documents.
- XMLDocumentManager.DocumentRepair - Enum in com.marklogic.client.document
-
The DocumentRepair enumeration specifies whether an XML document is repaired as much as possible or not at all.
- xmlElement(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
- xmlElement(XsQNameExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
- xmlElement(String, AttributeNodeExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
- xmlElement(XsQNameExpr, AttributeNodeSeqExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
- xmlElement(String, AttributeNodeSeqExpr, XmlContentNodeExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
- xmlElement(XsQNameExpr, AttributeNodeSeqExpr, XmlContentNodeExpr...) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
- XMLEventReaderHandle - Class in com.marklogic.client.io
-
An XML Event Reader Handle represents XML content as an XML event reader
for reading as a series of StAX events.
- XMLEventReaderHandle() - Constructor for class com.marklogic.client.io.XMLEventReaderHandle
-
Zero-argument constructor.
- XMLEventReaderHandle(XMLEventReader) - Constructor for class com.marklogic.client.io.XMLEventReaderHandle
-
Initializes the handle with a StAX event reader for the content.
- xmlPi(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML processing instruction with the atomic value.
- xmlPi(XsStringExpr, XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML processing instruction with the atomic value.
- XMLReadHandle - Interface in com.marklogic.client.io.marker
-
A XML Read Handle can represent XML content read from the database.
- XmlRootNodeExpr - Interface in com.marklogic.client.type
-
An instance of an XML comment, element, or processing-instruction node expression.
- XmlRootNodeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of XML comment, element, or processing-instruction node expressions.
- XMLStreamReaderHandle - Class in com.marklogic.client.io
-
An XML Stream Reader Handle represents XML content as an XML stream reader
for reading as a StAX pull stream.
- XMLStreamReaderHandle() - Constructor for class com.marklogic.client.io.XMLStreamReaderHandle
-
Zero-argument constructor.
- XMLStreamReaderHandle(XMLStreamReader) - Constructor for class com.marklogic.client.io.XMLStreamReaderHandle
-
Initializes the handle with a StAX stream reader for the content.
- xmlText(String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML text node with the specified value.
- xmlText(XsAnyAtomicTypeExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an XML text node with the specified value.
- XMLWriteHandle - Interface in com.marklogic.client.io.marker
-
A XML Write Handle can represent XML content written to the database.
- XOMHandle - Class in com.marklogic.client.extra.xom
-
A XOM Handle represents XML content as a XOM document for reading or writing.
- XOMHandle() - Constructor for class com.marklogic.client.extra.xom.XOMHandle
-
Zero-argument constructor.
- XOMHandle(Document) - Constructor for class com.marklogic.client.extra.xom.XOMHandle
-
Provides a handle on XML content as a XOM document structure.
- XOMHandleExample - Class in com.marklogic.client.example.handle
-
XOMHandleExample illustrates writing and reading content as a XOM structure using the XOM extra library.
- XOMHandleExample() - Constructor for class com.marklogic.client.example.handle.XOMHandleExample
-
- xor64(XsUnsignedLongExpr, XsUnsignedLongExpr) - Method in interface com.marklogic.client.expression.XdmpExpr
-
XOR two 64-bit integer values.
- xpath(String, String) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function extracts a sequence of child nodes from a column with node values – especially, the document nodes from a document join.
- xpath(PlanColumn, XsStringExpr) - Method in class com.marklogic.client.expression.PlanBuilder
-
This function extracts a sequence of child nodes from a column with node values – especially, the document nodes from a document join.
- XQUERY - Static variable in class com.marklogic.client.admin.ExtensionMetadata
-
Convenience constant to provide something shorter than ExtensionMetadata.ScriptLanguage.XQUERY
- xquery(String) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side eval with xquery-syntax source code.
- xquery(TextWriteHandle) - Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side eval with xquery-syntax source code.
- xs - Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with xs server functions.
- XsAnyAtomicTypeExpr - Interface in com.marklogic.client.type
-
An instance of a server atomic expression.
- XsAnyAtomicTypeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server atomic expressions.
- XsAnyAtomicTypeSeqVal - Interface in com.marklogic.client.type
-
A sequence of server atomic values.
- XsAnyAtomicTypeVal - Interface in com.marklogic.client.type
-
An instance of a server atomic value.
- XsAnySimpleTypeExpr - Interface in com.marklogic.client.type
-
An instance of a server simple expression.
- XsAnySimpleTypeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server simple expressions.
- XsAnySimpleTypeSeqVal - Interface in com.marklogic.client.type
-
A sequence of server simple values.
- XsAnySimpleTypeVal - Interface in com.marklogic.client.type
-
An instance of a server simple value.
- XsAnyURIExpr - Interface in com.marklogic.client.type
-
An instance of a server URI expression.
- XsAnyURISeqExpr - Interface in com.marklogic.client.type
-
A sequence of server URI expressions.
- XsAnyURISeqVal - Interface in com.marklogic.client.type
-
A sequence of server URI values.
- XsAnyURIVal - Interface in com.marklogic.client.type
-
An instance of a server URI value.
- XsBase64BinaryExpr - Interface in com.marklogic.client.type
-
An instance of a server base 64 binary expression.
- XsBase64BinarySeqExpr - Interface in com.marklogic.client.type
-
A sequence of server base 64 binary expressions.
- XsBase64BinarySeqVal - Interface in com.marklogic.client.type
-
A sequence of server base 64 binary values.
- XsBase64BinaryVal - Interface in com.marklogic.client.type
-
An instance of a server base 64 binary value.
- XsBooleanExpr - Interface in com.marklogic.client.type
-
An instance of a server boolean expression.
- XsBooleanSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server boolean expressions.
- XsBooleanSeqVal - Interface in com.marklogic.client.type
-
A sequence of server boolean values.
- XsBooleanVal - Interface in com.marklogic.client.type
-
An instance of a server boolean value.
- XsByteExpr - Interface in com.marklogic.client.type
-
An instance of a server byte expression.
- XsByteSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server byte expressions.
- XsByteSeqVal - Interface in com.marklogic.client.type
-
A sequence of server byte values.
- XsByteVal - Interface in com.marklogic.client.type
-
An instance of a server byte value.
- XsDateExpr - Interface in com.marklogic.client.type
-
An instance of a server date expression.
- XsDateSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server date expressions.
- XsDateSeqVal - Interface in com.marklogic.client.type
-
A sequence of server date values.
- XsDateTimeExpr - Interface in com.marklogic.client.type
-
An instance of a server datetime expression.
- XsDateTimeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server datetime expressions.
- XsDateTimeSeqVal - Interface in com.marklogic.client.type
-
A sequence of server datetime values.
- XsDateTimeVal - Interface in com.marklogic.client.type
-
An instance of a server datetime value.
- XsDateVal - Interface in com.marklogic.client.type
-
An instance of a server date value.
- XsDayTimeDurationExpr - Interface in com.marklogic.client.type
-
An instance of a server day-time duration expression.
- XsDayTimeDurationSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server day-time duration expressions.
- XsDayTimeDurationSeqVal - Interface in com.marklogic.client.type
-
A sequence of server day-time duration values.
- XsDayTimeDurationVal - Interface in com.marklogic.client.type
-
An instance of a server day-time duration value.
- XsDecimalExpr - Interface in com.marklogic.client.type
-
An instance of a server decimal expression.
- XsDecimalSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server decimal expressions.
- XsDecimalSeqVal - Interface in com.marklogic.client.type
-
A sequence of server decimal values.
- XsDecimalVal - Interface in com.marklogic.client.type
-
An instance of a server decimal value.
- XsDoubleExpr - Interface in com.marklogic.client.type
-
An instance of a server double expression.
- XsDoubleSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server double expressions.
- XsDoubleSeqVal - Interface in com.marklogic.client.type
-
A sequence of server double values.
- XsDoubleVal - Interface in com.marklogic.client.type
-
An instance of a server double value.
- XsDurationExpr - Interface in com.marklogic.client.type
-
An instance of a server duration expression.
- XsDurationSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server duration expressions.
- XsDurationSeqVal - Interface in com.marklogic.client.type
-
A sequence of server duration values.
- XsDurationVal - Interface in com.marklogic.client.type
-
An instance of a server duration value.
- XsExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the xs server library for a row pipeline and constructs client values with xs.* server types.
- XsFloatExpr - Interface in com.marklogic.client.type
-
An instance of a server float expression.
- XsFloatSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server float expressions.
- XsFloatSeqVal - Interface in com.marklogic.client.type
-
A sequence of server float values.
- XsFloatVal - Interface in com.marklogic.client.type
-
An instance of a server float value.
- XsGDayExpr - Interface in com.marklogic.client.type
-
An instance of a server GDay expression.
- XsGDaySeqExpr - Interface in com.marklogic.client.type
-
A sequence of server GDay expressions.
- XsGDaySeqVal - Interface in com.marklogic.client.type
-
A sequence of server GDay values.
- XsGDayVal - Interface in com.marklogic.client.type
-
An instance of a server GDay value.
- XsGMonthDayExpr - Interface in com.marklogic.client.type
-
An instance of a server GMonthDay expression.
- XsGMonthDaySeqExpr - Interface in com.marklogic.client.type
-
A sequence of server GMonthDay expressions.
- XsGMonthDaySeqVal - Interface in com.marklogic.client.type
-
A sequence of server GMonthDay values.
- XsGMonthDayVal - Interface in com.marklogic.client.type
-
An instance of a server GMonthDay value.
- XsGMonthExpr - Interface in com.marklogic.client.type
-
An instance of a server GMonth expression.
- XsGMonthSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server GMonth expressions.
- XsGMonthSeqVal - Interface in com.marklogic.client.type
-
A sequence of server GMonth values.
- XsGMonthVal - Interface in com.marklogic.client.type
-
An instance of a server GMonth value.
- XsGYearExpr - Interface in com.marklogic.client.type
-
An instance of a server GYear expression.
- XsGYearMonthExpr - Interface in com.marklogic.client.type
-
An instance of a server GYearMonth expression.
- XsGYearMonthSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server GYearMonth expressions.
- XsGYearMonthSeqVal - Interface in com.marklogic.client.type
-
A sequence of server GYearMonth values.
- XsGYearMonthVal - Interface in com.marklogic.client.type
-
An instance of a server GYearMonth value.
- XsGYearSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server GYear expressions.
- XsGYearSeqVal - Interface in com.marklogic.client.type
-
A sequence of server GYear values.
- XsGYearVal - Interface in com.marklogic.client.type
-
An instance of a server GYear value.
- XsHexBinaryExpr - Interface in com.marklogic.client.type
-
An instance of a server hex binary expression.
- XsHexBinarySeqExpr - Interface in com.marklogic.client.type
-
A sequence of server hex binary expressions.
- XsHexBinarySeqVal - Interface in com.marklogic.client.type
-
A sequence of server hex binary values.
- XsHexBinaryVal - Interface in com.marklogic.client.type
-
An instance of a server hex binary value.
- XsIntegerExpr - Interface in com.marklogic.client.type
-
An instance of a server integer expression.
- XsIntegerSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server integer expressions.
- XsIntegerSeqVal - Interface in com.marklogic.client.type
-
A sequence of server integer values.
- XsIntegerVal - Interface in com.marklogic.client.type
-
An instance of a server integer value.
- XsIntExpr - Interface in com.marklogic.client.type
-
An instance of a server int expression.
- XsIntSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server int expressions.
- XsIntSeqVal - Interface in com.marklogic.client.type
-
A sequence of server int values.
- XsIntVal - Interface in com.marklogic.client.type
-
An instance of a server int value.
- XsLanguageExpr - Interface in com.marklogic.client.type
-
An instance of a server language expression.
- XsLanguageSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server language expressions.
- XsLongExpr - Interface in com.marklogic.client.type
-
An instance of a server long expression.
- XsLongSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server long expressions.
- XsLongSeqVal - Interface in com.marklogic.client.type
-
A sequence of server long values.
- XsLongVal - Interface in com.marklogic.client.type
-
An instance of a server long value.
- XsNameExpr - Interface in com.marklogic.client.type
-
An instance of a server name expression.
- XsNameSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server name expressions.
- XsNCNameExpr - Interface in com.marklogic.client.type
-
An instance of a server NCName expression.
- XsNCNameSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server NCName expressions.
- XsNegativeIntegerExpr - Interface in com.marklogic.client.type
-
An instance of a server negative integer expression.
- XsNegativeIntegerSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server negative integer expressions.
- XsNMTOKENExpr - Interface in com.marklogic.client.type
-
An instance of a server name token expression.
- XsNMTOKENSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server name token expressions.
- XsNonNegativeIntegerExpr - Interface in com.marklogic.client.type
-
An instance of a server non-negative integer expression.
- XsNonNegativeIntegerSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server non-negative integer expressions.
- XsNonNegativeIntegerSeqVal - Interface in com.marklogic.client.type
-
A sequence of non-negative integer values.
- XsNonNegativeIntegerVal - Interface in com.marklogic.client.type
-
An instance of a server non-negative integer value.
- XsNonPositiveIntegerExpr - Interface in com.marklogic.client.type
-
An instance of a server non-positive integer expression.
- XsNonPositiveIntegerSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server non-positive integer expressions.
- XsNormalizedStringExpr - Interface in com.marklogic.client.type
-
An instance of a server normalized string expression.
- XsNormalizedStringSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server normalized string expressions.
- XsNumericExpr - Interface in com.marklogic.client.type
-
An instance of a server numeric expression.
- XsNumericSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server numeric expressions.
- XsNumericSeqVal - Interface in com.marklogic.client.type
-
A sequence of server numeric values.
- XsNumericVal - Interface in com.marklogic.client.type
-
An instance of a server numeric value.
- XsPositiveIntegerExpr - Interface in com.marklogic.client.type
-
An instance of a server positive integer expression.
- XsPositiveIntegerSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server positive integer expressions.
- XsQNameExpr - Interface in com.marklogic.client.type
-
An instance of a server qualified name expression.
- XsQNameSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server qualified name expressions.
- XsQNameSeqVal - Interface in com.marklogic.client.type
-
A sequence of server qualified name values.
- XsQNameVal - Interface in com.marklogic.client.type
-
An instance of a server qualified name value.
- XsShortExpr - Interface in com.marklogic.client.type
-
An instance of a server short expression.
- XsShortSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server short expressions.
- XsShortSeqVal - Interface in com.marklogic.client.type
-
A sequence of server short values.
- XsShortVal - Interface in com.marklogic.client.type
-
An instance of a server short value.
- XsStringExpr - Interface in com.marklogic.client.type
-
An instance of a server string expression.
- XsStringSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server string expressions.
- XsStringSeqVal - Interface in com.marklogic.client.type
-
A sequence of server string values.
- XsStringVal - Interface in com.marklogic.client.type
-
An instance of a server string value.
- XsTimeExpr - Interface in com.marklogic.client.type
-
An instance of a server time expression.
- XsTimeSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server time expressions.
- XsTimeSeqVal - Interface in com.marklogic.client.type
-
A sequence of server time values.
- XsTimeVal - Interface in com.marklogic.client.type
-
An instance of a server time value.
- XsTokenExpr - Interface in com.marklogic.client.type
-
An instance of a server token expression.
- XsTokenSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server token expressions.
- XsUnsignedByteExpr - Interface in com.marklogic.client.type
-
An instance of a server unsigned byte expression.
- XsUnsignedByteSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server unsigned byte expressions.
- XsUnsignedByteSeqVal - Interface in com.marklogic.client.type
-
A sequence of server unsigned byte values.
- XsUnsignedByteVal - Interface in com.marklogic.client.type
-
An instance of a server unsigned byte value.
- XsUnsignedIntExpr - Interface in com.marklogic.client.type
-
An instance of a server unsigned int expression.
- XsUnsignedIntSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server unsigned int expressions.
- XsUnsignedIntSeqVal - Interface in com.marklogic.client.type
-
A sequence of server unsigned int values.
- XsUnsignedIntVal - Interface in com.marklogic.client.type
-
An instance of a server unsigned int value.
- XsUnsignedLongExpr - Interface in com.marklogic.client.type
-
An instance of a server unsigned long expression.
- XsUnsignedLongSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server unsigned long expressions.
- XsUnsignedLongSeqVal - Interface in com.marklogic.client.type
-
A sequence of server unsigned long values.
- XsUnsignedLongVal - Interface in com.marklogic.client.type
-
An instance of a server unsigned long value.
- XsUnsignedShortExpr - Interface in com.marklogic.client.type
-
An instance of a server unsigned short expression.
- XsUnsignedShortSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server unsigned short expressions.
- XsUnsignedShortSeqVal - Interface in com.marklogic.client.type
-
A sequence of server unsigned short values.
- XsUnsignedShortVal - Interface in com.marklogic.client.type
-
An instance of a server unsigned short value.
- XsUntypedAtomicExpr - Interface in com.marklogic.client.type
-
An instance of a server untyped atomic expression.
- XsUntypedAtomicSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server untyped atomic expressions.
- XsUntypedAtomicSeqVal - Interface in com.marklogic.client.type
-
A sequence of server untyped atomic values.
- XsUntypedAtomicVal - Interface in com.marklogic.client.type
-
An instance of a server untyped atomic value.
- XsValue - Interface in com.marklogic.client.expression
-
XsValue takes Java values and constructs atomic values and sequences of atomic values with an xs schema data type
- XsYearMonthDurationExpr - Interface in com.marklogic.client.type
-
An instance of a server year-month duration expression.
- XsYearMonthDurationSeqExpr - Interface in com.marklogic.client.type
-
A sequence of server year-month duration expressions.
- XsYearMonthDurationSeqVal - Interface in com.marklogic.client.type
-
A sequence of server year-month duration values.
- XsYearMonthDurationVal - Interface in com.marklogic.client.type
-
An instance of a server year-month duration value.