Xindice API
version 1.1

org.apache.xindice.core
Interface Container


public interface Container

Container is a generic container for Key and Document pairs.

Version:
$Revision: 511426 $, $Date: 2007-02-25 04:25:02 +0100 (Sun, 25 Feb 2007) $

Method Summary
 void commit()
          commit saves the Document in the Collection.
 void commit(org.w3c.dom.Document document)
          commit replaces the Document in the Collection with the specified Document.
 String getCanonicalName()
          getCanonicalName returns the canonical name for the contained Document.
 Collection getCollection()
          getCollection returns the Collection that the Document contained belongs to.
 org.w3c.dom.Document getDocument()
          getDocument returns the contained Document.
 Key getKey()
          getKey returns the Document Key.
 void remove()
          delete removes the Document from the Collection.
 org.w3c.dom.Document rollback()
          rollback reloads the Document from the Collection.
 

Method Detail

getCollection

Collection getCollection()
getCollection returns the Collection that the Document contained belongs to.

Returns:
The owner Collection

getKey

Key getKey()
getKey returns the Document Key.

Returns:
The Document Key

getCanonicalName

String getCanonicalName()
                        throws DBException
getCanonicalName returns the canonical name for the contained Document.
ex: /local/test/ocs/ytd

Returns:
The canonical name
Throws:
DBException

getDocument

org.w3c.dom.Document getDocument()
getDocument returns the contained Document.

Returns:
The Document

rollback

org.w3c.dom.Document rollback()
                              throws DBException
rollback reloads the Document from the Collection.

Returns:
The Document
Throws:
DBException

remove

void remove()
            throws DBException
delete removes the Document from the Collection.

Throws:
DBException

commit

void commit()
            throws DBException
commit saves the Document in the Collection.

Throws:
DBException

commit

void commit(org.w3c.dom.Document document)
            throws DBException
commit replaces the Document in the Collection with the specified Document.

Parameters:
document - The Document
Throws:
DBException

Xindice API
version 1.1

Copyright (c) 1999-2007 The Apache Software Foundation. All Rights Reserved.