Berkeley DB XML: C++ Handle Methods (version 2.4.13)

Implemented

C++ Handle Methods

Description

 

DbXml::dbxml_version

Get the release number.

 

DbXml::setLogCategory

Set the logging category.

 

DbXml::setLogLevel

Set the logging level.

OK

XmlContainer

An XmlContainer.

 OK

XmlContainer::addAlias

Adds a alias for the container name.

 

XmlContainer::addDefaultIndex

Add a default index to the container.

 OK

XmlContainer::addIndex

Adds an index specification.

 OK

XmlContainer::deleteDefaultIndex

Delete the container's default index.

 OK

XmlContainer::deleteDocument

Delete a document from the container.

 OK

XmlContainer::deleteIndex

Delete the specified index.

 OK

XmlContainer::getAllDocuments

Get all documents in the container.

OK

XmlContainer::getContainerType

Get the container's type.

OK

XmlContainer::getDocument

Get the specified document.

 OK

XmlContainer::getFlags

Get the flags used to open the container.

 OK

XmlContainer::getIndexNodes

Return true if indexing nodes.

 OK

XmlContainer::getIndexSpecification

Get the index specification.

 

XmlContainer::getManager

Get the XmlManager object for this container.

OK

XmlContainer::getName

Get the container's name.

 OK

XmlContainer::getNode

Get the specified node.

 OK

XmlContainer::getNumDocuments

Get the number of documents in the container.

OK

XmlContainer::getPageSize

Return database page size.

 

XmlContainer::lookupIndex

Return all the documents matching a specified index.

 

XmlContainer::lookupStatistics

Return an XmlStatistics object for a specified index.

 

XmlContainer::putDocumentAsEventWriter

Add a document to the container using XmlEventWriter.

 OK

XmlContainer::putDocument

Add a document to the container.

 OK

XmlContainer::removeAlias

Remove a named alias for the container.

 OK

XmlContainer::replaceDefaultIndex

Replace the container's default index.

 OK

XmlContainer::replaceIndex

Replace an index of a specified type.

 OK

XmlContainer::setIndexSpecification

Set the index specification.

 OK

XmlContainer::sync

Flush container database state to disk.

 OK

XmlContainer::updateDocument

Update an existing XmlDocument

OK

XmlDocument

An XmlDocument.

 OK

XmlDocument::fetchAllData

Retrieve all document content and metadata.

OK

XmlDocument::getContent

Retrieve content.

 

XmlDocument::getContentAsEventReader

Retrieve content as an XmlEventReader.

 

XmlDocument::getContentAsEventWriter

Retrieve content into an XmlEventWriter.

 

XmlDocument::getContentAsXmlInputStream

Retrieve content as an input stream.

 

XmlDocument::getMetaData

Retrieve a single metadata value.

 

XmlDocument::getMetaDataIterator

Get an XmlMetaDataIterator.

OK

XmlDocument::getName

Get the document's name.

 

XmlDocument::removeMetaData

Removes a single metadata value.

 

XmlDocument::setContentAsEventReader

Set the document's content from an XmlEventReader.

 

XmlDocument::setContentAsXmlInputStream

Set the document's content from an input stream.

 

XmlDocument::setContent

Set the document's content.

 

XmlDocument::setMetaData

Set a metadata value for the document.

OK

XmlDocument::setName

Set the document's name.

 

XmlEventReader

Read XML events.

 

XmlEventReader::close

Release resources for reader.

 

XmlEventReader::getAttributeCount

Return the number of attributes for an element event.

 

XmlEventReader::getAttributeLocalName

Get attribute's local name.

 

XmlEventReader::getAttributeNamespaceURI

Get attribute's namespace URI.

 

XmlEventReader::getAttributePrefix

Get attribute's namespace prefix.

 

XmlEventReader::getAttributeValue

Get attribute's value.

 

XmlEventReader::encodingSet

Check if the encoding is explicitly set.

 

XmlEventReader::getEncoding

Return the encoding of the document.

 

XmlEventReader::getSystemId

Return the System ID for for the document.

 

XmlEventReader::getVersion

Return the XML version string for the document.

 

XmlEventReader::isStandalone

Check if document is standalone XML.

 

XmlEventReader::standaloneSet

Check if the standalone attribute is set.

 

XmlEventReader::getEventType

Return the type of the current event.

 

XmlEventReader::getLocalName

Return the name of the current element event.

 

XmlEventReader::getNamespaceURI

Return the namespace URI of the current element event.

 

XmlEventReader::getPrefix

Return the namespace prefix for the current element event.

 

XmlEventReader::getValue

Return the value of the current event.

 

XmlEventReader::hasEmptyElementInfo

Check if object will return empty element state.

 

XmlEventReader::hasEntityEscapeInfo

Check if object has information about entities.

 

XmlEventReader::hasNext

Check if there are more events.

 

XmlEventReader::isAttributeSpecified

Check if an attribute is specified.

 

XmlEventReader::isEmptyElement

Check current element is empty.

 

XmlEventReader::isWhiteSpace

Check if current text value is white space.

 

XmlEventReader::needsEntityEscape

Check if text or attribute value needs escaping.

 

XmlEventReader::nextTag

Move to the next StartElement or EndElement event.

 

XmlEventReader::next

Move to the next event.

 

XmlEventReader::getExpandEntities

Get whether to expand entities.

 

XmlEventReader::setExpandEntities

Set whether to expand entities.

 

XmlEventReader::getReportEntityInfo

Get whether to report entity information.

 

XmlEventReader::setReportEntityInfo

Set whether to report entity information.

 

XmlEventReaderToWriter

Convert XmlEventReader to XmlEventWriter

 

XmlEventReaderToWriter::start

Begin processing events.

 

XmlEventWriter

Write XML events.

 

XmlEventWriter::close

Release resources for the writer.

 

XmlEventWriter::writeAttribute

Write an attribute.

 

XmlEventWriter::writeDTD

Write a DTD or reference.

 

XmlEventWriter::writeEndDocument

Write an EndDocument event.

 

XmlEventWriter::writeEndElement

Write an EndElement event.

 

XmlEventWriter::writeEndEntity

Write an EndEntity event.

 

XmlEventWriter::writeProcessingInstruction

Write a ProcessingInstruction.

 

XmlEventWriter::writeStartDocument

Write a StartDocument event.

 

XmlEventWriter::writeStartElement

Write a StartElement event.

 

XmlEventWriter::writeStartEntity

Write a StartEntityReference event.

 

XmlEventWriter::writeText

Write a Text event.

OK

XmlException

BDB XML exceptions.

NO

XmlException::getDbErrno

Get DB error number.

OK

XmlException::getExceptionCode

Get ExceptionCode.

OK

XmlException::getQueryColumn

Get column for query error.

OK

XmlException::getQueryFile

Get file for query error.

OK

XmlException::getQueryLine

Get line for query error.

OK

XmlException::what

Get error string.

 

XmlIndexLookup

An XmlIndexLookup.

 

XmlIndexLookup::execute

Execute the index lookup operation.

 

XmlIndexLookup::setContainer

Set the target container for the lookup.

 

XmlIndexLookup::setHighBound

Set the high bound for a range lookup.

 

XmlIndexLookup::setIndex

Set the index to be used for the lookup.

 

XmlIndexLookup::setLowBound

Set the lower bound for the lookup.

 

XmlIndexLookup::setNode

Set the target node name for the lookup.

 

XmlIndexLookup::setParent

Set the parent node for edge index lookups.

OK

XmlIndexSpecification

An XmlIndexSpecification.

OK

XmlIndexSpecification::addDefaultIndex

Add a default index.

OK

XmlIndexSpecification::addIndex

Add an index

OK

XmlIndexSpecification::deleteDefaultIndex

Delete the index from the default specification.

OK

XmlIndexSpecification::deleteIndex

Delete an index.

OK

XmlIndexSpecification::find

Find the index for a specific node.

OK

XmlIndexSpecification::getDefaultIndex

Get the default index.

OK

XmlIndexSpecification::next

Get the next index in the index specification.

OK

XmlIndexSpecification::replaceDefaultIndex

Replace the default index.

OK

XmlIndexSpecification::replaceIndex

Replace the index for a node.

OK

XmlIndexSpecification::reset

Reset the index iterator.

 

XmlInputStream

An XmlInputStream

 

XmlInputStream::curPos

Return the current position in the stream.

 

XmlInputStream::readBytes

Read bytes from the stream.

OK

XmlManager

An XmlManager.

OK

XmlManager::compactContainer

Compact the databases comprising the container.

OK

XmlManager::createContainer

Create an XmlContainer

OK

XmlManager::createDocument

Instantiate an XmlDocument object.

 

XmlManager::createIndexLookup

Instantiate an XmlIndexLookup object.

 

XmlManager::createLocalFileInputStream

Create an input stream to a file on disk.

 

XmlManager::createMemBufInputStream

Create an input stream to a memory buffer.

OK

XmlManager::createModify

Instantiate an XmlModify object.

OK

XmlManager::createQueryContext

Instantiate an XmlQueryContext object.

OK

XmlManager::createResults

Instantiate an empty XmlResults object.

 

XmlManager::createStdInInputStream

Create an input stream to the console.

OK

XmlManager::createTransaction

Instantiate an XmlTransaction object.

 

XmlManager::createURLInputStream

Create an input stream to the specified URL.

OK

XmlManager::createUpdateContext

Instantiate an XmlUpdateContext object.

 

XmlManager::dumpContainer

Dump the container.

OK

XmlManager::existsContainer

Determine if container exists.

 

XmlManager::getDbEnv

Get the database environment.

OK

XmlManager::getFlags

Get the flags used to open the manager.

OK

XmlManager::getHome

Get the environment home directory.

OK

XmlManager::getImplicitTimezone

Get the implicit timezone used for queries.

 

XmlManager::loadContainer

Load the container.

OK

XmlManager::openContainer

Open an already existing XmlContainer.

OK

XmlManager::prepare

Get an XmlQueryExpression object.

OK

XmlManager::query

Execute a query.

 

XmlManager::registerResolver

The XmlResolver that implements file resolution policy.

OK

XmlManager::reindexContainer

Reindex the container.

OK

XmlManager::removeContainer

Delete the container.

OK

XmlManager::renameContainer

Rename the container.

OK

XmlManager::setDefaultContainerFlags

Set the default flags.

OK

XmlManager::setDefaultContainerType

Set the default container type.

OK

XmlManager::setDefaultPageSize

Set the underlying database page size.

OK

XmlManager::setDefaultSequenceIncrement

Set the sequence number generation cache size.

OK

XmlManager::setImplicitTimezone

Set the implicit timezone used for queries.

 

XmlManager::truncateContainer

Truncate the container.

 

XmlManager::upgradeContainer

Upgrade the container.

 

XmlManager::verifyContainer

Verify the container.

 

XmlMetaDataIterator

A metadata iterator.

 

XmlMetaDataIterator::next

Retrieve the next metadata item.

 

XmlMetaDataIterator::reset

Retrieve the first metadata item.

OK

XmlModify

A document modification class.

OK

XmlModify::addAppendStep

Append content to the targeted nodes.

OK

XmlModify::addInsertAfterStep

Insert after a targeted node.

OK

XmlModify::addInsertBeforeStep

Insert before a targeted node.

OK

XmlModify::addRemoveStep

Remove a node.

OK

XmlModify::addRenameStep

Rename the targeted node.

OK

XmlModify::addUpdateStep

Replace the targeted node's content.

OK

XmlModify::execute

Execute the modifications.

 

XmlModify::setNewEncoding

Sets a new document encoding.

OK

XmlQueryContext

An XQuery query context

OK

XmlQueryContext::clearNamespaces

Remove all namespaces.

OK

XmlQueryContext::getReturnType

Get the return type.

OK

XmlQueryContext::interruptQuery

Interrupt a running query.

OK

XmlQueryContext::removeNamespace

Remove the specified namespace.

OK

XmlQueryContext::getBaseURI

Gets the Base URI.

OK

XmlQueryContext::setBaseURI

Sets the Base URI.

OK

XmlQueryContext::setDefaultCollection

Set default collection for fn:collection().

OK

XmlQueryContext::getEvaluationType

Get the evaluation type.

OK

XmlQueryContext::setEvaluationType

Set the evaluation type.

OK

XmlQueryContext::getNamespace

Retrieve a namespace URI.

OK

XmlQueryContext::setNamespace

Add a namespace.

OK

XmlQueryContext::getQueryTimeoutSeconds

Get query timeout value.

OK

XmlQueryContext::setQueryTimeoutSeconds

Set query timeout value.

OK

XmlQueryContext::setReturnType

Set the return type.

OK

XmlQueryContext::getVariableValue

Return the variable's value.

OK

XmlQueryContext::setVariableValue

Set an external XQuery variable.

OK

XmlQueryExpression

An XmlQueryExpression.

OK

XmlQueryExpression::execute

Evaluate the query.

OK

XmlQueryExpression::getQuery

Return the query as a string.

OK

XmlQueryExpression::isUpdateExpression

Returns true if the query is an updating expression.

 

XmlResolver

Base class for file resolution policy.

 

XmlResolver::resolveCollection

Resolve URI to an XmlResults.

 

XmlResolver::resolveDocument

Resolve URI to an XmlValue.

 

XmlResolver::resolveEntity

Resolve an entity to an XmlInputStream.

 

XmlResolver::resolveModuleLocation

Resolve an XQuery module namespace to locations.

 

XmlResolver::resolveModule

Resolve an XQuery module reference.

 

XmlResolver::resolveSchema

Resolve schema to an XmlInputStream.

OK

XmlResults

Query results.

OK

XmlResults::add

Adds an XmlValue to the end of the result set.

OK

XmlResults::getEvaluationType

Returns the evaluation type of the result set.

OK

XmlResults::hasNext

Is there another value in the results set.

OK

XmlResults::hasPrevious

Is there a previous value in the results set.

OK

XmlResults::next

Retrieve the next element in the results set.

OK

XmlResults::peek

Retrieve current value with no iterator movement.

OK

XmlResults::previous

Retrieve the previous element in the result set.

OK

XmlResults::reset

The iterator is placed at the beginning of the result set.

OK

XmlResults::size

Returns the number of elements in the result set.

 

XmlStatistics

Encapsulates index statistics.

 

XmlStatistics::getNumberOfIndexedKeys

The total number of index keys.

 

XmlStatistics::getNumberOfUniqueKeys

The number of unique index keys.

OK

XmlTransaction

Transaction object.

OK

XmlTransaction::abort

Abort a transaction.

OK

XmlTransaction::commit

Commit a transaction.

OK

XmlTransaction::createChild

Create a child transaction.

NO

XmlTransaction::getDbTxn

Get the underlying DbTxn object.

OK

XmlUpdateContext

An XmlUpdateContext

OK

XmlValue

A single result value.

OK

XmlValue::asBoolean

Return value as a boolean.

OK

XmlValue::asDocument

Return value as XmlDocument.

 

XmlValue::asEventReader

Return value as XmlEventReader.

OK

XmlValue::asNumber

Return value as a double.

OK

XmlValue::asString

Return value as a string.

OK

XmlValue::equals

Compare two XmlValue objects.

OK

XmlValue::getAttributes

Get the node's attributes.

OK

XmlValue::getFirstChild

Get the node's first child.

OK

XmlValue::getLastChild

Get the node's last child.

OK

XmlValue::getLocalName

Get the node's local name.

OK

XmlValue::getNamespaceURI

Get the node's namespace URI.

OK

XmlValue::getNextSibling

Get the node's next sibling node.

OK

XmlValue::getNodeHandle

Return a string node handle for the value.

OK

XmlValue::getNodeName

Get the name of the node value.

OK

XmlValue::getNodeType

Get the node type of the node.

OK

XmlValue::getNodeValue

Get the value of the node.

OK

XmlValue::getOwnerElement

Get the node's owner element.

OK

XmlValue::getParentNode

Get the node's parent node.

OK

XmlValue::getPrefix

Get the node's namespace prefix.

OK

XmlValue::getPreviousSibling

Get the node's previous sibling node.

OK

XmlValue::getTypeName

Get the name of the type.

OK

XmlValue::getTypeURI

Get the URI for the type.

OK

XmlValue::getType

Get the type enumeration of the value.

OK

XmlValue::isBinary

Check if value is binary.

OK

XmlValue::isBoolean

Check if value is a boolean.

OK

XmlValue::isNode

Check if value is node.

OK

XmlValue::isNull

Check if the value is initialized.

OK

XmlValue::isNumber

Check if value is a number .

OK

XmlValue::isString

Check if value is a string .

OK

XmlValue::isType

Check type of value.

OK

XmlValue::operator==

Compare two XmlValue objects.

Copyright (c) 1996,2007 Oracle. All rights reserved.