org.apache.jackrabbit.core.query.lucene
Class MultiIndex.Action

java.lang.Object
  extended byorg.apache.jackrabbit.core.query.lucene.MultiIndex.Action
Enclosing class:
org.apache.jackrabbit.core.query.lucene.MultiIndex

public abstract static class MultiIndex.Action
extends Object

Defines an action on an MultiIndex.


Field Summary
static int TYPE_ADD_INDEX
          Action type for add index action.
static int TYPE_ADD_NODE
          Action type for add node action.
static int TYPE_COMMIT
          Action type for commit action.
static int TYPE_CREATE_INDEX
          Action type for create index action.
static int TYPE_DELETE_INDEX
          Action type for delete index action.
static int TYPE_DELETE_NODE
          Action type for delete node action.
static int TYPE_START
          Action type for start action.
static int TYPE_VOLATILE_COMMIT
          Action type for volatile index commit action.
 
Method Summary
abstract  void execute(org.apache.jackrabbit.core.query.lucene.MultiIndex index)
          Executes this action on the index.
abstract  String toString()
          Returns a String representation of this action that can be written to the RedoLog.
 void undo(org.apache.jackrabbit.core.query.lucene.MultiIndex index)
          Executes the inverse operation of this action.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_START

public static final int TYPE_START
Action type for start action.

See Also:
Constant Field Values

TYPE_ADD_NODE

public static final int TYPE_ADD_NODE
Action type for add node action.

See Also:
Constant Field Values

TYPE_DELETE_NODE

public static final int TYPE_DELETE_NODE
Action type for delete node action.

See Also:
Constant Field Values

TYPE_COMMIT

public static final int TYPE_COMMIT
Action type for commit action.

See Also:
Constant Field Values

TYPE_VOLATILE_COMMIT

public static final int TYPE_VOLATILE_COMMIT
Action type for volatile index commit action.

See Also:
Constant Field Values

TYPE_CREATE_INDEX

public static final int TYPE_CREATE_INDEX
Action type for create index action.

See Also:
Constant Field Values

TYPE_ADD_INDEX

public static final int TYPE_ADD_INDEX
Action type for add index action.

See Also:
Constant Field Values

TYPE_DELETE_INDEX

public static final int TYPE_DELETE_INDEX
Action type for delete index action.

See Also:
Constant Field Values
Method Detail

execute

public abstract void execute(org.apache.jackrabbit.core.query.lucene.MultiIndex index)
                      throws IOException
Executes this action on the index.

Parameters:
index - the index where to execute the action.
Throws:
IOException - if the action fails due to some I/O error in the index or some other error.

undo

public void undo(org.apache.jackrabbit.core.query.lucene.MultiIndex index)
          throws IOException
Executes the inverse operation of this action. That is, does an undo of this action. This default implementation does nothing, but returns silently.

Parameters:
index - the index where to undo the action.
Throws:
IOException - if the action cannot be undone.

toString

public abstract String toString()
Returns a String representation of this action that can be written to the RedoLog.

Returns:
a String representation of this action.


Copyright © 2004-2005 The Apache Software Foundation. All Rights Reserved.