com.sleepycat.dbxml
Class XmlContainerConfig

java.lang.Object
  com.sleepycat.db.DatabaseConfig
      com.sleepycat.dbxml.XmlContainerConfig

All Implemented Interfaces:

Cloneable

public class XmlContainerConfig
extends DatabaseConfig

Configuration settings for an XmlContainer instance. Used in XmlManager.createContainer(String, XmlContainerConfig), XmlManager.createContainer(XmlTransaction, String, XmlContainerConfig), XmlManager.openContainer(String, XmlContainerConfig), or XmlManager.openContainer(XmlTransaction, String, XmlContainerConfig).

This class extends DatabaseConfig but does not support all of the configuration state in that object. Specifically, the only state used is that obtained from these methods: DatabaseConfig.getChecksum(), DatabaseConfig.getEncrypted(), DatabaseConfig.getTransactional(), DatabaseConfig.getAllowCreate(), DatabaseConfig.getExclusiveCreate(), DatabaseConfig.getNoMMap(), DatabaseConfig.getReadOnly(), DatabaseConfig.getDirtyRead(), DatabaseConfig.getTransactionNotDurable(). Setting any other configuration will be silently ignored.

Field Summary

static XmlContainerConfig

DEFAULT The default configuration settings for XmlContainers.

Constructor Summary

XmlContainerConfig()

Method Summary

boolean	getAllowValidation() Gets whether documents are validated when loaded into the container, if they refer to a DTD or XML Schema.
boolean	getIndexNodes() Returns whether the indexer should create index targets that references nodes rather than documents.
boolean	getNodeContainer() Gets whether documents are stored as nodes.
XmlContainerConfig	setAllowValidation(boolean value) Sets whether documents are validated when loaded into the container, if they refer to a DTD or XML Schema.
XmlContainerConfig	setIndexNodes(boolean value) Causes the indexer to create index targets that reference nodes rather than documents.
XmlContainerConfig	setNodeContainer(boolean value) Set whether documents are broken down into their component nodes, and these nodes are stored individually in the container, or stored intact with all white space and formatting is preserved.

Methods inherited from class com.sleepycat.db.DatabaseConfig

getAllowCreate, getBtreeComparator, getBtreeMinKey, getBtreePrefixCalculator, getBtreeRecordNumbers, getByteOrder, getByteSwapped, getCacheCount, getCacheSize, getChecksum, getDirtyRead, getDuplicateComparator, getEncrypted, getErrorHandler, getErrorPrefix, getErrorStream, getExclusiveCreate, getFeedbackHandler, getHasher, getHashFillFactor, getHashNumElements, getMessageHandler, getMessageStream, getMode, getMultiversion, getNoMMap, getPageSize, getPanicHandler, getQueueExtentSize, getQueueInOrder, getReadOnly, getReadUncommitted, getRecordDelimiter, getRecordLength, getRecordNumberAppender, getRecordPad, getRecordSource, getRenumbering, getReverseSplitOff, getSnapshot, getSortedDuplicates, getTransactional, getTransactionNotDurable, getTruncate, getType, getUnsortedDuplicates, getXACreate, setAllowCreate, setBtreeComparator, setBtreeMinKey, setBtreePrefixCalculator, setBtreeRecordNumbers, setByteOrder, setCacheCount, setCacheSize, setChecksum, setDirtyRead, setDuplicateComparator, setEncrypted, setErrorHandler, setErrorPrefix, setErrorStream, setExclusiveCreate, setFeedbackHandler, setHasher, setHashFillFactor, setHashNumElements, setMessageHandler, setMessageStream, setMode, setMultiversion, setNoMMap, setPageSize, setPanicHandler, setQueueExtentSize, setQueueInOrder, setReadOnly, setReadUncommitted, setRecordDelimiter, setRecordLength, setRecordNumberAppender, setRecordPad, setRecordSource, setRenumbering, setReverseSplitOff, setSnapshot, setSortedDuplicates, setTransactional, setTransactionNotDurable, setTruncate, setType, setUnsortedDuplicates, setXACreate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final XmlContainerConfig DEFAULT

The default configuration settings for XmlContainers.

Constructor Detail

XmlContainerConfig

public XmlContainerConfig()

Method Detail

getIndexNodes

public boolean getIndexNodes()

Returns whether the indexer should create index targets that references nodes rather than documents.

setIndexNodes

public XmlContainerConfig setIndexNodes(boolean value)

Causes the indexer to create index targets that reference nodes rather than documents.

Parameters:

value - Whether the indexer should create index targets that references nodes rather than documents.

getNodeContainer

public boolean getNodeContainer()

Gets whether documents are stored as nodes.

setNodeContainer

public XmlContainerConfig setNodeContainer(boolean value)

Set whether documents are broken down into their component nodes, and these nodes are stored individually in the container, or stored intact with all white space and formatting is preserved. Storing nodes is preferred.

Parameters:

value - Whether documents are stored as nodes.

getAllowValidation

public boolean getAllowValidation()

Gets whether documents are validated when loaded into the container, if they refer to a DTD or XML Schema.

setAllowValidation

public XmlContainerConfig setAllowValidation(boolean value)

Sets whether documents are validated when loaded into the container, if they refer to a DTD or XML Schema.