XCC/J 3.2-9
A B C D E F G H I L M N O P Q R S T U V W X

A

AUTO_RETRY_DELAY_SYSTEM_PROPERTY - Static variable in class com.marklogic.xcc.RequestOptions
The system property name (xcc.request.retries.delay) which, if set, specifies the default delay (in milliseconds) between automatic request retries.
AdhocQuery - interface com.marklogic.xcc.AdhocQuery.
A specialization of Request which contains an ad-hoc query (XQuery code as a literal String) to be submitted and evaluated by the MarkLogic Server.
AtomicType - class com.marklogic.xcc.types.AtomicType.
Base class for type-safe enumeration instances that represent atomic types.
applyEffectiveValues(RequestOptions[]) - Method in class com.marklogic.xcc.RequestOptions
Set the option values of this object to the effective values obtained by merging each of the RequestOption objects in the array.
asBigDecimal() - Method in interface com.marklogic.xcc.types.XSDecimal
 
asBigDecimal() - Method in interface com.marklogic.xcc.types.XSDouble
The item's value as a BigDecimal.
asBigDecimal() - Method in interface com.marklogic.xcc.types.XSFloat
The item's value as a BigDecimal.
asBigInteger() - Method in interface com.marklogic.xcc.types.XSInteger
 
asBinaryData() - Method in interface com.marklogic.xcc.types.XSBase64Binary
 
asBinaryData() - Method in interface com.marklogic.xcc.types.XSHexBinary
 
asBinaryData() - Method in interface com.marklogic.xcc.types.XdmBinary
Buffers the binary() item from the server and converts it to a Java byte array.
asBoolean() - Method in interface com.marklogic.xcc.types.XSBoolean
 
asDate() - Method in interface com.marklogic.xcc.types.XSDate
 
asDate() - Method in interface com.marklogic.xcc.types.XSDateTime
 
asDate() - Method in interface com.marklogic.xcc.types.XSTime
 
asDouble() - Method in interface com.marklogic.xcc.types.XSDouble
The item's value as a Double.
asDuration() - Method in interface com.marklogic.xcc.types.XSDuration
 
asFloat() - Method in interface com.marklogic.xcc.types.XSFloat
The item's value as a Float.
asGregorianCalendar() - Method in interface com.marklogic.xcc.types.XSGDay
 
asGregorianCalendar() - Method in interface com.marklogic.xcc.types.XSGMonth
 
asGregorianCalendar() - Method in interface com.marklogic.xcc.types.XSGMonthDay
 
asGregorianCalendar() - Method in interface com.marklogic.xcc.types.XSGYear
 
asGregorianCalendar() - Method in interface com.marklogic.xcc.types.XSGYearMonth
 
asInputStream() - Method in interface com.marklogic.xcc.types.XdmItem
Return a java.io.InputStream for this item.
asInteger() - Method in interface com.marklogic.xcc.types.XSInteger
 
asLong() - Method in interface com.marklogic.xcc.types.XSInteger
 
asPrimitiveBoolean() - Method in interface com.marklogic.xcc.types.XSBoolean
 
asPrimitiveDouble() - Method in interface com.marklogic.xcc.types.XSDouble
The item's value as a primitive double value.
asPrimitiveFloat() - Method in interface com.marklogic.xcc.types.XSFloat
The item's value as a primitive float value.
asPrimitiveInt() - Method in interface com.marklogic.xcc.types.XSInteger
 
asPrimitiveLong() - Method in interface com.marklogic.xcc.types.XSInteger
 
asReader() - Method in interface com.marklogic.xcc.types.XdmItem
Return a java.io.Reader for this item.
asString(String) - Method in interface com.marklogic.xcc.types.XdmSequence
Returns a String comprised of XdmValue.asString() value of each item in the sequence with the given separator string between each.
asString() - Method in interface com.marklogic.xcc.types.XdmSequence
This method is equivalent to asString ("\n").
asString() - Method in interface com.marklogic.xcc.types.XdmValue
Return a String representation of this item, if possible.
asStrings() - Method in interface com.marklogic.xcc.types.XdmSequence
Returns an array of Strings, each of which is the value returned by the XdmValue.asString() method for each item in the sequence.
asUri() - Method in interface com.marklogic.xcc.types.XSAnyURI
 
asW3cDocument(DocumentBuilder) - Method in interface com.marklogic.xcc.types.XdmDocument
Returns a W3C Document equivalent of this document.
asW3cDocument() - Method in interface com.marklogic.xcc.types.XdmDocument
This is equivalent to asW3cDocument (null).
asW3cDocument(DocumentBuilder) - Method in interface com.marklogic.xcc.types.XdmElement
Returns a W3C Document object with this element() as the root node.
asW3cDocument() - Method in interface com.marklogic.xcc.types.XdmElement
This is equivalent to asW3cDocument (null).
asW3cElement(DocumentBuilder) - Method in interface com.marklogic.xcc.types.XdmElement
Returns a W3C Element object equivalent to this XdmElement.
asW3cElement() - Method in interface com.marklogic.xcc.types.XdmElement
This is equivalent to asW3cElement (null).
asW3cNode(DocumentBuilder) - Method in interface com.marklogic.xcc.types.XdmNode
Buffers the node() item from the server and converts it to a W3C DOM Node object.
asW3cNode() - Method in interface com.marklogic.xcc.types.XdmNode
This is equivalent to asW3cNode (null);
asW3cText(DocumentBuilder) - Method in interface com.marklogic.xcc.types.XdmText
 
asW3cText() - Method in interface com.marklogic.xcc.types.XdmText
 

B

BINARY - Static variable in class com.marklogic.xcc.DocumentFormat
Document format = binary()
BINARY - Static variable in class com.marklogic.xcc.types.ValueType
 

C

ConnectionErrorAction - class com.marklogic.xcc.spi.ConnectionErrorAction.
This is a type-safe enumeration that defines the possible return values of ConnectionProvider.returnErrorConnection(ServerConnection, Throwable, java.util.logging.Logger).
ConnectionProvider - interface com.marklogic.xcc.spi.ConnectionProvider.
This interface defines a provider of Sockets for a ContentSource.
Content - interface com.marklogic.xcc.Content.
A Content object encapsulates content (a document) that can be transferred to and inserted into a contentbase.
ContentCapability - class com.marklogic.xcc.ContentCapability.
A typesafe enumeration class defining permission capability values.
ContentCreateOptions - class com.marklogic.xcc.ContentCreateOptions.
A set of creation options to be applied to a document when it is inserted into a contentbase.
ContentCreateOptions() - Constructor for class com.marklogic.xcc.ContentCreateOptions
 
ContentFactory - class com.marklogic.xcc.ContentFactory.
A helper class for creating instances of Content.
ContentFetcher - class com.marklogic.xcc.examples.ContentFetcher.
This class fetches documents from the conentbase and writes their serialized contents to a provided OutputStream.
ContentFetcher(URI) - Constructor for class com.marklogic.xcc.examples.ContentFetcher
Construct an instance that may be used to fetch documents.
ContentInsertEntityException - exception com.marklogic.xcc.exceptions.ContentInsertEntityException.
This is a specialization of ContentInsertException that indicates the insertion faled because an XML entity embedded in the document could not be resolved.
ContentInsertEntityException(String, Request, Content, String) - Constructor for class com.marklogic.xcc.exceptions.ContentInsertEntityException
 
ContentInsertEntityException(String, Request, Content, String, Throwable) - Constructor for class com.marklogic.xcc.exceptions.ContentInsertEntityException
 
ContentInsertException - exception com.marklogic.xcc.exceptions.ContentInsertException.
This exception indicates a failed attempt to insert a Content object.
ContentInsertException(String, Request, Content) - Constructor for class com.marklogic.xcc.exceptions.ContentInsertException
 
ContentInsertException(String, Request, Content, Throwable) - Constructor for class com.marklogic.xcc.exceptions.ContentInsertException
 
ContentLoader - class com.marklogic.xcc.examples.ContentLoader.
This program accepts a server URI (in the format expected by ContentSourceFactory.newContentSource(java.net.URI)) and one or more file pathnames of documents to load.
ContentLoader(URI) - Constructor for class com.marklogic.xcc.examples.ContentLoader
Construct an instance that may be used to insert content.
ContentPermission - class com.marklogic.xcc.ContentPermission.
An individual Content (document) permission, a capability/role pair.
ContentPermission(ContentCapability, String) - Constructor for class com.marklogic.xcc.ContentPermission
Instantiate a new permission object with the given capability and role.
ContentSource - interface com.marklogic.xcc.ContentSource.
A ContentSource object describes a content source (MarkLogic Server instance) and serves as a factory that creates Session objects.
ContentSourceBean - class com.marklogic.xcc.jndi.ContentSourceBean.
This is a Java Bean compatible implementation of ContentSource intended for use in a JNDI context or container where configuration must be done via setter methods.
ContentSourceBean() - Constructor for class com.marklogic.xcc.jndi.ContentSourceBean
 
ContentSourceBeanFactory - class com.marklogic.xcc.jndi.ContentSourceBeanFactory.
This class implements the JNDI ObjectFactory interface and may be used in a J2EE container as a source of ContentSource instances.
ContentSourceBeanFactory() - Constructor for class com.marklogic.xcc.jndi.ContentSourceBeanFactory
 
ContentSourceFactory - class com.marklogic.xcc.ContentSourceFactory.
Static helper class with factory methods to create instances of ContentSource using explicit connection parameters.
ContentbaseMetaData - interface com.marklogic.xcc.ContentbaseMetaData.
Meta-data about a contentbase as represented by a Session instance.
cache() - Method in interface com.marklogic.xcc.ResultItem
If this item is not already cached, read it fully from the result stream so that it is buffered in memory.
channel() - Method in interface com.marklogic.xcc.spi.ServerConnection
The channel to be used for server communication.
clearVariable(XdmVariable) - Method in interface com.marklogic.xcc.Request
Remove the given variable from this Request context.
clearVariables() - Method in interface com.marklogic.xcc.Request
Remove any variables set in this Request.
close() - Method in interface com.marklogic.xcc.Content
This method will be called after successfully consuming the content from the InputStream returned by Content.openDataStream().
close() - Method in interface com.marklogic.xcc.ResultSequence
Release any resources being held by this ResultSequence.
close() - Method in interface com.marklogic.xcc.Session
Shutdown and invalidate this Session and release any resources it may be holding.
close() - Method in class com.marklogic.xcc.examples.OutputStreamContent
 
close() - Method in class com.marklogic.xcc.examples.SemiBufferedContent
 
close() - Method in interface com.marklogic.xcc.spi.ServerConnection
Close this server connection.
com.marklogic.xcc - package com.marklogic.xcc
XCC Core Public Interfaces.
com.marklogic.xcc.examples - package com.marklogic.xcc.examples
XCC Examples.
com.marklogic.xcc.exceptions - package com.marklogic.xcc.exceptions
XCC Exceptions.
com.marklogic.xcc.jndi - package com.marklogic.xcc.jndi
XCC Java Naming and Directory Interface (JNDI) Support.
com.marklogic.xcc.spi - package com.marklogic.xcc.spi
XCC Service Provider Interface Package.
com.marklogic.xcc.types - package com.marklogic.xcc.types
XCC Type Definitions.
commit() - Method in interface com.marklogic.xcc.Session
Commit the current transaction.
current() - Method in interface com.marklogic.xcc.ResultSequence
Fetch the current ResultItem object in the 1ResultSequence.

D

DEFAULT_AUTO_RETRY_DELAY_MILLIS - Static variable in class com.marklogic.xcc.RequestOptions
Default delay (in milliseconds) between automatic query retries (value: 100)
DEFAULT_ENCODING - Static variable in class com.marklogic.xcc.ContentCreateOptions
The default character encoding (UTF-8) that will be assumed if not explicitly set by ContentCreateOptions.setEncoding(String).
DEFAULT_MAX_AUTO_RETRY - Static variable in class com.marklogic.xcc.RequestOptions
Default max retry attempts on a request or content insertion (value: 4)
DocumentFormat - class com.marklogic.xcc.DocumentFormat.
Typesafe enumeration of allowable formats for document insertion.
DocumentRepairLevel - class com.marklogic.xcc.DocumentRepairLevel.
A typesafe enumeration class defining load-time document repair levels.
Duration - class com.marklogic.xcc.types.Duration.
The Duration class is a mutable class which implements the XdmDuration interface.
Duration() - Constructor for class com.marklogic.xcc.types.Duration
Construct a duration object, initialized to zero length.
Duration(String) - Constructor for class com.marklogic.xcc.types.Duration
Construct a duration object initialized from the given string in the format of a serialized xs:duration item.
Duration(boolean, int, int, int, int, int, BigDecimal) - Constructor for class com.marklogic.xcc.types.Duration
Construct a duration object by specifying the individual values.
DynamicContentStream - class com.marklogic.xcc.examples.DynamicContentStream.
This class, which extends InputStream, is an example of producing dynamic, on-the-fly content that can be used with ContentFactory.newUnBufferedContent(String, java.io.InputStream, com.marklogic.xcc.ContentCreateOptions).
DynamicContentStream(int) - Constructor for class com.marklogic.xcc.examples.DynamicContentStream
Constructor for the example, which takes the number of lines to generate in the dummy document.

E

ELEMENT - Static variable in class com.marklogic.xcc.types.ValueType
 
EXECUTE - Static variable in class com.marklogic.xcc.ContentCapability
Execution is allowed
EXECUTE - Static variable in class com.marklogic.xcc.ContentPermission
Convenience reference to ContentCapability.EXECUTE
equals(Object) - Method in class com.marklogic.xcc.types.Duration
Compares this XdmDuration object to the specified object.
equals(Object) - Method in class com.marklogic.xcc.types.XName
 
execute(String) - Method in class com.marklogic.xcc.examples.SimpleQueryRunner
Submit the given query string and return a ResultSequence object.
executeToSingleString(String, String) - Method in class com.marklogic.xcc.examples.SimpleQueryRunner
Submit the given query string and return a single String which is the concatenation of all the ResultItems, separated by the given separator string.
executeToStringArray(String) - Method in class com.marklogic.xcc.examples.SimpleQueryRunner
Submit the given query string and return an array of Strings, possibly of length zero, which contains the String value of each ResultItem (see XdmValue.asString())

F

FAIL - Static variable in class com.marklogic.xcc.spi.ConnectionErrorAction
 
FULL - Static variable in class com.marklogic.xcc.DocumentRepairLevel
Repair document to make it well formed, if possible
fillBuffer(byte[]) - Method in class com.marklogic.xcc.examples.DynamicContentStream
This method will be called repeatedly as XCC reads data from the InputStream (this object).
forType(String) - Static method in class com.marklogic.xcc.types.ItemType
 

G

getAddress() - Method in interface com.marklogic.xcc.spi.SingleHostAddress
The address to which connections are made.
getAutoCommit() - Method in interface com.marklogic.xcc.Session
Get the current value of auto-commit.
getAutoRetryDelayMillis() - Method in class com.marklogic.xcc.RequestOptions
The number of milliseconds to delay between each automatic query retry attempt.
getBufferSize() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the preferred working buffer size to use for copying the content to the server.
getCacheResult() - Method in class com.marklogic.xcc.RequestOptions
Indicates whether the ResultSequence should be cached when read from the server.
getCapability() - Method in class com.marklogic.xcc.ContentPermission
Get this permission's capability.
getChannel(ResultChannelName) - Method in interface com.marklogic.xcc.ResultSequence
Return the ResultSequence for an alternate ResultChannelName.
getCode() - Method in class com.marklogic.xcc.exceptions.XQueryException
Returns the server error code for this XQuery exception.
getCollections() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the set of collection URIs currently in effect for this options object.
getConnectionUri() - Method in interface com.marklogic.xcc.Session
Return a URI that describes connection information for this Session, if available.
getContent() - Method in class com.marklogic.xcc.exceptions.ContentInsertException
The Content object that could not be inserted.
getContentBaseId() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return the numeric database ID of the contentbase.
getContentBaseName() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return the name of the contentbase associated with the Session.
getContentBaseName() - Method in interface com.marklogic.xcc.Session
Return the contentbase name provided when this Session was created, if any.
getContentSource() - Method in interface com.marklogic.xcc.Session
Obtain a reference to the ContentSource object from which this Session instance was obtained.
getContentUri() - Method in class com.marklogic.xcc.exceptions.ContentInsertException
The URI, as a String, of the Content that could not be inserted.
getContentbaseMetaData() - Method in interface com.marklogic.xcc.Session
Meta-information about the contentbase associated with this Session.
getContextItem() - Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
Get the context item, or null if there is no context defined.
getContextPosition() - Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
Get the context position, or 0 if there is no context defined.
getCreateOptions() - Method in interface com.marklogic.xcc.Content
Return the ContentCreateOptions object which should be applied to this object.
getCreateOptions() - Method in class com.marklogic.xcc.examples.OutputStreamContent
 
getCreateOptions() - Method in class com.marklogic.xcc.examples.SemiBufferedContent
 
getCurrentServerPointInTime() - Method in interface com.marklogic.xcc.Session
Issues a query to the server and returns the most recent system commit timestamp.
getData() - Method in class com.marklogic.xcc.exceptions.XQueryException
 
getDays() - Method in class com.marklogic.xcc.types.Duration
 
getDays() - Method in interface com.marklogic.xcc.types.XdmDuration
 
getDefaultLogger() - Method in interface com.marklogic.xcc.ContentSource
Returns the current Logger to which log messages will be sent.
getDefaultLogger() - Method in class com.marklogic.xcc.jndi.ContentSourceBean
 
getDefaultRequestOptions() - Method in interface com.marklogic.xcc.Session
Returns the RequestOptions instance set on this Session object.
getDriverMajorVersion() - Method in interface com.marklogic.xcc.ContentbaseMetaData
The driver (XCC) major release version.
getDriverMinorVersion() - Method in interface com.marklogic.xcc.ContentbaseMetaData
The driver (XCC) minor release version.
getDriverPatchVersion() - Method in interface com.marklogic.xcc.ContentbaseMetaData
The driver (XCC) patch release version.
getDriverVersionString() - Method in interface com.marklogic.xcc.ContentbaseMetaData
The driver (XCC) release version, as a String.
getEffectiveOptions() - Method in interface com.marklogic.xcc.Request
Returns a RequestOptions instance that reflects the execution options that will be applied to this request.
getEffectivePointInTime() - Method in class com.marklogic.xcc.RequestOptions
Returns the point-in-time timestamp value, if any, set in this object.
getEffectiveRequestOptions() - Method in interface com.marklogic.xcc.Session
Returns an instance of RequestOptions that represents the effective default request options for this Session (ie, the options that would be applied if no options are applied to a specific Request.
getEncoding() - Method in class com.marklogic.xcc.ContentCreateOptions
Get the current charset encoding setting for this options object.
getEntityLocation() - Method in class com.marklogic.xcc.exceptions.ContentInsertEntityException
Returns the location, as a URI String, of the requested entity.
getForestIds() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return the IDs of forests attached to the contentbase associated with the Session.
getForestMap() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Returns a Map of forest names to forest IDs.
getForestNames() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return the names of the forests attached to the contnetbase associated with the Session.
getFormat() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the document format value currently in effect for this options object.
getFormatString() - Method in class com.marklogic.xcc.exceptions.XQueryException
 
getHours() - Method in class com.marklogic.xcc.types.Duration
 
getHours() - Method in interface com.marklogic.xcc.types.XdmDuration
 
getIndex() - Method in interface com.marklogic.xcc.ResultItem
The position (zero-based) of this ResultItem in its containing ResultSequence.
getItem() - Method in interface com.marklogic.xcc.ResultItem
Returns the actual XdmItem value wrapped by this ResultItem.
getItemType() - Method in interface com.marklogic.xcc.types.XdmItem
The ItemType instance corresponding to the type of this item.
getLanguage() - Method in class com.marklogic.xcc.ContentCreateOptions
Get the current language setting for this options object.
getLineNumber() - Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
Get the line number in the XQuery source.
getLocale() - Method in class com.marklogic.xcc.ContentCreateOptions
Get the Locale setting for this options object.
getLocale() - Method in class com.marklogic.xcc.RequestOptions
The (possibly null) Locale object associated with this instance.
getLocalname() - Method in class com.marklogic.xcc.types.XName
This XName's local name.
getLogger() - Method in interface com.marklogic.xcc.Session
Get the java.util.logging.Logger instance set on this Session.
getMaxAutoRetry() - Method in class com.marklogic.xcc.RequestOptions
The maximum number of times a retryable request will be automatically retried before throwing an exception.
getMinutes() - Method in class com.marklogic.xcc.types.Duration
 
getMinutes() - Method in interface com.marklogic.xcc.types.XdmDuration
 
getModuleUri() - Method in interface com.marklogic.xcc.ModuleInvoke
Returns the currently set URI for this Request.
getModuleUri() - Method in interface com.marklogic.xcc.ModuleSpawn
Returns the currently set URI for this Request.
getMonths() - Method in class com.marklogic.xcc.types.Duration
 
getMonths() - Method in interface com.marklogic.xcc.types.XdmDuration
 
getName() - Method in interface com.marklogic.xcc.types.XdmVariable
The name of this variable.
getNamespace() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the namespace name setting current in effect for this options object.
getNamespace() - Method in class com.marklogic.xcc.types.XName
This XName's namespace name, if defined.
getObjectInstance(Object, Name, Context, Hashtable) - Method in class com.marklogic.xcc.jndi.ContentSourceBeanFactory
 
getOperation() - Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
Get the description of the current operation.
getOptions() - Method in interface com.marklogic.xcc.Request
Returns the currently set RequestOptions object.
getOutputStream() - Method in class com.marklogic.xcc.examples.OutputStreamContent
Return the end of the pipe to which you will write your content (the sink).
getPermissions() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the set of document permissions currently in effect for this options object.
getPlaceKeys() - Method in class com.marklogic.xcc.ContentCreateOptions
Returns the set of forest placement keys (forest IDs) currently in effect for this options object.
getQuality() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the quality value currently set on this options object.
getQuery() - Method in interface com.marklogic.xcc.AdhocQuery
Returns the currently set ad-hoc XQuery string.
getRepairLevel() - Method in class com.marklogic.xcc.ContentCreateOptions
Return the current document repair level setting.
getRequest() - Method in class com.marklogic.xcc.examples.ModuleRunner
Returns the Request object used internally to submit requests.
getRequest() - Method in class com.marklogic.xcc.examples.SimpleQueryRunner
Returns the Request object used internally to submit requests.
getRequest() - Method in class com.marklogic.xcc.exceptions.RequestException
The initiating request to which this exception applies.
getRequestName() - Method in class com.marklogic.xcc.RequestOptions
A user-defined, name value sent with the Request and logged on the server.
getResolveBufferSize() - Method in class com.marklogic.xcc.ContentCreateOptions
Indicate the buffer size to use for entity resolution.
getResolveEntities() - Method in class com.marklogic.xcc.ContentCreateOptions
Get the current setting of the the flag which indicates whether or not to resolve entities embedded in an XML document to be inserted.
getResponseCode() - Method in class com.marklogic.xcc.exceptions.ServerResponseException
 
getResponseMessage() - Method in class com.marklogic.xcc.exceptions.ServerResponseException
 
getResultBufferSize() - Method in class com.marklogic.xcc.RequestOptions
The currently set (or default if never set) ResultSequence buffer size.
getResultSequence() - Method in class com.marklogic.xcc.exceptions.StreamingResultException
 
getRole() - Method in class com.marklogic.xcc.ContentPermission
Get the name of the role associated with this permission.
getSeconds() - Method in class com.marklogic.xcc.types.Duration
 
getSeconds() - Method in interface com.marklogic.xcc.types.XdmDuration
 
getServerMajorVersion() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return the server major release version number.
getServerMinorVersion() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return ther server minor release version number.
getServerPatchVersion() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return ther server patch release version number.
getServerVersionString() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Return a String version of the MarkLogic Server.
getSession() - Method in interface com.marklogic.xcc.ContentbaseMetaData
The Session object that created this object.
getSession() - Method in interface com.marklogic.xcc.Request
The session which created this Request.
getStack() - Method in class com.marklogic.xcc.exceptions.XQueryException
Get an array of XQueryStackFrame objects that represent the XQuery stack frame returned by the server.
getSymbol() - Method in class com.marklogic.xcc.ContentCapability
Used internally.
getTimeZone() - Method in class com.marklogic.xcc.RequestOptions
The (possibly null) TimeZone object associated with this instance.
getTimeoutMillis() - Method in class com.marklogic.xcc.RequestOptions
Get the timeout value (in milliseconds) for this options object.
getTimeoutMillis() - Method in interface com.marklogic.xcc.spi.ServerConnection
A timeout value, in milliseconds, which is a hint to the provider upon return to indicate how long this connection should be considered valid.
getTimeoutTime() - Method in interface com.marklogic.xcc.spi.ServerConnection
Get the exact time, in milliseconds, at which this connection is considered to be expired.
getUri() - Method in interface com.marklogic.xcc.Content
The URI with which this content should be inserted.
getUri() - Method in class com.marklogic.xcc.examples.OutputStreamContent
 
getUri() - Method in class com.marklogic.xcc.examples.SemiBufferedContent
 
getUri() - Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
Get the URI of the XQuery source.
getUser() - Method in interface com.marklogic.xcc.ContentbaseMetaData
Returns the user identity associated with the Session from which this object was obtained.
getUser() - Method in class com.marklogic.xcc.exceptions.RequestPermissionException
The user to which this permission issue applies.
getUserCredentials() - Method in interface com.marklogic.xcc.Session
Returns the user identity associated with this Session.
getUserName() - Method in interface com.marklogic.xcc.UserCredentials
The user name associated with this credential object.
getUserObject() - Method in interface com.marklogic.xcc.Session
Fetch the current user object set for this Session.
getValue() - Method in interface com.marklogic.xcc.types.XdmVariable
The value of this variable.
getValueType() - Method in interface com.marklogic.xcc.types.XdmValue
The XQuery type specification instance for this value.
getVariables() - Method in interface com.marklogic.xcc.Request
Return an array (possibly zero length) of all the XdmVariable objects currently set on this Request.
getVariables() - Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
Get the variable bindings.
getVersionMajor() - Static method in class com.marklogic.xcc.Version
 
getVersionMinor() - Static method in class com.marklogic.xcc.Version
 
getVersionPatch() - Static method in class com.marklogic.xcc.Version
 
getVersionString() - Static method in class com.marklogic.xcc.Version
 
getWholeSeconds() - Method in class com.marklogic.xcc.types.Duration
 
getWholeSeconds() - Method in interface com.marklogic.xcc.types.XdmDuration
 
getYears() - Method in class com.marklogic.xcc.types.Duration
 
getYears() - Method in interface com.marklogic.xcc.types.XdmDuration
 

H

HelloWorld - class com.marklogic.xcc.examples.HelloWorld.
The obligatory Hello World example.
HelloWorld() - Constructor for class com.marklogic.xcc.examples.HelloWorld
 
hasNext() - Method in interface com.marklogic.xcc.ResultSequence
Returns true if this sequence contains another item beyond the currently active one.
hashCode() - Method in class com.marklogic.xcc.types.Duration
 
hashCode() - Method in class com.marklogic.xcc.types.XName
 

I

INSERT - Static variable in class com.marklogic.xcc.ContentCapability
Inserts are allowed
INSERT - Static variable in class com.marklogic.xcc.ContentPermission
Convenience reference to ContentCapability.INSERT
ItemType - class com.marklogic.xcc.types.ItemType.
Each instance of this class corresponds to an XQuery schema type.
insertContent(Content) - Method in interface com.marklogic.xcc.Session
Insert the given Content into the contentbase.
insertContent(Content[]) - Method in interface com.marklogic.xcc.Session
Insert all the Content objects in the contentbase as a transactional unit.
invoke(String) - Method in class com.marklogic.xcc.examples.ModuleRunner
Invoke the module with the given URI and return the resulting ResultSequence.
invokeToSingleString(String, String) - Method in class com.marklogic.xcc.examples.ModuleRunner
 
invokeToStringArray(String) - Method in class com.marklogic.xcc.examples.ModuleRunner
 
isAtomic() - Method in class com.marklogic.xcc.types.AtomicType
Always true.
isAtomic() - Method in class com.marklogic.xcc.types.ItemType
Implemented by subclasses.
isAtomic() - Method in class com.marklogic.xcc.types.NodeType
Always false.
isCached() - Method in interface com.marklogic.xcc.ResultSequence
Indicates whether this is a cached (detached) ResultSequence.
isCached() - Method in interface com.marklogic.xcc.types.XdmItem
Indicates whether this item's value is buffered in memory.
isClosed() - Method in interface com.marklogic.xcc.ResultSequence
Indicates whether this ResultSequence is closed.
isClosed() - Method in interface com.marklogic.xcc.Session
True if this Session object is closed.
isEmpty() - Method in interface com.marklogic.xcc.types.XdmSequence
Indicates whether this XdmSequence is empty.
isFetchable() - Method in interface com.marklogic.xcc.ResultItem
Indicates if the value of this ResultItem may be fetched.
isNegative() - Method in class com.marklogic.xcc.types.Duration
 
isNegative() - Method in interface com.marklogic.xcc.types.XdmDuration
 
isNode() - Method in class com.marklogic.xcc.types.AtomicType
Always false.
isNode() - Method in class com.marklogic.xcc.types.ItemType
Implemented by subclasses.
isNode() - Method in class com.marklogic.xcc.types.NodeType
Always true.
isOpen() - Method in interface com.marklogic.xcc.spi.ServerConnection
Indicates whether the underlying connection channel is open.
isPositive() - Method in class com.marklogic.xcc.types.Duration
 
isPositive() - Method in interface com.marklogic.xcc.types.XdmDuration
 
isRetryable() - Method in class com.marklogic.xcc.exceptions.XQueryException
Returns true if the server indicates that this request might succeeed if resubmitted.
isRewindable() - Method in interface com.marklogic.xcc.Content
Indicates whether this Content instance is rewindable and therefore automatically retryable.
isRewindable() - Method in class com.marklogic.xcc.examples.OutputStreamContent
The answer is "no".
isRewindable() - Method in class com.marklogic.xcc.examples.SemiBufferedContent
 
isSequence() - Method in class com.marklogic.xcc.types.ItemType
Always returns false.
isSequence() - Method in class com.marklogic.xcc.types.SequenceType
Always returns true.
isSequence() - Method in class com.marklogic.xcc.types.ValueType
Indicates whether this value type represents a sequence or single value.
itemAt(int) - Method in interface com.marklogic.xcc.ResultSequence
Returns the XdmItem wrapped by the ResultItem at the given index.
itemAt(int) - Method in interface com.marklogic.xcc.types.XdmSequence
Return the XdmItem at the given position from this XdmSequence.
iterator() - Method in interface com.marklogic.xcc.ResultSequence
Returns a java.util.Iterator instance that may be used to iterate over this result sequence.
iterator() - Method in interface com.marklogic.xcc.types.XdmSequence
A java.util.Iterator instance that iterates over the items in this XdmSequence.

L

load(String[], File[]) - Method in class com.marklogic.xcc.examples.ContentLoader
Load the provided Files, using the provided URIs, into the content server.
load(File[]) - Method in class com.marklogic.xcc.examples.ContentLoader
Load the provided Files into the contentbase, using the absolute pathname of each File as the document URI.

M

MAX_BUFFER_SIZE - Static variable in class com.marklogic.xcc.ContentCreateOptions
The maximum user-settable buffer size (12MB)
MAX_RETRY_SYSTEM_PROPERTY - Static variable in class com.marklogic.xcc.RequestOptions
The system property name (xcc.request.retries.max) which, if set, specifies the default maximum number of automatic retries.
MIN_BUFFER_SIZE - Static variable in class com.marklogic.xcc.ContentCreateOptions
The minimum user-settable buffer size (256)
ModuleInvoke - interface com.marklogic.xcc.ModuleInvoke.
An specialization of Request that contains the URI of an XQuery module (resident in the server) to be evaluated by the MarkLogic Server.
ModuleRunner - class com.marklogic.xcc.examples.ModuleRunner.
This is a very simple class that will invoke a named XQuery module on the server and return the result.
ModuleRunner(URI) - Constructor for class com.marklogic.xcc.examples.ModuleRunner
Construct an instance that will invoke modules on the server represented by the given URI.
ModuleSpawn - interface com.marklogic.xcc.ModuleSpawn.
An extension of Request that contains the URI of an XQuery module (resident server-side) to be spawned asynchronously by the MarkLogic Server.
main(String[]) - Static method in class com.marklogic.xcc.examples.ContentFetcher
Command-line main() method to fetch a document.
main(String[]) - Static method in class com.marklogic.xcc.examples.ContentLoader
Command-line main() module to run this content loader.
main(String[]) - Static method in class com.marklogic.xcc.examples.DynamicContentStream
Example invocation that uses an instance of this class to insert dynamically-generated content, without spawning a separate thread.
main(String[]) - Static method in class com.marklogic.xcc.examples.HelloWorld
 
main(String[]) - Static method in class com.marklogic.xcc.examples.ModuleRunner
 
main(String[]) - Static method in class com.marklogic.xcc.examples.OutputStreamInserter
Looks for a server URI and a document URI on the command line, then spawns a thread to generate and insert some content there.
main(String[]) - Static method in class com.marklogic.xcc.examples.SimpleQueryRunner
Simple command-line driver that will read a query from a file and submit it to the server at the given URL.

N

NODE - Static variable in class com.marklogic.xcc.types.ValueType
 
NONE - Static variable in class com.marklogic.xcc.DocumentFormat
Document format = none (use server default)
NONE - Static variable in class com.marklogic.xcc.DocumentRepairLevel
No automatic repair, insert as-is or error out if not well formed
NodeType - class com.marklogic.xcc.types.NodeType.
Base type for enumerators that represent node types.
newAdhocQuery(String, RequestOptions) - Method in interface com.marklogic.xcc.Session
Create a new AdhocQuery object and initialize it with the given query string and RequestOptions object.
newAdhocQuery(String) - Method in interface com.marklogic.xcc.Session
Create a new AdhocQuery object and initialize it with the given query string.
newBinaryInstance() - Static method in class com.marklogic.xcc.ContentCreateOptions
Create an instance with format set to DocumentFormat.BINARY.
newBinaryNode(Object) - Static method in class com.marklogic.xcc.ValueFactory
 
newContent(String, Document, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a W3C DOM Document object.
newContent(String, Node, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a W3C DOM Node object.
newContent(String, XdmNode, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from an XdmNode.
newContent(String, File, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a File object.
newContent(String, RandomAccessFile, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a RandomAccessFile object.
newContent(String, URL, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a URI, buffering so that it's rewindable and only accesses the URL one time.
newContent(String, URI, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a URI, buffering so that it's rewindable and only accesses the URL one time.
newContent(String, String, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a String.
newContent(String, byte[], ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a byte array.
newContent(String, byte[], int, int, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object from a subset of a byte array.
newContent(String, InputStream, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new Content object by consuming the given InputStream and buffereing it in memory.
newContentSource(ConnectionProvider, String, String, String) - Static method in class com.marklogic.xcc.ContentSourceFactory
Return a ContentSource object that will use the provided ConnectionProvider instance to obtain server connections, with the given default login credentials and contentbase values.
newContentSource(URI) - Static method in class com.marklogic.xcc.ContentSourceFactory
Return a ContentSource object that will serve as the source of connections to the server specified by the given URI.
newContentSource(String, int, String, String, String) - Static method in class com.marklogic.xcc.ContentSourceFactory
Return a ContentSource object that will serve as the source of connections to the server on the given host and port, with login credentials of the given user and password.
newContentSource(String, int, String, String) - Static method in class com.marklogic.xcc.ContentSourceFactory
Equivalent to newContentSource (host, port, user, password, null)
newContentSource(String, int) - Static method in class com.marklogic.xcc.ContentSourceFactory
Return a ContentSource object that will serve as the source of connections to the server on the given host and port, with no default login credentials.
newDuration(String) - Static method in class com.marklogic.xcc.ValueFactory
Convenience method to construct an XdmDuration value.
newElement(Object) - Static method in class com.marklogic.xcc.ValueFactory
A convenience method to construct an XdmElement value.
newExecutePermission(String) - Static method in class com.marklogic.xcc.ContentPermission
Convenience factory method to create a permission object with execute capability and the given role.
newInsertPermission(String) - Static method in class com.marklogic.xcc.ContentPermission
Convenience factory method to create a permission object with insert capability and the given role.
newModuleInvoke(String, RequestOptions) - Method in interface com.marklogic.xcc.Session
Create a new ModuleInvoke object and initialize it with the given module URI and RequestOptions object.
newModuleInvoke(String) - Method in interface com.marklogic.xcc.Session
Create a new ModuleInvoke object and initialize it with the given module URI.
newModuleSpawn(String, RequestOptions) - Method in interface com.marklogic.xcc.Session
Create a new ModuleSpawn object and initialize it with the given module URI and RequestOptions object.
newModuleSpawn(String) - Method in interface com.marklogic.xcc.Session
Create a new ModuleSpawn object and initialize it with the given module URI.
newReadPermission(String) - Static method in class com.marklogic.xcc.ContentPermission
Convenience factory method to create a permission object with read capability and the given role.
newSequence(XdmValue[]) - Static method in class com.marklogic.xcc.ValueFactory
Factory method to construct an XdmSequence from an array of XdmValue objects.
newSession() - Method in interface com.marklogic.xcc.ContentSource
Attempts to establish a Session with the default contentbase for this ContentSource.
newSession(String) - Method in interface com.marklogic.xcc.ContentSource
Attempts to establish a Session with the specified contentbase on the server represented by this ContentSource.
newSession(String, String) - Method in interface com.marklogic.xcc.ContentSource
Attempts to establish a Session with the default contentbase for this ContentSource using the provided login credentials.
newSession(String, String, String) - Method in interface com.marklogic.xcc.ContentSource
Attempts to establish a Session with the specified contentbase on the server represented by this ContentSource, using the provided user credentials.
newSession() - Method in class com.marklogic.xcc.jndi.ContentSourceBean
 
newSession(String) - Method in class com.marklogic.xcc.jndi.ContentSourceBean
 
newSession(String, String) - Method in class com.marklogic.xcc.jndi.ContentSourceBean
 
newSession(String, String, String) - Method in class com.marklogic.xcc.jndi.ContentSourceBean
 
newTextInstance() - Static method in class com.marklogic.xcc.ContentCreateOptions
Create an instance with format set to DocumentFormat.TEXT.
newTextNode(Object) - Static method in class com.marklogic.xcc.ValueFactory
A convenience method to construct an XdmText value.
newUnBufferedContent(String, URL, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new, non-rewindable Content object from a URL.
newUnBufferedContent(String, URI, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new, non-rewindable Content object from a URI.
newUnBufferedContent(String, InputStream, ContentCreateOptions) - Static method in class com.marklogic.xcc.ContentFactory
Create a new non-rewindable Content object for the given InputStream.
newUpdatePermission(String) - Static method in class com.marklogic.xcc.ContentPermission
Convenience factory method to create a permission object with update capability and the given role.
newValue(ValueType, Object) - Static method in class com.marklogic.xcc.ValueFactory
Generic XdmValue creation factory method.
newVariable(XName, XdmValue) - Static method in class com.marklogic.xcc.ValueFactory
Factory method to create a variable (named value) from the given XName and XdmValue objects.
newXSBoolean(boolean) - Static method in class com.marklogic.xcc.ValueFactory
A convenience method to construct an XSBoolean value.
newXSDate(String, TimeZone, Locale) - Static method in class com.marklogic.xcc.ValueFactory
A convenience method to construct an XSDate value.
newXSDateTime(String, TimeZone, Locale) - Static method in class com.marklogic.xcc.ValueFactory
A convenience method to construct an XSDateTime value.
newXSDuration(String) - Static method in class com.marklogic.xcc.ValueFactory
A convenience method to construct an XSDuration value.
newX