|
Berkeley DbXML version 1.2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sleepycat.dbxml.XmlIndexSpecification
Constructor Summary | |
XmlIndexSpecification()
The XmlIndexSpecification class encapsulates the indexing specification of a container. |
Method Summary | |
void |
addIndex(String uri,
String name,
String index)
The XmlIndexSpecification.addIndex method adds indexing strategies for a named document node. |
void |
delete()
|
void |
deleteIndex(String uri,
String name,
String index)
The XmlIndexSpecification.deleteIndex method deletes indexing strategies for a named document node. |
XmlIndexDeclaration |
find(String uri,
String name)
The XmlIndexSpecification.find method returns the indexing strategies for a named document node. |
XmlIndexDeclaration |
next()
The XmlIndexSpecification.reset and XmlIndexSpecification.next methods comprise the iteration interface. |
void |
replaceIndex(String uri,
String name,
String index)
The XmlIndexSpecification.replaceIndex method replaces the indexing strategies for a named document node. |
void |
reset()
The XmlIndexSpecification.reset and XmlIndexSpecification.next methods comprise the iteration interface. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XmlIndexSpecification() throws XmlException
XmlContainer.getIndexSpecification
method, and modified using the XmlContainer.setIndexSpecification
method. The XmlIndexSpecification class provides an interface for manipulating the indexing specification through the XmlIndexSpecification.addIndex
, XmlIndexSpecification.deleteIndex
, and XmlIndexSpecification.replaceIndex
methods. The class interface also provides the XmlIndexSpecification.next
and XmlIndexSpecification.reset
methods for iterating through the specified indices. Finally, the XmlIndexSpecification.find
method can be used to search for the indexing strategy for a known node.
A copy constructor and assignment operator are provided for this class. The class is implemented using a handle-body idiom. When a handle is copied both handles maintain a reference to the same body.
XmlException
Method Detail |
public void delete()
public void addIndex(String uri, String name, String index) throws XmlException
uri
- The namespace of the node to be indexed. The default namespace is selected by passing an empty string for the namespace.name
- The name of the element or attribute node to be indexed.index
- A space-separated list of the following indexing strategy names: XmlException
public void deleteIndex(String uri, String name, String index) throws XmlException
uri
- The namespace of the node to be indexed. The default namespace is selected by passing an empty string for the namespace.name
- The name of the element or attribute node to be indexed.index
- A space-separated list of the following indexing strategy names:
XmlException
public void replaceIndex(String uri, String name, String index) throws XmlException
uri
- The namespace of the node to be indexed. The default namespace is selected by passing an empty string for the namespace.name
- The name of the element or attribute node to be indexed.index
- A space-separated list of the following indexing strategy names:
XmlException
public void reset() throws XmlException
XmlIndexSpecification.reset
and XmlIndexSpecification.next
methods comprise the iteration interface. The XmlIndexSpecification.reset
method method resets the iterator.
XmlException
public XmlIndexDeclaration find(String uri, String name)
XmlIndexSpecification.find
method returns the indexing strategies for a named document node.
uri
- The namespace of the node to be indexed. The default namespace is selected by passing an empty string for the namespace.name
- The name of the element or attribute node to be indexed.
XmlException
public XmlIndexDeclaration next()
XmlIndexSpecification.reset
and XmlIndexSpecification.next
methods comprise the iteration interface. The XmlIndexSpecification.next
returns the next document node name and its indexing strategy.
XmlException
|
Berkeley DbXML version 1.2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |