com.bluestream.xdb.dsobject.config
Interface FullTextIndex

All Superinterfaces:

ConfigDso, DSObject

public interface FullTextIndex

extends ConfigDso

This class contains information about a fulltext index on a root.

Field Summary

Fields inherited from interface com.bluestream.xdb.dsobject.config.ConfigDso

k_elnDatabaseInfo, k_elnDatabaseTree, k_elnFullTextIndexInfo, k_elnIndexTree, k_elnRootInfo, k_elnRootTree, k_elnServerInfo, k_elnTriggerInfo, k_elnTriggerTree, k_elnValueIndexInfo, k_FTIName

Fields inherited from interface com.bluestream.xdb.dsobject.DSObject

cCompComponentsSuffix, cDocComponentsSuffix, k_elnListItem, k_elnName, k_otypCollection, k_otypComponent, k_otypDatabase, k_otypDocument, k_otypGroup, k_otypIndex, k_otypModule, k_otypRoot, k_otypServer, k_otypTrigger, k_otypUser

Method Summary

Iterator	getExcludePaths()
Iterator	getIncludePaths()
String	getName() Returns the name of the fulltext index.
int	getPathCount() Returns the path count.
int	getReferenceCount() Returns the document reference count.
int	getUniqueWordCount() Returns the unique word count.

Methods inherited from interface com.bluestream.xdb.dsobject.DSObject

delete, getObjectId, getObjectType

Method Detail

getName

public String getName()
               throws XDBException

Returns the name of the fulltext index. Must always be a valid name.

Specified by:

getName in interface DSObject

Throws:

XDBException

getIncludePaths

public Iterator getIncludePaths()

getExcludePaths

public Iterator getExcludePaths()

getUniqueWordCount

public int getUniqueWordCount()
                       throws XDBException

Returns the unique word count.

Throws:

XDBException

getPathCount

public int getPathCount()
                 throws XDBException

Returns the path count.

Throws:

XDBException

getReferenceCount

public int getReferenceCount()
                      throws XDBException

Returns the document reference count.

Throws:

XDBException