wt.index
Interface IndexServiceDelegate

All Known Implementing Classes:

RwareIndexDelegate

public interface IndexServiceDelegate

Supported API: true

Extendable: false

Method Summary

void	custom_getAdditionalFieldData(Indexable indexable) Deprecated.
void	custom_getAdditionalMetaData(Indexable indexable) Deprecated.
void	custom_getFieldData() Deprecated.
void	custom_getMetaData(Indexable indexable) This method indexes all attributes of an object into the Rware metadata field and is searchable using that field.
boolean	delete(LinkedList indexCollection, IndexerSet libraries) This method is used to delete an item from the index based on the items UFID key Supported API: false
WTCollection	index(WTCollection indexCollection) This method is used to generate all of the information required for an object to be indexed.

Method Detail

index

public WTCollection index(WTCollection indexCollection)
                   throws IndexingException,
                          WTException,
                          IllegalAccessException,
                          InvocationTargetException,
                          ClassNotFoundException,
                          InstantiationException,
                          PropertyVetoException,
                          IOException

This method is used to generate all of the information required for an object to be indexed. It makes calls to base methods, customized methods as well as method to get the content for an FormatContentHolder object.

Supported API: false

Parameters:

indexCollection -

Returns:

WTCollection

Throws:

IndexingException

WTException

IllegalAccessException

InvocationTargetException

ClassNotFoundException

InstantiationException

PropertyVetoException

IOException

delete

public boolean delete(LinkedList indexCollection,
                      IndexerSet libraries)
               throws IndexingException,
                      WTException,
                      IllegalAccessException,
                      InvocationTargetException,
                      ClassNotFoundException,
                      InstantiationException,
                      PropertyVetoException,
                      IOException

This method is used to delete an item from the index based on the items UFID key

Supported API: false

Parameters:

indexCollection -

libraries -

Returns:

boolean

Throws:

IndexingException

WTException

IllegalAccessException

InvocationTargetException

ClassNotFoundException

InstantiationException

PropertyVetoException

IOException

custom_getMetaData

public void custom_getMetaData(Indexable indexable)
                        throws WTException,
                               IndexingException

This method indexes all attributes of an object into the Rware metadata field and is searchable using that field. Attributes defined in wt.index.IndexFields are indexed as seperate fields. All soft attributes (IBAs) are indexed to an ibas field in rware and are searchable through the keyword or using the ibas field search. This method should not be overriden in any subclasses of RwareIndexDelegate. Customizers can disable the metadata and iba indexing capabilities by modifying the wt.pproperties listed here. wt.index.IndexMetaData=false wt.index.IndexIBAs=false

Supported API: false

Parameters:

indexable -

Throws:

WTException

IndexingException

custom_getAdditionalMetaData

public void custom_getAdditionalMetaData(Indexable indexable)
                                  throws WTException,
                                         IndexingException

Deprecated.

This method is intended by customizers to override in a custom sub-class of the IndexServiceDelegate provided

Supported API: true

Parameters:

indexable -

Throws:

WTException

IndexingException

custom_getAdditionalFieldData

public void custom_getAdditionalFieldData(Indexable indexable)
                                   throws WTException,
                                          IndexingException

Deprecated.

This method is intended by customizers to override in a custom sub-class of the IndexServiceDelegate provided

Supported API: true

Parameters:

indexable -

Throws:

WTException

IndexingException

custom_getFieldData

public void custom_getFieldData()
                         throws WTException,
                                IndexingException

Deprecated.

This is no longer used in the base installation, but was included as part of backwards support

Supported API: false

Throws:

WTException

IndexingException