org.compass.core.lucene.engine.transaction.support.job
Class DeleteTransactionJob

java.lang.Object
  extended by org.compass.core.lucene.engine.transaction.support.job.DeleteTransactionJob
All Implemented Interfaces:
Serializable, TransactionJob

public class DeleteTransactionJob
extends Object
implements TransactionJob

A transaction job that deletes a resource based on its ResourceKey.

Author:
kimchy
See Also:
Serialized Form

Constructor Summary
DeleteTransactionJob(ResourceKey resourceKey)
           
 
Method Summary
 boolean equals(Object o)
           
 void execute(IndexWriter writer, LuceneSearchEngineFactory sessionFactory)
          Executes the job against Lucene IndexWriter.
 ResourceKey getResourceKey()
           
 String getResourceUID()
          Retruns the resource UID (if available) that transaction job will work on.
 String getSubIndex()
          Returns the sub index the transaction job will work against.
 int hashCode()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DeleteTransactionJob

public DeleteTransactionJob(ResourceKey resourceKey)
Method Detail

getSubIndex

public String getSubIndex()
Description copied from interface: TransactionJob
Returns the sub index the transaction job will work against.

Specified by:
getSubIndex in interface TransactionJob

getResourceUID

public String getResourceUID()
Description copied from interface: TransactionJob
Retruns the resource UID (if available) that transaction job will work on.

Specified by:
getResourceUID in interface TransactionJob

getResourceKey

public ResourceKey getResourceKey()

execute

public void execute(IndexWriter writer,
                    LuceneSearchEngineFactory sessionFactory)
             throws Exception
Description copied from interface: TransactionJob
Executes the job against Lucene IndexWriter.

Specified by:
execute in interface TransactionJob
Throws:
Exception

toString

public String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright (c) 2004-2009 The Compass Project.