org.gcube.indexmanagement.fulltextindexupdater
Class FullTextIndexUpdaterService

java.lang.Object
  extended by org.gcube.indexmanagement.fulltextindexupdater.FullTextIndexUpdaterService

public class FullTextIndexUpdaterService
extends java.lang.Object

FullTextIndexBatchUpdaterService implements functionality needed to update a FullText index. Every FullTextIndexBatchUpdaterService instance (resource) must be connected to one, and only one FullTextIndexManagementService instance (resource), though many BatchUpdater instances may be connected to one Management instance. The index can then be updated by connecting the updater to one or more remote ResultSets containing ROWSETs of the documents to be indexed.

Version:
0.1

Constructor Summary
FullTextIndexUpdaterService()
           
 
Method Summary
 AbortResponse abort(Abort empty)
          Abort the current update, discarding uncommited changes
 CommitResponse commit(Commit empty)
          Commit the current update, making the changes candidates for being merged into the main index.
 DeleteDocumentsResponse deleteDocuments(DeleteDocuments request)
          Deletes a list of documents from the local and main index.
 FinishUpdateResponse finishUpdate(FinishUpdate empty)
          Close the current update, commiting and merging the changes.
 ProcessResponse process(java.lang.Process arguments)
          Inserts ResultSet of ROWSETS information into an index.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FullTextIndexUpdaterService

public FullTextIndexUpdaterService()
Method Detail

process

public ProcessResponse process(java.lang.Process arguments)
                        throws GCUBEFault
Inserts ResultSet of ROWSETS information into an index.

Parameters:
arguments - Process - object containing the ResultSet EPR and an optional indication of whether to destroy the updater resource after the ResultSet has been indexed (which default to false).
Returns:
ProcessResponse - empty object.
Throws:
GCUBEFault

deleteDocuments

public DeleteDocumentsResponse deleteDocuments(DeleteDocuments request)
                                        throws GCUBEFault
Deletes a list of documents from the local and main index.

Parameters:
IDs - DeleteDocuments a list of the IDs of the documents to be deleted
Throws:
GCUBEFault

commit

public CommitResponse commit(Commit empty)
                      throws GCUBEFault
Commit the current update, making the changes candidates for being merged into the main index.

Parameters:
empty - Commit - empty instance.
Returns:
CommitResponse - empty instance.
Throws:
GCUBEFault

finishUpdate

public FinishUpdateResponse finishUpdate(FinishUpdate empty)
                                  throws GCUBEFault
Close the current update, commiting and merging the changes.

Parameters:
empty - FinishUpdate - empty instance.
Returns:
FinishUpdateResponse - empty instance.
Throws:
GCUBEFault

abort

public AbortResponse abort(Abort empty)
                    throws GCUBEFault
Abort the current update, discarding uncommited changes

Parameters:
empty - Abort - empty instance.
Returns:
AbortResponse - empty instance.
Throws:
GCUBEFault