org.apache.xindice.core
Class MetaSystemCollection

java.lang.Object
  org.apache.xindice.core.CollectionManager
      org.apache.xindice.core.Collection
          org.apache.xindice.core.MetaSystemCollection

All Implemented Interfaces:

Configurable, DBObject, Named

public final class MetaSystemCollection

extends Collection

MetaSystemCollection represents the Meta System Collection. Beyond standard Collection operations, this class will provide facilities for Meta data management.

Version:

CVS $Revision: 1.13 $, $Date: 2004/03/15 13:46:30 $

Field Summary

static java.lang.String	COLLECTION_META_DATA
static java.lang.String	METACOL
static java.lang.String	METAS

Constructor Summary

MetaSystemCollection(Database db)

Method Summary

void	dropCollectionMeta(Collection collection) dropCollectionMeta removes the MetaData for the specified Collection.
void	dropDocumentMeta(Collection collection, java.lang.String id) dropDocumentMeta removes the MetaData for the specified Document.
MetaData	getCollectionMeta(Collection collection) getCollectionMeta retrieves the MetaData for the specified Collection.
MetaData	getDocumentMeta(Collection collection, java.lang.String id) getDocumentMeta retrieves the MetaData for the specified document.
Collection	getMetaCollection(Collection collection, boolean create) Returns the corresponding Meta Collection for the given collection, optionally creating the hierarchy
void	init()
void	setCollectionMeta(Collection collection, MetaData meta) setCollectionMeta save the Meta for the specified Collection.
void	setDocumentMeta(Collection collection, java.lang.String id, MetaData meta) setDocumentMeta save the Meta for the specified Collection.

Methods inherited from class org.apache.xindice.core.Collection

close, create, createCollection, createIndexer, createNewKey, createNewOID, drop, dropCollection, dropIndexer, exists, flushSymbolTable, getBinary, getCanonicalDocumentName, getCanonicalDocumentName, getCanonicalName, getCollectionMeta, getCollectionRoot, getContainer, getDatabase, getDocument, getDocumentCount, getDocumentMeta, getDocumentSet, getEntry, getFiler, getIndexer, getIndexManager, getName, getObject, getParentCollection, getQueryEngine, getSymbols, getSystemCollection, insertBinary, insertBinary, insertDocument, insertDocument, insertObject, insertObject, isMetaEnabled, isOpened, listDocuments, listIndexers, open, queryCollection, queryDocument, remove, setCanonicalName, setCollectionMeta, setCollectionRoot, setConfig, setDocument, setDocumentMeta, setName, setObject, updateCollectionMeta, updateDocumentMeta

Methods inherited from class org.apache.xindice.core.CollectionManager

addCollection, countCollections, getCollection, getCollections, getConfig, listCollections

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.xindice.util.Configurable

getConfig

Field Detail

METACOL

public static final java.lang.String METACOL

See Also:

Constant Field Values

METAS

public static final java.lang.String METAS

See Also:

Constant Field Values

COLLECTION_META_DATA

public static final java.lang.String COLLECTION_META_DATA

See Also:

Constant Field Values

Constructor Detail

MetaSystemCollection

public MetaSystemCollection(Database db)

Method Detail

init

public void init()
          throws DBException

Throws:

DBException

getMetaCollection

public Collection getMetaCollection(Collection collection,
                                    boolean create)
                             throws DBException

Returns the corresponding Meta Collection for the given collection, optionally creating the hierarchy

Parameters:

collection - the collection whose meta you want

create - whether or not to create the meta if its missing

Returns:

collection the meta collection for the requested collection

Throws:

DBException

dropCollectionMeta

public void dropCollectionMeta(Collection collection)
                        throws DBException

dropCollectionMeta removes the MetaData for the specified Collection.

Parameters:

collection - The Collection whose meta is required

Throws:

DBException

getCollectionMeta

public MetaData getCollectionMeta(Collection collection)
                           throws DBException

getCollectionMeta retrieves the MetaData for the specified Collection. Assumption is that the corresponding collection must already exist.

Parameters:

collection - The Collection whose meta is required

Returns:

The requested MetaData

Throws:

DBException

setCollectionMeta

public void setCollectionMeta(Collection collection,
                              MetaData meta)
                       throws DBException

setCollectionMeta save the Meta for the specified Collection.

Parameters:

collection - The Collection that owns the MetaData

meta - The MetaData

Throws:

DBException

dropDocumentMeta

public void dropDocumentMeta(Collection collection,
                             java.lang.String id)
                      throws DBException

dropDocumentMeta removes the MetaData for the specified Document.

Parameters:

collection - The Collection whose meta is required

id - the Document id

Throws:

DBException

getDocumentMeta

public MetaData getDocumentMeta(Collection collection,
                                java.lang.String id)
                         throws DBException

getDocumentMeta retrieves the MetaData for the specified document.

Parameters:

collection - The Collection whose meta is required

id - the ID

Returns:

The requested MetaData

Throws:

DBException

setDocumentMeta

public void setDocumentMeta(Collection collection,
                            java.lang.String id,
                            MetaData meta)
                     throws DBException

setDocumentMeta save the Meta for the specified Collection.

Parameters:

collection - The Collection that owns the MetaData

id -

meta - The MetaData

Throws:

DBException