A B C D E F G H I L M N O P Q R S T U V W X
A
- AdhocQuery - Interface in com.marklogic.xcc
- 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. - appendRequestInfo(StringBuffer) -
Method in exception com.marklogic.xcc.exceptions.RequestException
-
- 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.XdmBinary
- Buffers the binary() item from the server and converts it to a Java byte array.
- asBinaryData() -
Method in interface com.marklogic.xcc.types.XSBase64Binary
-
- asBinaryData() -
Method in interface com.marklogic.xcc.types.XSHexBinary
-
- 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
-
- asW3cAttr(DocumentBuilder) -
Method in interface com.marklogic.xcc.types.XdmAttribute
-
- asW3cAttr() -
Method in interface com.marklogic.xcc.types.XdmAttribute
-
- asW3cComment(DocumentBuilder) -
Method in interface com.marklogic.xcc.types.XdmComment
-
- asW3cComment() -
Method in interface com.marklogic.xcc.types.XdmComment
-
- 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);
- asW3cProcessingInstruction(DocumentBuilder) -
Method in interface com.marklogic.xcc.types.XdmProcessingInstruction
-
- asW3cProcessingInstruction() -
Method in interface com.marklogic.xcc.types.XdmProcessingInstruction
-
- asW3cText(DocumentBuilder) -
Method in interface com.marklogic.xcc.types.XdmText
-
- asW3cText() -
Method in interface com.marklogic.xcc.types.XdmText
-
- AtomicType - Class in com.marklogic.xcc.types
- Base class for type-safe enumeration instances that represent atomic types.
- ATTRIBUTE -
Static variable in class com.marklogic.xcc.types.ValueType
-
- 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.
B
- BINARY -
Static variable in class com.marklogic.xcc.DocumentFormat
- Document format = binary()
- BINARY -
Static variable in class com.marklogic.xcc.types.ValueType
-
C
- 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.
- clone() -
Method in class com.marklogic.xcc.ContentCreateOptions
-
- 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 class com.marklogic.xcc.examples.OutputStreamContent
-
- close() -
Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- 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 interface com.marklogic.xcc.spi.ServerConnection
- Close this server connection.
- closeExpired(long) -
Method in interface com.marklogic.xcc.spi.ConnectionProvider
- Close expired resource in the provider pool.
- 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.
- COMMENT -
Static variable in class com.marklogic.xcc.types.ValueType
-
- commit() -
Method in interface com.marklogic.xcc.Session
- Commits the current transaction.
- ConnectionErrorAction - Class in com.marklogic.xcc.spi
- This is a type-safe enumeration that defines the possible return values of
ConnectionProvider.returnErrorConnection(ServerConnection, Throwable, java.util.logging.Logger)
. - ConnectionProvider - Interface in com.marklogic.xcc.spi
- This interface defines a provider of Sockets for a
ContentSource. - Content - Interface in com.marklogic.xcc
-
A Content object encapsulates content (a document) that can be transferred to and inserted into a
contentbase.
- ContentbaseMetaData - Interface in com.marklogic.xcc
-
Meta-data about a contentbase as represented by a
Session instance. - ContentCapability - Class in com.marklogic.xcc
- A typesafe enumeration class defining permission capability values.
- ContentCreateOptions - Class in com.marklogic.xcc
- 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 in com.marklogic.xcc
-
A helper class for creating instances of
Content. - ContentFetcher - Class in com.marklogic.xcc.examples
-
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 in com.marklogic.xcc.exceptions
- 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 exception com.marklogic.xcc.exceptions.ContentInsertEntityException
-
- ContentInsertEntityException(String, Request, Content, String, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.ContentInsertEntityException
-
- ContentInsertException - Exception in com.marklogic.xcc.exceptions
- This exception indicates a failed attempt to insert a
Content object. - ContentInsertException(String, Request, Content) -
Constructor for exception com.marklogic.xcc.exceptions.ContentInsertException
-
- ContentInsertException(String, Request, Content, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.ContentInsertException
-
- ContentLoader - Class in com.marklogic.xcc.examples
-
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 in com.marklogic.xcc
- 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 in com.marklogic.xcc
-
A ContentSource object describes a content source (MarkLogic Server instance) and serves as a
factory that creates
Session objects. - ContentSourceBean - Class in com.marklogic.xcc.jndi
-
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 in com.marklogic.xcc.jndi
-
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 in com.marklogic.xcc
-
Static helper class with factory methods to create instances of
ContentSource using
explicit connection parameters. - CTS_BOX -
Static variable in class com.marklogic.xcc.types.ValueType
-
- CTS_CIRCLE -
Static variable in class com.marklogic.xcc.types.ValueType
-
- CTS_POINT -
Static variable in class com.marklogic.xcc.types.ValueType
-
- CTS_POLYGON -
Static variable in class com.marklogic.xcc.types.ValueType
-
- CtsBox - Interface in com.marklogic.xcc.types
- A cts:box value.
- CtsCircle - Interface in com.marklogic.xcc.types
- A cts:circle value.
- CtsPoint - Interface in com.marklogic.xcc.types
- A cts:point value.
- CtsPolygon - Interface in com.marklogic.xcc.types
- A cts:polygon value.
- current() -
Method in interface com.marklogic.xcc.ResultSequence
-
Fetch the current
ResultItem object in the ResultSequence.
D
- DEFAULT -
Static variable in class com.marklogic.xcc.DocumentRepairLevel
- Use server's default repair mode, which depends on the App Server default XQuery version
setting: 'none' for 1.0-ml or 1.0, 'full' for 0.9-ml or for MarkLogic Server releases prior
to 4.0.
- 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)
- DOCUMENT -
Static variable in class com.marklogic.xcc.types.ValueType
-
- DocumentFormat - Class in com.marklogic.xcc
- Typesafe enumeration of allowable formats for document insertion.
- DocumentRepairLevel - Class in com.marklogic.xcc
-
A typesafe enumeration class defining load-time document repair levels.
- Duration - Class in com.marklogic.xcc.types
- 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 in com.marklogic.xcc.examples
-
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
-
- equals(Object) -
Method in class com.marklogic.xcc.ContentPermission
-
- equals(Object) -
Method in class com.marklogic.xcc.SecurityOptions
-
Returns true if the passed object is a SecurityOptions instance that has the same enabled
ciphers and protocols, and references the same SSLContext instance.
- 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 -
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
- 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
-
- 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
-
- FULL -
Static variable in class com.marklogic.xcc.DocumentRepairLevel
- Repair document to make it well formed, if possible.
G
- getAddress() -
Method in interface com.marklogic.xcc.spi.SingleHostAddress
- The address to which connections are made.
- 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.
- getCenter() -
Method in interface com.marklogic.xcc.types.CtsCircle
-
- getChannel(ResultChannelName) -
Method in interface com.marklogic.xcc.ResultSequence
- Return the
ResultSequence for an alternate ResultChannelName.
- getCode() -
Method in exception 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.
- getConnectionProvider() -
Method in interface com.marklogic.xcc.ContentSource
-
- getConnectionProvider() -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- getConnectionUri() -
Method in interface com.marklogic.xcc.Session
-
Return a URI that describes connection information for this Session, if available.
- getContent() -
Method in exception 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.
- getContentbaseMetaData() -
Method in interface com.marklogic.xcc.Session
- Meta-information about the contentbase associated with this Session.
- 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 exception com.marklogic.xcc.exceptions.ContentInsertException
- The URI, as a String, of the
Content that could not be inserted.
- 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.
- getCount() -
Method in interface com.marklogic.xcc.Request
- Get count of result items for this request.
- 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 exception 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.
- getDefaultXQueryVersion() -
Method in class com.marklogic.xcc.RequestOptions
- Get the default XQuery version string to use as the default for the request, if any.
- getDocumentURI() -
Method in interface com.marklogic.xcc.ResultItem
- Returns the URI of the document represented by this ResultItem, as returned by xdmp:node-uri($node).
- 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.
- getEast() -
Method in interface com.marklogic.xcc.types.CtsBox
-
- 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.
- getEnabledCipherSuites() -
Method in class com.marklogic.xcc.SecurityOptions
-
Return the names of the SSL cipher suites which are to be enabled when new XCCS connections
are created.
- getEnabledProtocols() -
Method in class com.marklogic.xcc.SecurityOptions
-
Return the names of the protocol versions which are to be enabled when new XCCS connections
are created.
- getEncoding() -
Method in class com.marklogic.xcc.ContentCreateOptions
- Get the current charset encoding setting for this options object.
- getEntityLocation() -
Method in exception 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 exception 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.
- getLatitude() -
Method in interface com.marklogic.xcc.types.CtsPoint
-
- 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.
- getLongitude() -
Method in interface com.marklogic.xcc.types.CtsPoint
-
- 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.
- getNodePath() -
Method in interface com.marklogic.xcc.ResultItem
- Returns the path of the node represented by this ResultItem, as returned by xdmp:path($node, false()).
- getNorth() -
Method in interface com.marklogic.xcc.types.CtsBox
-
- 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.
- getPosition() -
Method in interface com.marklogic.xcc.Request
- Get starting position of results for this request.
- 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.
- getRadius() -
Method in interface com.marklogic.xcc.types.CtsCircle
-
- 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 exception 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.
- getRequestTimeLimit() -
Method in class com.marklogic.xcc.RequestOptions
- Get the "soft" request time limit (in seconds) to apply to the submitted request.
- 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 exception com.marklogic.xcc.exceptions.ServerResponseException
-
- getResponseMessage() -
Method in exception 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 exception 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.
- getSouth() -
Method in interface com.marklogic.xcc.types.CtsBox
-
- getSslContext() -
Method in class com.marklogic.xcc.SecurityOptions
-
Return the SSL Context that will be used for new XCCS connections.
- getStack() -
Method in exception 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.
- getTimeoutMillis() -
Method in class com.marklogic.xcc.RequestOptions
- Get the read 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.
- getTimeZone() -
Method in class com.marklogic.xcc.RequestOptions
- The (possibly null)
TimeZone object associated with this instance.
- getTransactionMode() -
Method in interface com.marklogic.xcc.Session
- Get the current transaction mode.
- getTransactionTimeout() -
Method in interface com.marklogic.xcc.Session
- Get the current transaction timeout.
- 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 exception 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 class com.marklogic.xcc.exceptions.XQueryStackFrame
- Get the variable bindings.
- getVariables() -
Method in interface com.marklogic.xcc.Request
- Return an array (possibly zero length) of all the
XdmVariable objects currently set
on this Request.
- 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
-
- getVertices() -
Method in interface com.marklogic.xcc.types.CtsPolygon
-
- getW3CCode() -
Method in exception com.marklogic.xcc.exceptions.XQueryException
- Returns the error code defined by the WC3 XQuery spec that corresponds to this exception, if
any.
- getWest() -
Method in interface com.marklogic.xcc.types.CtsBox
-
- getWholeSeconds() -
Method in class com.marklogic.xcc.types.Duration
-
- getWholeSeconds() -
Method in interface com.marklogic.xcc.types.XdmDuration
-
- getXAResource() -
Method in interface com.marklogic.xcc.Session
-
Returns an instance of the XAResource interface, specific to this Session object.
- getXQueryVersion() -
Method in exception com.marklogic.xcc.exceptions.XQueryException
- Returns the XQuery version (0.9-ml, 1.0-ml or 1.0) of the module that threw the exception.
- getXQueryVersion() -
Method in class com.marklogic.xcc.exceptions.XQueryStackFrame
- Get the XQuery version for this stack frame
- getYears() -
Method in class com.marklogic.xcc.types.Duration
-
- getYears() -
Method in interface com.marklogic.xcc.types.XdmDuration
-
H
- hashCode() -
Method in class com.marklogic.xcc.ContentPermission
-
- hashCode() -
Method in class com.marklogic.xcc.SecurityOptions
- Returns a computed hash based on the enabled cipher and protocol names, and the hashCode of
the sslContext, if set.
- hashCode() -
Method in class com.marklogic.xcc.types.Duration
-
- hashCode() -
Method in class com.marklogic.xcc.types.XName
-
- hasNext() -
Method in interface com.marklogic.xcc.ResultSequence
- Returns true if this sequence contains another item beyond the currently active one.
- HelloSecureWorld - Class in com.marklogic.xcc.examples
-
A version of the Hello World example that connects to a server using SSL/TLS.
- HelloSecureWorld() -
Constructor for class com.marklogic.xcc.examples.HelloSecureWorld
-
- HelloWorld - Class in com.marklogic.xcc.examples
-
The obligatory Hello World example.
- HelloWorld() -
Constructor for class com.marklogic.xcc.examples.HelloWorld
-
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
- 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.
- insertContentCollectErrors(Content[]) -
Method in interface com.marklogic.xcc.Session
-
Insert all the
Content objects in the contentbase.
- 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.
- isAuthenticationPreemptive() -
Method in interface com.marklogic.xcc.ContentSource
-
- isAuthenticationPreemptive() -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- 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 exception com.marklogic.xcc.exceptions.XQueryException
-
Returns true if the server indicates that this request might succeeed if resubmitted.
- isRetryAdvised() -
Method in exception com.marklogic.xcc.exceptions.RequestPermissionException
- Set to true when a request is expected to succeed if retried with valid credentials.
- 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.
- ItemType - Class in com.marklogic.xcc.types
- Each instance of this class corresponds to an XQuery schema type.
- 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
- 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.HelloSecureWorld
-
- 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.
- main(String[]) -
Static method in class com.marklogic.xcc.examples.XA
-
- 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 in com.marklogic.xcc
-
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 in com.marklogic.xcc.examples
-
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 in com.marklogic.xcc
- An extension of
Request that contains the URI of an XQuery module
(resident server-side) to be spawned asynchronously by the MarkLogic Server.
N
- 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
-
- newCommentNode(Object) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XdmComment value.
- 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, SecurityOptions) -
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(URI) -
Static method in class com.marklogic.xcc.ContentSourceFactory
- Equivalent to
newContentSource(uri, null).
- newContentSource(String, int, String, String, String, SecurityOptions) -
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, String) -
Static method in class com.marklogic.xcc.ContentSourceFactory
- Equivalent to
newContentSource (host, port, user, password, contentbaseName, null)
- 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.
- newCtsBox(String, String, String, String) -
Static method in class com.marklogic.xcc.ValueFactory
- Convenience method to construct a
CtsBox value.
- newCtsCircle(String, CtsPoint) -
Static method in class com.marklogic.xcc.ValueFactory
- Convenience method to construct a
CtsCircle value.
- newCtsPoint(String, String) -
Static method in class com.marklogic.xcc.ValueFactory
- Convenience method to construct a
CtsPoint value.
- newCtsPolygon(List<CtsPoint>) -
Static method in class com.marklogic.xcc.ValueFactory
- Convenience method to construct a
CtsPolygon value.
- newDocumentNode(Object) -
Static method in class com.marklogic.xcc.ValueFactory
-
A convenience method to construct an
XdmDocument value.
- 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.
- newProcessingInstructionNode(Object) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XdmProcessingInstruction value.
- 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.
- newXmlInstance() -
Static method in class com.marklogic.xcc.ContentCreateOptions
- Create an instance with format set to
DocumentFormat.XML.
- 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.
- newXSDuration(XdmDuration) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XSDuration value from an XdmDuration
object.
- newXSInteger(long) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XSInteger value.
- newXSInteger(BigInteger) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XSInteger value.
- newXSString(String) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XSString value.
- newXSTime(String, TimeZone, Locale) -
Static method in class com.marklogic.xcc.ValueFactory
- A convenience method to construct an
XSTime value.
- next() -
Method in interface com.marklogic.xcc.ResultSequence
-
Advance the logical cursor to the next
ResultItem in this ResultSequence and return
that item.
- NODE -
Static variable in class com.marklogic.xcc.types.ValueType
-
- NodeType - Class in com.marklogic.xcc.types
- Base type for enumerators that represent node types.
- 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.
O
- obtainConnection(Session, Request, Logger) -
Method in interface com.marklogic.xcc.spi.ConnectionProvider
-
Provide a
ServerConnection) that is open and ready to communicate with the server.
- openDataStream() -
Method in interface com.marklogic.xcc.Content
-
Return the byte stream that makes up this document.
- openDataStream() -
Method in class com.marklogic.xcc.examples.OutputStreamContent
- Passes the read end (source) of the pipe to the content insertion framework.
- openDataStream() -
Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- OutputStreamContent - Class in com.marklogic.xcc.examples
-
This is a specialized implementation of the
Content interface which allows you to write
your content to an OutputStream. - OutputStreamContent(String, ContentCreateOptions) -
Constructor for class com.marklogic.xcc.examples.OutputStreamContent
- Construct an instance with the usual URI and options parameters, the actual content will be
read from the other end of the pipe provided by
OutputStreamContent.getOutputStream().
- OutputStreamInserter - Class in com.marklogic.xcc.examples
-
This class illustrates a sample usage of the
OutputStreamContent class. - OutputStreamInserter.DocBuilder - Class in com.marklogic.xcc.examples
- A simple dummy content generator which writes to an
OutputStream. - OutputStreamInserter.DocBuilder(OutputStream, int) -
Constructor for class com.marklogic.xcc.examples.OutputStreamInserter.DocBuilder
- Initialize this instance.
P
- PRIMARY -
Static variable in class com.marklogic.xcc.ResultChannelName
- The primary result channel (the actual result).
- PROCESSING_INSTRUCTION -
Static variable in class com.marklogic.xcc.types.ValueType
-
- provider() -
Method in interface com.marklogic.xcc.spi.ServerConnection
- The
ConnectionProvider to which this connection should be returned.
Q
- QueryHelper - Class in com.marklogic.xcc.examples
-
This is a staitc helper class with some common code routines used by the examples in this
package.
R
- READ -
Static variable in class com.marklogic.xcc.ContentCapability
- Reads are allowed
- READ -
Static variable in class com.marklogic.xcc.ContentPermission
- Convenience reference to
ContentCapability.READ
- read() -
Method in class com.marklogic.xcc.examples.DynamicContentStream
- Read a single byte.
- read(byte[], int, int) -
Method in class com.marklogic.xcc.examples.DynamicContentStream
- Read "len" bytes into "userBuffer", starting at "off".
- Request - Interface in com.marklogic.xcc
- Base Request interface that contains methods common to all requests.
- RequestException - Exception in com.marklogic.xcc.exceptions
- The base class for exceptions related to submitting requests to the server.
- RequestException(String, Request) -
Constructor for exception com.marklogic.xcc.exceptions.RequestException
-
- RequestException(String, Request, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.RequestException
-
- RequestOptions - Class in com.marklogic.xcc
-
This class represents options to apply to execution of a query.
- RequestOptions() -
Constructor for class com.marklogic.xcc.RequestOptions
-
- RequestPermissionException - Exception in com.marklogic.xcc.exceptions
- This exception indicates missing or incorrect permissions for a server request.
- RequestPermissionException(String, Request, String) -
Constructor for exception com.marklogic.xcc.exceptions.RequestPermissionException
-
- RequestPermissionException(String, Request, String, boolean) -
Constructor for exception com.marklogic.xcc.exceptions.RequestPermissionException
-
- RequestPermissionException(String, Request, String, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.RequestPermissionException
-
- RequestServerException - Exception in com.marklogic.xcc.exceptions
- This is the base class for for exceptions originating in the server (XQuery syntax errors, etc)
as opposed exceptions related to communicating with the server.
- RequestServerException(String, Request) -
Constructor for exception com.marklogic.xcc.exceptions.RequestServerException
-
- RequestServerException(String, Request, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.RequestServerException
-
- ResultChannelName - Class in com.marklogic.xcc
-
A type-safe enumeration of
ResultSequence channel names. - ResultItem - Interface in com.marklogic.xcc
-
An
XdmItem that is a member of a ResultSequence. - resultItemAt(int) -
Method in interface com.marklogic.xcc.ResultSequence
-
Returns the
ResultItem from this ResultSequence, if possible, at the given positional
index.
- ResultSequence - Interface in com.marklogic.xcc
-
A sequence of
ResultItem values as returned from a query or module execution. - RETRY -
Static variable in class com.marklogic.xcc.spi.ConnectionErrorAction
-
- RetryableXQueryException - Exception in com.marklogic.xcc.exceptions
- A specialization of
XQueryException which is always retryable, to define a distinct
exception type that can be caught separately. - RetryableXQueryException(Request, String, String, String, String, String, String, boolean, String[], XQueryStackFrame[]) -
Constructor for exception com.marklogic.xcc.exceptions.RetryableXQueryException
-
- returnConnection(ServerConnection, Logger) -
Method in interface com.marklogic.xcc.spi.ConnectionProvider
- Return a
ServerConnection object (obtained from a previous call to
ConnectionProvider.obtainConnection(com.marklogic.xcc.Session,com.marklogic.xcc.Request,java.util.logging.Logger)
) to the provider, possibly to be pooled and re-used.
- returnErrorConnection(ServerConnection, Throwable, Logger) -
Method in interface com.marklogic.xcc.spi.ConnectionProvider
- Return a connection that experienced an error.
- rewind() -
Method in interface com.marklogic.xcc.Content
- This method tells the implementation that the content should be rewound to start again.
- rewind() -
Method in class com.marklogic.xcc.examples.OutputStreamContent
- This streaming-only implementation is not rewindable.
- rewind() -
Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- rewind() -
Method in interface com.marklogic.xcc.ResultSequence
- Reset the internal positional index (cursor) of this ResultSequence to before the first
ResultItem in the sequence.
- rollback() -
Method in interface com.marklogic.xcc.Session
- Rolls back the current transaction.
- run() -
Method in class com.marklogic.xcc.examples.OutputStreamInserter.DocBuilder
- Entry point when the new
Thread starts.
S
- SecurityOptions - Class in com.marklogic.xcc
- This class contains the SSL security options to be used by secure XCC connections.
- SecurityOptions(SSLContext) -
Constructor for class com.marklogic.xcc.SecurityOptions
- Construct a new SecurityOptions instance with the specified SSL context.
- SecurityOptions(SecurityOptions) -
Constructor for class com.marklogic.xcc.SecurityOptions
-
- SemiBufferedContent - Class in com.marklogic.xcc.examples
-
This is a specialized
Content implementation that takes an
InputStream and will either buffer the content of the stream if it's small
enough, or copy the content to a temporary disk file otherwise. - SemiBufferedContent(String, ContentCreateOptions, InputStream, int, File) -
Constructor for class com.marklogic.xcc.examples.SemiBufferedContent
- Instantiate a
Content object that will either buffer the
InputStream or copy it to disk, depending on whether the stream size exceeds
the provided buffer size.
- SemiBufferedContent(String, ContentCreateOptions, InputStream, int) -
Constructor for class com.marklogic.xcc.examples.SemiBufferedContent
- Instantiate a
Content object that will either buffer the
InputStream or copy it to disk, depending on whether the size exceeds the
provided buffer size.
- SEQUENCE -
Static variable in class com.marklogic.xcc.types.ValueType
-
- SequenceType - Class in com.marklogic.xcc.types
- Type indicator class for values that are sequences.
- ServerConnection - Interface in com.marklogic.xcc.spi
- This class encapsulates a server connection as returned from a
ConnectionProvider
instance. - ServerConnectionException - Exception in com.marklogic.xcc.exceptions
- This exception indicates a problem with the connection to the server.
- ServerConnectionException(String, Request) -
Constructor for exception com.marklogic.xcc.exceptions.ServerConnectionException
-
- ServerConnectionException(String, Request, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.ServerConnectionException
-
- ServerResponseException - Exception in com.marklogic.xcc.exceptions
- This exception indicates that an unrecognized response was received from the server.
- ServerResponseException(String, Request, int, String) -
Constructor for exception com.marklogic.xcc.exceptions.ServerResponseException
-
- ServerResponseException(String, Request, int, String, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.ServerResponseException
-
- Session - Interface in com.marklogic.xcc
-
A Session object represents a conversation with a contentbase (database) on a MarkLogic Server
instance (
ContentSource) and holds state information related to that conversation. - Session.TransactionMode - Enum in com.marklogic.xcc
- The transaction mode for the session, which governs how transactions are
created, and whether they are automatically committed.
- setAuthenticationPreemptive(boolean) -
Method in interface com.marklogic.xcc.ContentSource
- Sets whether basic authentication should be attempted preemptively, default is false.
- setAuthenticationPreemptive(boolean) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setAutoRetryDelayMillis(int) -
Method in class com.marklogic.xcc.RequestOptions
- Set the time to delay (in milliseconds) between automatic query retries.
- setBufferSize(int) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set a preferred working buffer size to use for copying to the server.
- setCacheResult(boolean) -
Method in class com.marklogic.xcc.RequestOptions
- Indicates whether the
ResultSequence should be cached.
- setCollections(String[]) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set an array of URIs that represent collections to which the document(s) will be added when
inserted.
- setContentBase(String) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setCount(long) -
Method in interface com.marklogic.xcc.Request
- Set count of result items for this request.
- setDays(int) -
Method in class com.marklogic.xcc.types.Duration
- Sets the days value of this duration.
- setDefaultLogger(Logger) -
Method in interface com.marklogic.xcc.ContentSource
-
Set the default java.util.Logger instance which will be inherited by new
Session
instances.
- setDefaultLogger(Logger) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setDefaultRequestOptions(RequestOptions) -
Method in interface com.marklogic.xcc.Session
- This method accepts an instance of
RequestOptions which acts as the default settings
for invocations of Session.submitRequest(Request).
- setDefaultXQueryVersion(String) -
Method in class com.marklogic.xcc.RequestOptions
- Set the default XQuery version that should apply to this request.
- setEffectivePointInTime(BigInteger) -
Method in class com.marklogic.xcc.RequestOptions
-
Set a point-in-time timestamp value.
- setEnabledCipherSuites(String[]) -
Method in class com.marklogic.xcc.SecurityOptions
-
Set the cipher suites enabled when new XCCS connections are created.
- setEnabledProtocols(String[]) -
Method in class com.marklogic.xcc.SecurityOptions
-
Set the protocol versions enabled when new XCCS connections are created.
- setEncoding(String) -
Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the charset encoding to be used by the server when loading this document.
- setFormat(DocumentFormat) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the format of the document to be created to the given type.
- setFormatBinary() -
Method in class com.marklogic.xcc.ContentCreateOptions
- Convenience method equivalent to
setFormat (DocumentFormat.BINARY);.
- setFormatText() -
Method in class com.marklogic.xcc.ContentCreateOptions
- Convenience method equivalent to
setFormat (DocumentFormat.TEXT);.
- setFormatXml() -
Method in class com.marklogic.xcc.ContentCreateOptions
- Convenience method equivalent to
setFormat (DocumentFormat.XML);.
- setHost(String) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setHours(int) -
Method in class com.marklogic.xcc.types.Duration
- Sets the hours value of this duration.
- setLanguage(String) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the language name to associate with inserted documents.
- setLocale(Locale) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the effective
Locale value for this options object.
- setLocale(Locale) -
Method in class com.marklogic.xcc.RequestOptions
- Set (or clear) the
Locale object to associate with this options instance.
- setLogger(Logger) -
Method in interface com.marklogic.xcc.Session
- Set the Logger instance to which log messages resulting from operations on this Session
should be written.
- setMaxAutoRetry(int) -
Method in class com.marklogic.xcc.RequestOptions
-
The maximum number of times a retryable request will be automatically retried before throwing
an exception.
- setMinutes(int) -
Method in class com.marklogic.xcc.types.Duration
- Sets the minutes value of this duration.
- setModuleUri(String) -
Method in interface com.marklogic.xcc.ModuleInvoke
- Replace the URI associated with this
Request, which specifies an XQuery module
(server-side code) to be invoked on the server.
- setModuleUri(String) -
Method in interface com.marklogic.xcc.ModuleSpawn
- Replace the URI associated with this
Request, which specifies an
XQuery module (server-side code) to be spawned (run asynchronously) on the server.
- setMonths(int) -
Method in class com.marklogic.xcc.types.Duration
- Sets the months value of this duration.
- setNamespace(String) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set a namespace name, which will used as the namespace associated with inserted documents.
- setNewIntegerVariable(String, String, long) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSInteger, binds it to
this Request and then returns the new XSInteger instance.
- setNewIntegerVariable(String, long) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSInteger, binds it to
this Request and then returns the new XSInteger instance.
- setNewStringVariable(String, String, String) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSString, binds it to
this Request and then returns the new XSString instance.
- setNewStringVariable(String, String) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSString, binds it to
this Request and then returns the new XSString instance.
- setNewVariable(XName, XdmValue) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XdmVariable, binds it to this Request and then
returns the new XdmVariable object.
- setNewVariable(String, String, ValueType, Object) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XdmVariable, binds it to this Request and then
returns the new XdmVariable object.
- setNewVariable(String, ValueType, Object) -
Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XdmVariable, binds it to this Request and then
returns the new XdmVariable.
- setOptions(ContentCreateOptions) -
Method in class com.marklogic.xcc.examples.ContentLoader
- Set (or clear) an instance of
ContentCreateOptions which defines creation options to
apply to each document loaded.
- setOptions(RequestOptions) -
Method in interface com.marklogic.xcc.Request
- Associate the given
RequestOptions object with this Request.
- setPassword(String) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setPermissions(ContentPermission[]) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the permissions to be applied when documents are inserted.
- setPlaceKeys(BigInteger[]) -
Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the forest placement keys for this options object as an array of
BigInteger
objects.
- setPlaceKeys(long[]) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the forest placement keys as long values.
- setPort(int) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setPosition(long) -
Method in interface com.marklogic.xcc.Request
- Set starting position of results for this request.
- setQuality(int) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the quality value for this options object, which will set on inserted documents.
- setQuery(String) -
Method in interface com.marklogic.xcc.AdhocQuery
- Replace the XQuery code to be submitted and evaluated with this
Request.
- setRepairLevel(DocumentRepairLevel) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the document repair level for this options object.
- setRequestName(String) -
Method in class com.marklogic.xcc.RequestOptions
- Set a user-defined, name value to be associated with the
Request.
- setRequestOptions(RequestOptions) -
Method in class com.marklogic.xcc.examples.ContentFetcher
-
Set (or clear) the
RequestOptions instance to associate with submitted queries.
- setRequestOptions(RequestOptions) -
Method in class com.marklogic.xcc.examples.ModuleRunner
- Set (or clear) the
RequestOptions instance to associate with submitted queries.
- setRequestOptions(RequestOptions) -
Method in class com.marklogic.xcc.examples.SimpleQueryRunner
- Set (or clear) the
RequestOptions instance to associate with submitted queries.
- setRequestTimeLimit(int) -
Method in class com.marklogic.xcc.RequestOptions
-
Set the "soft" time limit (in seconds) to apply to the submitted request.
- setResolveBufferSize(int) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the entity resulution buffer size.
- setResolveEntities(boolean) -
Method in class com.marklogic.xcc.ContentCreateOptions
- Set the flag indicating whether embedded entities should be resolved during content
insertion.
- setResultBufferSize(int) -
Method in class com.marklogic.xcc.RequestOptions
- Set the suggested
ResultSequence buffer size for this execution.
- setSign(boolean) -
Method in class com.marklogic.xcc.types.Duration
- Sets the sign of this duration, either positive or negative.
- setTimeoutMillis(int) -
Method in class com.marklogic.xcc.RequestOptions
-
Set the timeout value, in milliseconds, for the low-level connection.
- setTimeoutMillis(long) -
Method in interface com.marklogic.xcc.spi.ServerConnection
- Deprecated. Use
ServerConnection.setTimeoutTime(long) instead.
- setTimeoutTime(long) -
Method in interface com.marklogic.xcc.spi.ServerConnection
- Set the exact time, as milliseconds since the epoch, at which this connection is to be
considered expired.
- setTimeZone(TimeZone) -
Method in class com.marklogic.xcc.RequestOptions
- Set (or clear) the
TimeZone object to associate with this options instance.
- setTransactionMode(Session.TransactionMode) -
Method in interface com.marklogic.xcc.Session
-
Sets the transaction mode to the given value.
- setTransactionTimeout(int) -
Method in interface com.marklogic.xcc.Session
- Sets the timeout for transactions
- setUrl(String) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setUser(String) -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setUserObject(Object) -
Method in interface com.marklogic.xcc.Session
- Attach, or clear, an opaque user-provided object to this Session.
- setVariable(XdmVariable) -
Method in interface com.marklogic.xcc.Request
- Associate the given
XdmVariable with this Request.
- setWholeSeconds(long) -
Method in class com.marklogic.xcc.types.Duration
- Sets the seconds value of this duration.
- setYears(int) -
Method in class com.marklogic.xcc.types.Duration
- Sets the years value of this duration.
- shutdown(Logger) -
Method in interface com.marklogic.xcc.spi.ConnectionProvider
- Tell the provider to shutdown and release any resources being used.
- SimpleQueryRunner - Class in com.marklogic.xcc.examples
-
This is a very simple class that will submit an XQuery string to the server and return the
result.
- SimpleQueryRunner(URI) -
Constructor for class com.marklogic.xcc.examples.SimpleQueryRunner
- Construct an instance that will submit query requests to the server represented by the given
URI.
- SingleHostAddress - Interface in com.marklogic.xcc.spi
- This interface should be implemented by
ConnectionProvider
implementations that make socket connections to a single host and port. - size() -
Method in interface com.marklogic.xcc.Content
- The size of the content, if known.
- size() -
Method in class com.marklogic.xcc.examples.OutputStreamContent
- Unknown size.
- size() -
Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- size() -
Method in interface com.marklogic.xcc.ResultSequence
-
Returns the number of
ResultItems, if known, in this ResultSequence.
- size() -
Method in interface com.marklogic.xcc.types.XdmSequence
- Returns the size of this XdmSequence.
- spawnThread(Runnable) -
Static method in class com.marklogic.xcc.examples.OutputStreamInserter
- Create and start a new
Thread for the given Runnable.
- StreamingResultException - Exception in com.marklogic.xcc.exceptions
- This unchecked (runtime) exception may be thrown by some methods of streaming
ResultSequence objects if an IOException occurs while
processing the streaming data. - StreamingResultException(String, ResultSequence, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.StreamingResultException
-
- StreamingResultException(ResultSequence, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.StreamingResultException
-
- submitRequest(Request) -
Method in interface com.marklogic.xcc.Session
- Submit a
Request to the contentbase and return the (possibly empty)
ResultSequence.
T
- TEXT -
Static variable in class com.marklogic.xcc.DocumentFormat
- Document format = text()
- TEXT -
Static variable in class com.marklogic.xcc.types.ValueType
-
- toArray() -
Method in interface com.marklogic.xcc.types.XdmSequence
- Construct an array of
XdmItems from this XdmSequence.
- toCached() -
Method in interface com.marklogic.xcc.ResultSequence
- Produce a cached version of this ResultSequence.
- toHttpBasicAuth() -
Method in interface com.marklogic.xcc.UserCredentials
- Returns an HTTP basic authentication string.
- toHttpDigestAuth(String, String, String) -
Method in interface com.marklogic.xcc.UserCredentials
- Returns an HTTP digest authentication string.
- toResultItemArray() -
Method in interface com.marklogic.xcc.ResultSequence
-
This method is identical to the superclass method
XdmSequence.toArray(), but returns an array
typed as ResultItem.
- toString() -
Method in class com.marklogic.xcc.ContentCapability
- A human-readable name.
- toString() -
Method in class com.marklogic.xcc.ContentPermission
-
- toString() -
Method in class com.marklogic.xcc.DocumentFormat
- The name of this format: "xml", "text" or "binary".
- toString() -
Method in class com.marklogic.xcc.DocumentRepairLevel
- The name of this repair level: "none" or "full".
- toString() -
Method in exception com.marklogic.xcc.exceptions.RequestException
-
- toString() -
Method in exception com.marklogic.xcc.exceptions.XQueryException
- Returns a string representation (possibly multiline) of the XQuery error message and stack
frame.
- toString() -
Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- toString() -
Method in class com.marklogic.xcc.ResultChannelName
-
- toString() -
Method in interface com.marklogic.xcc.ResultSequence
- Return a textual description of this ResultSequence object, NOT the value of
the items in the sequence.
- toString() -
Method in class com.marklogic.xcc.spi.ConnectionErrorAction
-
- toString() -
Method in class com.marklogic.xcc.types.Duration
- Formats this duration object as a String in the format prescribed in the W3C description of
XML datatypes for a duration.
- toString() -
Method in class com.marklogic.xcc.types.ValueType
- The name of this XQuery type, as a string.
- toString() -
Method in interface com.marklogic.xcc.types.XdmSequence
- Return a textual description of this XdmSequence object, NOT the value of
the items in the sequence.
- toString() -
Method in class com.marklogic.xcc.types.XName
-
U
- UnexpectedResponseException - Exception in com.marklogic.xcc.exceptions
- This exception indicates that an unrecognized response was received from
the server while parsing the HTTP header of the message.
- UnexpectedResponseException(String, String) -
Constructor for exception com.marklogic.xcc.exceptions.UnexpectedResponseException
-
- UnimplementedFeatureException - Exception in com.marklogic.xcc.exceptions
- This exception indicates either that some planned feature is not yet implemented in the current
version of XCC, or that the server to which it is connecting does not support some the operation.
- UnimplementedFeatureException(String) -
Constructor for exception com.marklogic.xcc.exceptions.UnimplementedFeatureException
-
- UPDATE -
Static variable in class com.marklogic.xcc.ContentCapability
- Updates are allowed
- UPDATE -
Static variable in class com.marklogic.xcc.ContentPermission
- Convenience reference to
ContentCapability.UPDATE
- UserCredentials - Interface in com.marklogic.xcc
- This interface encapsulates a user identity.
V
- ValueFactory - Class in com.marklogic.xcc
-
This class contains various static factory methods that return instances of
XdmValue and
XdmVariable. - valueOf(String) -
Static method in enum com.marklogic.xcc.Session.TransactionMode
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in class com.marklogic.xcc.types.ValueType
-
- values() -
Static method in enum com.marklogic.xcc.Session.TransactionMode
- Returns an array containing the constants of this enum type, in
the order they are declared.
- ValueType - Class in com.marklogic.xcc.types
- Base class for the typesafe enumeration objects that represent XML Schema types.
- Version - Class in com.marklogic.xcc
- Auto-generated class that defines the XCC release number.
W
- WARNINGS -
Static variable in class com.marklogic.xcc.ResultChannelName
- Any warnings related to the result.
- writeTo(Writer) -
Method in interface com.marklogic.xcc.types.XdmItem
- Write the value of this item to the provided
Writer object.
- writeTo(OutputStream) -
Method in interface com.marklogic.xcc.types.XdmItem
- Write the value of this item to the provided
OutputStream object.
X
- XA - Class in com.marklogic.xcc.examples
-
- XA() -
Constructor for class com.marklogic.xcc.examples.XA
-
- XccConfigException - Exception in com.marklogic.xcc.exceptions
- This exception indicates a configuration problem.
- XccConfigException(String) -
Constructor for exception com.marklogic.xcc.exceptions.XccConfigException
-
- XccConfigException(String, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.XccConfigException
-
- XccException - Exception in com.marklogic.xcc.exceptions
- Superclass of all exceptions specific to XCC.
- XccException(String) -
Constructor for exception com.marklogic.xcc.exceptions.XccException
-
- XccException(String, Throwable) -
Constructor for exception com.marklogic.xcc.exceptions.XccException
-
- XdmAtomic - Interface in com.marklogic.xcc.types
- Marker interface for all
XdmItem value objects which are atomic (not nodes). - XdmAttribute - Interface in com.marklogic.xcc.types
- An XQuery value which is an attribute().
- XdmBinary - Interface in com.marklogic.xcc.types
- An XDM-like binary() value (binary() is a MarkLogic extension).
- XdmComment - Interface in com.marklogic.xcc.types
- An XQuery value which is an comment().
- XdmDocument - Interface in com.marklogic.xcc.types
- An XDM value which is a document().
- XdmDuration - Interface in com.marklogic.xcc.types
- A Java representation of xs:duration.
- XdmElement - Interface in com.marklogic.xcc.types
- An XQuery value which is an element().
- XdmItem - Interface in com.marklogic.xcc.types
- Base class for XQuery item values (values that may be a member of a sequence).
- XdmNode - Interface in com.marklogic.xcc.types
- An XDM value which is a node().
- XdmProcessingInstruction - Interface in com.marklogic.xcc.types
- An XQuery value which is a processing-instruction().
- XdmSequence<I extends XdmItem> - Interface in com.marklogic.xcc.types
- A
XdmValue which is a sequence of Items. - XdmText - Interface in com.marklogic.xcc.types
- An XQuery text() value.
- XdmValue - Interface in com.marklogic.xcc.types
- Base interface for XML Data Model (XDM) values represented as Java objects.
- XdmVariable - Interface in com.marklogic.xcc.types
- A named XDM variable (an XName / XdmValue pair).
- XML -
Static variable in class com.marklogic.xcc.DocumentFormat
- Document format = XML node()
- XName - Class in com.marklogic.xcc.types
- An Expanded Name, consisting of a (optional) namespace name and a local name.
- XName(String, String) -
Constructor for class com.marklogic.xcc.types.XName
- Construct an XName with the given namespace name and local name.
- XName(String) -
Constructor for class com.marklogic.xcc.types.XName
- Construct an XName with the given local name in the default namespace.
- XQueryException - Exception in com.marklogic.xcc.exceptions
- A server exception resulting from an error encountered while evaluating XQuery.
- XQueryException(Request, String, String, String, String, String, String, boolean, String[], XQueryStackFrame[]) -
Constructor for exception com.marklogic.xcc.exceptions.XQueryException
- Constructs an XQueryException
- XQueryStackFrame - Class in com.marklogic.xcc.exceptions
- An XQuery evaluator stack frame.
- XQueryStackFrame(String, int, String, XdmVariable[], String, int, String) -
Constructor for class com.marklogic.xcc.exceptions.XQueryStackFrame
- Construct a stack frame.
- XS_ANY_URI -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_BASE64_BINARY -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_BOOLEAN -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_DATE -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_DATE_TIME -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_DAY_TIME_DURATION -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_DECIMAL -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_DOUBLE -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_DURATION -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_FLOAT -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_GDAY -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_GMONTH -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_GMONTH_DAY -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_GYEAR -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_GYEAR_MONTH -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_HEX_BINARY -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_INTEGER -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_QNAME -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_STRING -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_TIME -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_UNTYPED_ATOMIC -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XS_YEAR_MONTH_DURATION -
Static variable in class com.marklogic.xcc.types.ValueType
-
- XSAnyURI - Interface in com.marklogic.xcc.types
- XDM type: xs:anyURI.
- XSBase64Binary - Interface in com.marklogic.xcc.types
- XDM type: xs:base64Binary.
- XSBoolean - Interface in com.marklogic.xcc.types
- XDM type: xs:boolean.
- XSDate - Interface in com.marklogic.xcc.types
- XDM type: xs:date.
- XSDateTime - Interface in com.marklogic.xcc.types
- XDM type: xs:dateTime.
- XSDayTimeDuration - Interface in com.marklogic.xcc.types
- XDM type: xs:dayTimeDuration.
- XSDecimal - Interface in com.marklogic.xcc.types
- XDM type: xs:decimal.
- XSDouble - Interface in com.marklogic.xcc.types
- XDM type: xs:double.
- XSDuration - Interface in com.marklogic.xcc.types
- XDM type: xs:duration.
- XSFloat - Interface in com.marklogic.xcc.types
- XDM type: xs:float.
- XSGDay - Interface in com.marklogic.xcc.types
- XDM type: xs:gDay.
- XSGMonth - Interface in com.marklogic.xcc.types
- XDM type: xs:gMonth.
- XSGMonthDay - Interface in com.marklogic.xcc.types
- XDM type: xs:gMonthDay.
- XSGYear - Interface in com.marklogic.xcc.types
- XDM type: xs:gYear.
- XSGYearMonth - Interface in com.marklogic.xcc.types
- XDM type: xs:gYearMonth.
- XSHexBinary - Interface in com.marklogic.xcc.types
- XDM type: xs:hexBinary.
- XSInteger - Interface in com.marklogic.xcc.types
- XDM type: xs:integer.
- XSQName - Interface in com.marklogic.xcc.types
- XDM type: xs:QName.
- XSString - Interface in com.marklogic.xcc.types
- XDM type: xs:string.
- XSTime - Interface in com.marklogic.xcc.types
- XDM type: xs:time.
- XSUntypedAtomic - Interface in com.marklogic.xcc.types
- XDM type: xdt:untypedAtomic.
- XSYearMonthDuration - Interface in com.marklogic.xcc.types
- XDM type: xs:yearMonthDuration.
A B C D E F G H I L M N O P Q R S T U V W X
Copyright © 2013 MarkLogic Corporation. All Rights Reserved.
Complete online documentation for MarkLogic Server,
XQuery and related components may be found at
developer.marklogic.com