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

C++ Handle MethodsDescription
DbXml::dbxml_versionGet the release number.
DbXml::setLogCategorySet the logging category.
DbXml::setLogLevelSet the logging level.
XmlContainerAn XmlContainer.
XmlContainer::addAliasAdds a alias for the container name.
XmlContainer::addDefaultIndexAdd a default index to the container.
XmlContainer::addIndexAdds an index specification.
XmlContainer::deleteDefaultIndexDelete the container's default index.
XmlContainer::deleteDocumentDelete a document from the container.
XmlContainer::deleteIndexDelete the specified index.
XmlContainer::getAllDocumentsGet all documents in the container.
XmlContainer::getContainerTypeGet the container's type.
XmlContainer::getDocumentGet the specified document.
XmlContainer::getFlagsGet the flags used to open the container.
XmlContainer::getIndexNodesReturn true if indexing nodes.
XmlContainer::getIndexSpecificationGet the index specification.
XmlContainer::getManagerGet the XmlManager object for this container.
XmlContainer::getNameGet the container's name.
XmlContainer::getNodeGet the specified node.
XmlContainer::getNumDocumentsGet the number of documents in the container.
XmlContainer::getPageSizeReturn database page size.
XmlContainer::lookupIndexReturn all the documents matching a specified index.
XmlContainer::lookupStatisticsReturn an XmlStatistics object for a specified index.
XmlContainer::putDocumentAsEventWriterAdd a document to the container using XmlEventWriter.
XmlContainer::putDocumentAdd a document to the container.
XmlContainer::removeAliasRemove a named alias for the container.
XmlContainer::replaceDefaultIndexReplace the container's default index.
XmlContainer::replaceIndexReplace an index of a specified type.
XmlContainer::setIndexSpecificationSet the index specification.
XmlContainer::syncFlush container database state to disk.
XmlContainer::updateDocumentUpdate an existing XmlDocument
XmlDocumentAn XmlDocument.
XmlDocument::fetchAllDataRetrieve all document content and metadata.
XmlDocument::getContentRetrieve content.
XmlDocument::getContentAsDOMRetrieve content as a XercesC DOM.
XmlDocument::getContentAsEventReaderRetrieve content as an XmlEventReader.
XmlDocument::getContentAsEventWriterRetrieve content into an XmlEventWriter.
XmlDocument::getContentAsXmlInputStreamRetrieve content as an input stream.
XmlDocument::getMetaDataRetrieve a single metadata value.
XmlDocument::getMetaDataIteratorGet an XmlMetaDataIterator.
XmlDocument::getNameGet the document's name.
XmlDocument::removeMetaDataRemoves a single metadata value.
XmlDocument::setContentAsDOMSet the document's content from a DOM.
XmlDocument::setContentAsEventReaderSet the document's content from an XmlEventReader.
XmlDocument::setContentAsXmlInputStreamSet the document's content from an input stream.
XmlDocument::setContentSet the document's content.
XmlDocument::setMetaDataSet a metadata value for the document.
XmlDocument::setNameSet the document's name.
XmlEventReaderRead XML events.
XmlEventReader::closeRelease resources for reader.
XmlEventReader::getAttributeCountReturn the number of attributes for an element event.
XmlEventReader::getAttributeLocalNameGet attribute's local name.
XmlEventReader::getAttributeNamespaceURIGet attribute's namespace URI.
XmlEventReader::getAttributePrefixGet attribute's namespace prefix.
XmlEventReader::getAttributeValueGet attribute's value.
XmlEventReader::encodingSetCheck if the encoding is explicitly set.
XmlEventReader::getEncodingReturn the encoding of the document.
XmlEventReader::getSystemIdReturn the System ID for for the document.
XmlEventReader::getVersionReturn the XML version string for the document.
XmlEventReader::isStandaloneCheck if document is standalone XML.
XmlEventReader::standaloneSetCheck if the standalone attribute is set.
XmlEventReader::getEventTypeReturn the type of the current event.
XmlEventReader::getLocalNameReturn the name of the current element event.
XmlEventReader::getNamespaceURIReturn the namespace URI of the current element event.
XmlEventReader::getPrefixReturn the namespace prefix for the current element event.
XmlEventReader::getValueReturn the value of the current event.
XmlEventReader::hasEmptyElementInfoCheck if object will return empty element state.
XmlEventReader::hasEntityEscapeInfoCheck if object has information about entities.
XmlEventReader::hasNextCheck if there are more events.
XmlEventReader::isAttributeSpecifiedCheck if an attribute is specified.
XmlEventReader::isEmptyElementCheck current element is empty.
XmlEventReader::isWhiteSpaceCheck if current text value is white space.
XmlEventReader::needsEntityEscapeCheck if text or attribute value needs escaping.
XmlEventReader::nextTagMove to the next StartElement or EndElement event.
XmlEventReader::nextMove to the next event.
XmlEventReader::getExpandEntitiesGet whether to expand entities.
XmlEventReader::setExpandEntitiesSet whether to expand entities.
XmlEventReader::getReportEntityInfoGet whether to report entity information.
XmlEventReader::setReportEntityInfoSet whether to report entity information.
XmlEventReaderToWriterConvert XmlEventReader to XmlEventWriter
XmlEventReaderToWriter::startBegin processing events.
XmlEventWriterWrite XML events.
XmlEventWriter::closeRelease resources for the writer.
XmlEventWriter::writeAttributeWrite an attribute.
XmlEventWriter::writeDTDWrite a DTD or reference.
XmlEventWriter::writeEndDocumentWrite an EndDocument event.
XmlEventWriter::writeEndElementWrite an EndElement event.
XmlEventWriter::writeEndEntityWrite an EndEntity event.
XmlEventWriter::writeProcessingInstructionWrite a ProcessingInstruction.
XmlEventWriter::writeStartDocumentWrite a StartDocument event.
XmlEventWriter::writeStartElementWrite a StartElement event.
XmlEventWriter::writeStartEntityWrite a StartEntityReference event.
XmlEventWriter::writeTextWrite a Text event.
XmlExceptionBDB XML exceptions.
XmlException::getDbErrnoGet DB error number.
XmlException::getExceptionCodeGet ExceptionCode.
XmlException::getQueryColumnGet column for query error.
XmlException::getQueryFileGet file for query error.
XmlException::getQueryLineGet line for query error.
XmlException::whatGet error string.
XmlIndexLookupAn XmlIndexLookup.
XmlIndexLookup::executeExecute the index lookup operation.
XmlIndexLookup::setContainerSet the target container for the lookup.
XmlIndexLookup::setHighBoundSet the high bound for a range lookup.
XmlIndexLookup::setIndexSet the index to be used for the lookup.
XmlIndexLookup::setLowBoundSet the lower bound for the lookup.
XmlIndexLookup::setNodeSet the target node name for the lookup.
XmlIndexLookup::setParentSet the parent node for edge index lookups.
XmlIndexSpecificationAn XmlIndexSpecification.
XmlIndexSpecification::addDefaultIndexAdd a default index.
XmlIndexSpecification::addIndexAdd an index
XmlIndexSpecification::deleteDefaultIndexDelete the index from the default specification.
XmlIndexSpecification::deleteIndexDelete an index.
XmlIndexSpecification::findFind the index for a specific node.
XmlIndexSpecification::getDefaultIndexGet the default index.
XmlIndexSpecification::nextGet the next index in the index specification.
XmlIndexSpecification::replaceDefaultIndexReplace the default index.
XmlIndexSpecification::replaceIndexReplace the index for a node.
XmlIndexSpecification::resetReset the index iterator.
XmlInputStreamAn XmlInputStream
XmlInputStream::curPosReturn the current position in the stream.
XmlInputStream::readBytesRead bytes from the stream.
XmlManagerAn XmlManager.
XmlManager::compactContainerCompact the databases comprising the container.
XmlManager::createContainerCreate an XmlContainer
XmlManager::createDocumentInstantiate an XmlDocument object.
XmlManager::createIndexLookupInstantiate an XmlIndexLookup object.
XmlManager::createLocalFileInputStreamCreate an input stream to a file on disk.
XmlManager::createMemBufInputStreamCreate an input stream to a memory buffer.
XmlManager::createModifyInstantiate an XmlModify object.
XmlManager::createQueryContextInstantiate an XmlQueryContext object.
XmlManager::createResultsInstantiate an empty XmlResults object.
XmlManager::createStdInInputStreamCreate an input stream to the console.
XmlManager::createTransactionInstantiate an XmlTransaction object.
XmlManager::createURLInputStreamCreate an input stream to the specified URL.
XmlManager::createUpdateContextInstantiate an XmlUpdateContext object.
XmlManager::dumpContainerDump the container.
XmlManager::existsContainerDetermine if container exists.
XmlManager::getDbEnvGet the database environment.
XmlManager::getFlagsGet the flags used to open the manager.
XmlManager::getHomeGet the environment home directory.
XmlManager::getImplicitTimezoneGet the implicit timezone used for queries.
XmlManager::loadContainerLoad the container.
XmlManager::openContainerOpen an already existing XmlContainer.
XmlManager::prepareGet an XmlQueryExpression object.
XmlManager::queryExecute a query.
XmlManager::registerResolverThe XmlResolver that implements file resolution policy.
XmlManager::reindexContainerReindex the container.
XmlManager::removeContainerDelete the container.
XmlManager::renameContainerRename the container.
XmlManager::setDefaultContainerFlagsSet the default flags.
XmlManager::setDefaultContainerTypeSet the default container type.
XmlManager::setDefaultPageSizeSet the underlying database page size.
XmlManager::setDefaultSequenceIncrementSet the sequence number generation cache size.
XmlManager::setImplicitTimezoneSet the implicit timezone used for queries.
XmlManager::truncateContainerTruncate the container.
XmlManager::upgradeContainerUpgrade the container.
XmlManager::verifyContainerVerify the container.
XmlMetaDataIteratorA metadata iterator.
XmlMetaDataIterator::nextRetrieve the next metadata item.
XmlMetaDataIterator::resetRetrieve the first metadata item.
XmlModifyA document modification class.
XmlModify::addAppendStepAppend content to the targeted nodes.
XmlModify::addInsertAfterStepInsert after a targeted node.
XmlModify::addInsertBeforeStepInsert before a targeted node.
XmlModify::addRemoveStepRemove a node.
XmlModify::addRenameStepRename the targeted node.
XmlModify::addUpdateStepReplace the targeted node's content.
XmlModify::executeExecute the modifications.
XmlModify::setNewEncodingSets a new document encoding.
XmlQueryContextAn XQuery query context
XmlQueryContext::clearNamespacesRemove all namespaces.
XmlQueryContext::getReturnTypeGet the return type.
XmlQueryContext::interruptQueryInterrupt a running query.
XmlQueryContext::removeNamespaceRemove the specified namespace.
XmlQueryContext::getBaseURIGets the Base URI.
XmlQueryContext::setBaseURISets the Base URI.
XmlQueryContext::setDefaultCollectionSet default collection for fn:collection().
XmlQueryContext::getEvaluationTypeGet the evaluation type.
XmlQueryContext::setEvaluationTypeSet the evaluation type.
XmlQueryContext::getNamespaceRetrieve a namespace URI.
XmlQueryContext::setNamespaceAdd a namespace.
XmlQueryContext::getQueryTimeoutSecondsGet query timeout value.
XmlQueryContext::setQueryTimeoutSecondsSet query timeout value.
XmlQueryContext::setReturnTypeSet the return type.
XmlQueryContext::getVariableValueReturn the variable's value.
XmlQueryContext::setVariableValueSet an external XQuery variable.
XmlQueryExpressionAn XmlQueryExpression.
XmlQueryExpression::executeEvaluate the query.
XmlQueryExpression::getQueryReturn the query as a string.
XmlResolverBase class for file resolution policy.
XmlResolver::resolveCollectionResolve URI to an XmlResults.
XmlResolver::resolveDocumentResolve URI to an XmlValue.
XmlResolver::resolveEntityResolve an entity to an XmlInputStream.
XmlResolver::resolveModuleLocationResolve an XQuery module namespace to locations.
XmlResolver::resolveModuleResolve an XQuery module reference.
XmlResolver::resolveSchemaResolve schema to an XmlInputStream.
XmlResultsQuery results.
XmlResults::addAdds an XmlValue to the end of the result set.
XmlResults::getEvaluationTypeReturns the evaluation type of the result set.
XmlResults::hasNextIs there another value in the results set.
XmlResults::hasPreviousIs there a previous value in the results set.
XmlResults::nextRetrieve the next element in the results set.
XmlResults::peekRetrieve current value with no iterator movement.
XmlResults::previousRetrieve the previous element in the result set.
XmlResults::resetThe iterator is placed at the beginning of the result set.
XmlResults::sizeReturns the number of elements in the result set.
XmlStatisticsEncapsulates index statistics.
XmlStatistics::getNumberOfIndexedKeysThe total number of index keys.
XmlStatistics::getNumberOfUniqueKeysThe number of unique index keys.
XmlTransactionTransaction object.
XmlTransaction::abortAbort a transaction.
XmlTransaction::commitCommit a transaction.
XmlTransaction::createChildCreate a child transaction.
XmlTransaction::getDbTxnGet the underlying DbTxn object.
XmlUpdateContextAn XmlUpdateContext
XmlUpdateContext::setApplyChangesToContainersSets whether modifications are written to containers.
XmlValueA single result value.
XmlValue::asBooleanReturn value as a boolean.
XmlValue::asDocumentReturn value as XmlDocument.
XmlValue::asEventReaderReturn value as XmlEventReader.
XmlValue::asNodeReturn value as DOM node.
XmlValue::asNumberReturn value as a double.
XmlValue::asStringReturn value as a string.
XmlValue::equalsCompare two XmlValue objects.
XmlValue::getAttributesGet the node's attributes.
XmlValue::getFirstChildGet the node's first child.
XmlValue::getLastChildGet the node's last child.
XmlValue::getLocalNameGet the node's local name.
XmlValue::getNamespaceURIGet the node's namespace URI.
XmlValue::getNextSiblingGet the node's next sibling node.
XmlValue::getNodeHandleReturn a string node handle for the value.
XmlValue::getNodeNameGet the name of the node value.
XmlValue::getNodeTypeGet the DOM type of the node.
XmlValue::getNodeValueGet the value of the node.
XmlValue::getOwnerElementGet the node's owner element.
XmlValue::getParentNodeGet the node's parent node.
XmlValue::getPrefixGet the node's namespace prefix.
XmlValue::getPreviousSiblingGet the node's previous sibling node.
XmlValue::getTypeNameGet the name of the type.
XmlValue::getTypeURIGet the URI for the type.
XmlValue::getTypeGet the type enumeration of the value.
XmlValue::isBinaryCheck if value is binary.
XmlValue::isBooleanCheck if value is a boolean.
XmlValue::isNodeCheck if value is node.
XmlValue::isNullCheck if the value is initialized.
XmlValue::isNumberCheck if value is a number .
XmlValue::isStringCheck if value is a string .
XmlValue::isTypeCheck type of value.
XmlValue::operator==Compare two XmlValue objects.

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