Package com.axemble.vdoc.sdk.impl

Class IndexController

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.IndexController

All Implemented Interfaces:

IController, IIndexController, Serializable

public class IndexController
extends AbstractElement
implements IIndexController

Give Access to index methods

Author:

vlygeros

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IndexController(IModule module, String name)

Method Summary

Modifier and Type	Method	Description
String	addDocument(Serializable objectToIndex)	Index or reindex an object
String	getName()	Gets the name of the index.
void	incrementalIndex(Date lastIndexDate)	Run an incremental index
protected <T> String	indexDocumentGenerics(String indexName, T objectToIndex)
void	reindex()	Recreate an index
void	removeDocument(String idToUnindex)	Remove an object from index

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

Constructor Details

IndexController

protected IndexController(IModule module,
 String name)

Method Details

getName

public String getName()

Description copied from interface: IIndexController

Gets the name of the index.

Specified by:

getName in interface IIndexController

Returns:

The name of the index as a java.lang.String value.

addDocument

public String addDocument(Serializable objectToIndex)
                   throws PortalModuleException

Description copied from interface: IIndexController

Index or reindex an object

Specified by:

addDocument in interface IIndexController

Parameters:

objectToIndex - object to index/reindex

Returns:

the identifier of objectToIndex in the index

Throws:

PortalModuleException - default module exception.

removeDocument

public void removeDocument(String idToUnindex)
                    throws PortalModuleException

Description copied from interface: IIndexController

Remove an object from index

Specified by:

removeDocument in interface IIndexController

Parameters:

idToUnindex - object id

Throws:

PortalModuleException - default module exception.

incrementalIndex

public void incrementalIndex(Date lastIndexDate)
                      throws PortalModuleException

Description copied from interface: IIndexController

Run an incremental index

Specified by:

incrementalIndex in interface IIndexController

Parameters:

lastIndexDate - date of the last indexation

Throws:

PortalModuleException - default module exception.

reindex

public void reindex()
             throws PortalModuleException

Description copied from interface: IIndexController

Recreate an index

Specified by:

reindex in interface IIndexController

Throws:

PortalModuleException - default module exception.

indexDocumentGenerics

protected <T> String indexDocumentGenerics(String indexName,
 T objectToIndex)
                                    throws PortalModuleException

Throws:

PortalModuleException