Indexer (Project JXTA J2SE Reference Implementation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Project JXTA

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.jxta.impl.xindice.core.indexer
Interface Indexer

All Superinterfaces:: DBObject

All Known Implementing Classes:: NameIndexer

public interface Indexer
extends DBObject

Indexer is the abstract indexing interface for Xindice. An Indexer object is implemented in order to retrieve and manage indexes.

Any number of Indexer instances may be associated with a single Collection. The type of Indexer utilized by a query depends on the 'Style' of Indexer and the type of QueryResolver that is being used to performt he query. Currently, Xindice only internally supports one kind of Indexer: 'XPath'.

Method Summary
`void`	`add(Key key, long pos)` add adds a Document to the Indexer.
`void`	`flush()` flush forcefully flushes any unwritten buffers to disk.
`void`	`remove(Key key)` remove removes all references to the specified Key from the Indexer.

Methods inherited from interface net.jxta.impl.xindice.core.DBObject

close, create, drop, exists, isOpened, open

Method Detail

remove

public void remove(Key key)
            throws DBException

remove removes all references to the specified Key from the Indexer.

Parameters:: key - The Object ID
Throws:: DBException

add

public void add(Key key,
                long pos)
         throws DBException

add adds a Document to the Indexer.

Parameters:: key - The Object ID
Throws:: DBException

flush

public void flush()
           throws DBException

flush forcefully flushes any unwritten buffers to disk.

Throws:: DBException