Berkeley DB XML
version 2.3.10

com.sleepycat.dbxml
Class XmlDocumentConfig

java.lang.Object
  extended by com.sleepycat.dbxml.XmlDocumentConfig
All Implemented Interfaces:
Cloneable

public class XmlDocumentConfig
extends Object
implements Cloneable

Used to configure operations that operate on XmlDocument objects.


Field Summary
static XmlDocumentConfig DEFAULT
          The default settings.
 
Constructor Summary
XmlDocumentConfig()
           
 
Method Summary
 boolean getDocumentsOnly()
          Gets whether index lookups will return documents or nodes for containers with node indexes.
 boolean getGenerateName()
          Gets whether to automatically generate a name for the document.
 boolean getLazyDocs()
          Gets whether to retrieve the document lazily.
 LockMode getLockMode()
          Get the lock mode for the operation.
 boolean getReverseOrder()
          Gets whether to sort index lookups in reverse order
 boolean getWellFormedOnly()
          Gets whether operations that may parse a document use only a well-formed scanner, avoiding the expense of reading any referenced schema or DTD.
 XmlDocumentConfig setDocumentsOnly(boolean value)
          Sets whether index lookups will return documents or nodes for containers with node indexes.
 XmlDocumentConfig setGenerateName(boolean value)
          Sets whether to automatically generate a name for the document.
 XmlDocumentConfig setLazyDocs(boolean value)
          Sets whether to retrieve the document lazily.
 XmlDocumentConfig setLockMode(LockMode lmode)
          Set the lock mode for the operation.
 XmlDocumentConfig setReverseOrder(boolean value)
          Sets whether to sort index lookups in reverse order
 XmlDocumentConfig setWellFormedOnly(boolean value)
          Sets whether operations that may parse a document use only a well-formed scanner, avoiding the expense of reading any referenced schema or DTD.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT

public static final XmlDocumentConfig DEFAULT
The default settings.

Constructor Detail

XmlDocumentConfig

public XmlDocumentConfig()
Method Detail

getDocumentsOnly

public boolean getDocumentsOnly()
Gets whether index lookups will return documents or nodes for containers with node indexes.


setDocumentsOnly

public XmlDocumentConfig setDocumentsOnly(boolean value)
Sets whether index lookups will return documents or nodes for containers with node indexes.


getLazyDocs

public boolean getLazyDocs()
Gets whether to retrieve the document lazily.


setLazyDocs

public XmlDocumentConfig setLazyDocs(boolean value)
Sets whether to retrieve the document lazily. That is, retrieve document content and document metadata only on an as needed basis when reading the document.


getGenerateName

public boolean getGenerateName()
Gets whether to automatically generate a name for the document.


setGenerateName

public XmlDocumentConfig setGenerateName(boolean value)
Sets whether to automatically generate a name for the document.


getReverseOrder

public boolean getReverseOrder()
Gets whether to sort index lookups in reverse order


setReverseOrder

public XmlDocumentConfig setReverseOrder(boolean value)
Sets whether to sort index lookups in reverse order


getLockMode

public LockMode getLockMode()
Get the lock mode for the operation.


setLockMode

public XmlDocumentConfig setLockMode(LockMode lmode)
Set the lock mode for the operation.


getWellFormedOnly

public boolean getWellFormedOnly()
Gets whether operations that may parse a document use only a well-formed scanner, avoiding the expense of reading any referenced schema or DTD.


setWellFormedOnly

public XmlDocumentConfig setWellFormedOnly(boolean value)
Sets whether operations that may parse a document use only a well-formed scanner, avoiding the expense of reading any referenced schema or DTD.


Berkeley DB XML
version 2.3.10

Copyright 1996,2007 Oracle. All rights reserved.