Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members  

MetadataPlugin Class Reference

#include <MetadataPlugin.h>

Inheritance diagram for MetadataPlugin:

Plugin BDBMetadataPlugin ODBCMetadataPlugin List of all members.

Public Methods

virtual CoreError create (NumID &docid, const Document &document)=0
virtual CoreError remove (NumID docid)=0
virtual CoreError update (NumID docid, const Document &document)=0
virtual CoreError get (NumID docid, Document &document)=0
virtual CoreError lock (NumID docid, DocumentLock lock)=0
CoreError unlock (NumID docid)
virtual CoreError getLocks (map< NumID, DocumentLock > &locks)=0
virtual CoreError query (NumID first, int maxlen, map< NumID, NumID > &updates)=0

Detailed Description

The MetadataPlugin is used to store metadata describing documents in the repository. Metadata is stored in XML format. Searching is implemented in the SearchPlugin interface.

Implementations of this class must be thread-safe.

Member Function Documentation

virtual CoreError MetadataPlugin::create (  NumID &    docid,
const Document &    document
)  [pure virtual]
 

Create a document.

Parameters:
docid  the reference that receives the new document ID
document  the new document information
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

virtual CoreError MetadataPlugin::get (  NumID    docid,
Document &    document
)  [pure virtual]
 

Get a document

Parameters:
docid  the document to retrieve
document  the reference that receives the document information
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

virtual CoreError MetadataPlugin::getLocks (  map< NumID, DocumentLock > &    locks )  [pure virtual]
 

Get the active locks. Useful for cleaning up after a crash.

Parameters:
locks  the reference that receives the document locks
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

virtual CoreError MetadataPlugin::lock (  NumID    docid,
DocumentLock    lock
)  [pure virtual]
 

Lock the document.

Parameters:
docid  the document ID
lock  the document lock type
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

virtual CoreError MetadataPlugin::query (  NumID    first,
int    maxlen,
map< NumID, NumID > &    updates
)  [pure virtual]
 

Query document changes since 'first'.

Parameters:
first  the first update to return
maxlen  the maximum number of updates to return
updates  the reference that receives the updates
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

virtual CoreError MetadataPlugin::remove (  NumID    docid )  [pure virtual]
 

Remove a document.

Parameters:
docid  the document to remove
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

CoreError MetadataPlugin::unlock (  NumID    docid ) 
 

Unlock the document (release lock owned by calling thread).

Parameters:
docid  the document ID
Returns:
error code

virtual CoreError MetadataPlugin::update (  NumID    docid,
const Document &    document
)  [pure virtual]
 

Update a document

Parameters:
docid  the document that will be updated
document  the updated document information
Returns:
error code

Implemented in BDBMetadataPlugin, and ODBCMetadataPlugin.

The documentation for this class was generated from the following files:
Generated on Wed Feb 18 13:45:56 2004 for strongroom by doxygen1.2.18