Collection (Apache Xindice API v1.2m1)

Overview

Package

Class

Tree

Deprecated

Index

Help

Xindice API
version 1.2m1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.xindice.core
Class Collection

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

All Implemented Interfaces:: Configurable, DBObject, Named

Direct Known Subclasses:: Database, MetaSystemCollection, SystemCollection

public class Collection
extends CollectionManager
implements Named, DBObject, Configurable

Collection represents a collection of Documents maintains links to the Filer storage implementation, and the Indexes associated with the Collection.

Version:: $Revision: 594628 $, $Date: 2007-11-13 15:16:05 -0500 (Tue, 13 Nov 2007) $

Constructor Summary
`protected`	`Collection()`
	`Collection(Collection parent)`

Method Summary
`boolean`	`close()` close closes the DBObject
`boolean`	`create()` create creates a new DBObject and any associated resources for the new DBObject, such as disk files, etc.
`Collection`	`createCollection(String path, Configuration config)` createCollection creates a new Collection object and any associated system resources that the Collection will need.
`Indexer`	`createIndexer(Configuration config)` createIndexer creates a new Indexer object and any associated system resources that the Indexer will need.
`protected Key`	`createNewKey(Object key)` createNewKey allocates a new key to be used as a key in the collection.
`Key`	`createNewOID()` createNewOID allocates a new Object ID to be used as a Key in the Collection.
`boolean`	`drop()` drop instructs the DBObjectimplementation to remove itself from existence.
`boolean`	`dropCollection(Collection collection)` dropCollection physically removes the specified Collection and any associated system resources that the Collection uses.
`boolean`	`dropIndexer(Indexer index)` dropIndexer physically removes the specified Indexer and any associated system resources that the Indexer uses.
`boolean`	`exists()` exists returns whether or not a physical representation of this DBObject actually exists.
`byte[]`	`getBinary(Object key)` Retrieve a binary database entry by key.
`String`	`getCanonicalDocumentName(Key key)` getCanonicalDocumentName returns the canonical name for the specified Key in relation to this Collection.
`String`	`getCanonicalDocumentName(String key)` From the document key and this collection canonical name, composes canonical document name.
`String`	`getCanonicalName()` getCanonicalName returns the canonical name of this Collection.
`MetaData`	`getCollectionMeta()` Return the MetaData for this collection.
`File`	`getCollectionRoot()`
`Container`	`getContainer(Object docKey)` getContainer retrieves a Container from the Collection.
`Database`	`getDatabase()` getDatabase returns the Database owner for this Collection.
`org.w3c.dom.Document`	`getDocument(Object key)` getDocument retrieves a Document by Key.
`long`	`getDocumentCount()` getDocumentCount returns the count of Documents being maintained by this Collection.
`MetaData`	`getDocumentMeta(String id)` Return the MetaData object for a document within this collection.
`DocumentSet`	`getDocumentSet()` getDocumentSet returns the set of Documents being maintained by this Collection.
`Entry`	`getEntry(Object id)` Retrieve a database entry by key.
`Entry`	`getEntryMeta(Object id)` Retrieve a database entry metadata by key.
`Filer`	`getFiler()` getFiler returns the low-level Filer instance underlying the Collection instance.
`Indexer`	`getIndexer(String name)` getIndexer retrieves an Indexer by name.
`IndexManager`	`getIndexManager()` return the IndexManager being used by this Collection.
`String`	`getName()` getName retrieves the contextually important name of the object
`XMLSerializable`	`getObject(Object key)` getObject instantiates and returns an XMLSerializable object based on the provided Key.
`Collection`	`getParentCollection()` getParentCollection returns the parent Collection of this Collection.
`QueryEngine`	`getQueryEngine()` getQueryEngine returns the Database's Query Engine
`SymbolTable`	`getSymbols()` getSymbols returns the SymbolTable in use by this Collection.
`SystemCollection`	`getSystemCollection()` getSystemCollection returns the System Collection.
`Key`	`insertBinary(byte[] bytes)` Insert a binary object into a Xindice Collection.
`Key`	`insertBinary(Object docKey, byte[] bytes)` insertBinary inserts a new binary object into a Xindice Collection.
`Key`	`insertDocument(org.w3c.dom.Document document)` insertDocument inserts a new Document into a Xindice Collection.
`Key`	`insertDocument(Object docKey, org.w3c.dom.Document document)` insertDocument inserts a new Document into a Xindice Collection.
`Key`	`insertObject(String objKey, XMLSerializable obj)` insertObject inserts an XMLSerializable object into the Collection based on the specified Key.
`Key`	`insertObject(XMLSerializable obj)` insertObject inserts an XMLSerializable object into the Collection and returns a newly generated Key.
`boolean`	`isMetaEnabled()` Returns whether or not meta data is enabled.
`boolean`	`isOpened()` isOpened returns whether or not the DBObject is opened for business.
`String[]`	`listDocuments()` listDocuments returns a list of all entry keys stored by this collection.
`String[]`	`listIndexers()` listIndexers returns a list of the currently registered Indexers as an array of String.
`boolean`	`open()` open opens the DBObject
`NodeSet`	`queryCollection(String style, String query, NamespaceMap nsMap)` queryCollection performs a query against the current collection using the specified style and query String.
`NodeSet`	`queryDocument(String style, String query, NamespaceMap nsMap, Object key)` queryDocument performs a query against a single Document using the specified style, query string, and Document ID.
`void`	`remove(Object id)` remove removes an object from the Collection based on its Key, regardless of it's type.
`boolean`	`setBinary(Object docKey, byte[] bytes)` setBinary inserts or updates binary object into a Xindice Collection.
`protected void`	`setCanonicalName(String canonicalName)`
`void`	`setCollectionMeta(MetaData meta)` Reset the metadata object for this collection.
`protected void`	`setCollectionRoot(File collectionRoot)`
`void`	`setConfig(Configuration config)` setConfig sets the configuration information for the Configurable object instance.
`boolean`	`setDocument(Object docKey, org.w3c.dom.Document document)` setDocument inserts or updates an existing Document in a Xindice Collection.
`void`	`setDocumentMeta(String id, MetaData meta)` Set the metadata associated with a document within this collection.
`protected void`	`setName(String name)`
`void`	`setObject(Object key, XMLSerializable obj)` setObject sets an XMLSerializable object in the Collection based on the provided Key.
`protected void`	`updateCollectionMeta()` update the modified time of this collection when appropriate
`protected void`	`updateDocumentMeta(Record record)` update the modified time of this document when appropriate

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

Constructor Detail

Collection

protected Collection()

Collection

public Collection(Collection parent)

Parameters:: parent - parent collection

Method Detail

setName

protected void setName(String name)

Parameters:: name - collection name

setCanonicalName

protected final void setCanonicalName(String canonicalName)

setCollectionRoot

protected final void setCollectionRoot(File collectionRoot)

createNewKey

protected final Key createNewKey(Object key)

createNewKey allocates a new key to be used as a key in the collection. Passed in key parameter string value used for the key. If passed key parameter is null, new OID is generated.

Parameters:: key - The Key hint, can be null
Returns:: The newly generated Key