org.apache.jackrabbit.oak.spi.state

Class MoveDetector

java.lang.Object

org.apache.jackrabbit.oak.spi.state.MoveDetector

All Implemented Interfaces:

Editor, Validator

public class MoveDetector
extends java.lang.Object
implements Validator

A MoveDetector is a validator that can detect certain move operations and reports these to the wrapped MoveValidator by calling MoveValidator.move(String, String, NodeState). That method is called additional to MoveValidator.childNodeAdded(String, NodeState) for the destination of the move operation and MoveValidator.childNodeDeleted(String, NodeState) for the source of the move operation.

Detection of move operations relies on the presence of the SOURCE_PATH property. New nodes with this property set have been moved from the path indicated by the value of the property to its current location.

Limitations:

• Moving a moved node only reports one move from the original source to the final target.
• Moving a transiently added node is not reported as a move operation but as an add operation on the move target.
• Removing a moved node is not reported as a move operation but as a remove operation from the source of the move.
• Moving a child node of a transiently moved node is reported from the original source node, not from the intermediate one.
• Moving a node back and forth to its original location is not reported at all.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SOURCE_PATH

Constructor Summary

Constructors

Constructor and Description
MoveDetector(MoveValidator moveValidator)

Method Summary

Modifier and Type	Method and Description
Validator	childNodeAdded(java.lang.String name, NodeState after) Validate an added node
Validator	childNodeChanged(java.lang.String name, NodeState before, NodeState after) Validate a changed node
Validator	childNodeDeleted(java.lang.String name, NodeState before) Validate a deleted node
void	enter(NodeState before, NodeState after) Called before the given before and after states are compared.
void	leave(NodeState before, NodeState after) Called after the given before and after states are compared.
void	propertyAdded(PropertyState after) Validate an added property
void	propertyChanged(PropertyState before, PropertyState after) Validate a changed property
void	propertyDeleted(PropertyState before) Validate a deleted property

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_PATH

public static final java.lang.String SOURCE_PATH

See Also:

Constant Field Values

Constructor Detail

MoveDetector

public MoveDetector(MoveValidator moveValidator)

Method Detail

enter

public void enter(NodeState before,
                  NodeState after)
           throws CommitFailedException

Description copied from interface: Editor

Called before the given before and after states are compared. The implementation can use this method to initialize any internal state needed for processing the results of the comparison. For example an implementation could look up the effective node type of the after state to know what constraints to apply to on the content changes.

Specified by:

enter in interface Editor

Parameters:

before - before state, non-existent if this node was added

after - after state, non-existent if this node was removed

Throws:

CommitFailedException - if this commit should be rejected

leave

public void leave(NodeState before,
                  NodeState after)
           throws CommitFailedException

Description copied from interface: Editor

Called after the given before and after states are compared. The implementation can use this method to post-process information collected during the content diff. For example an implementation that during the diff just recorded the fact that this node was modified in some way could then use this method to trigger an index update based on that modification flag.

Specified by:

leave in interface Editor

Parameters:

before - before state, non-existent if this node was added

after - after state, non-existent if this node was removed

Throws:

CommitFailedException - if this commit should be rejected

propertyAdded

public void propertyAdded(PropertyState after)
                   throws CommitFailedException

Description copied from interface: Validator

Validate an added property

Specified by:

propertyAdded in interface Editor

Specified by:

propertyAdded in interface Validator

Parameters:

after - the added property

Throws:

CommitFailedException - if validation fails.

propertyChanged

public void propertyChanged(PropertyState before,
                            PropertyState after)
                     throws CommitFailedException

Description copied from interface: Validator

Validate a changed property

Specified by:

propertyChanged in interface Editor

Specified by:

propertyChanged in interface Validator

Parameters:

before - the original property

after - the changed property

Throws:

CommitFailedException - if validation fails.

propertyDeleted

public void propertyDeleted(PropertyState before)
                     throws CommitFailedException

Description copied from interface: Validator

Validate a deleted property

Specified by:

propertyDeleted in interface Editor

Specified by:

propertyDeleted in interface Validator

Parameters:

before - the original property

Throws:

CommitFailedException - if validation fails.

childNodeAdded

public Validator childNodeAdded(java.lang.String name,
                                NodeState after)
                         throws CommitFailedException

Description copied from interface: Validator

Validate an added node

Specified by:

childNodeAdded in interface Editor

Specified by:

childNodeAdded in interface Validator

Parameters:

name - the name of the added node

after - the added node

Returns:

a Validator for after or null if validation should not decent into the subtree rooted at after.

Throws:

CommitFailedException - if validation fails.

childNodeChanged

public Validator childNodeChanged(java.lang.String name,
                                  NodeState before,
                                  NodeState after)
                           throws CommitFailedException

Description copied from interface: Validator

Validate a changed node

Specified by:

childNodeChanged in interface Editor

Specified by:

childNodeChanged in interface Validator

Parameters:

name - the name of the changed node

before - the original node

after - the changed node

Returns:

a Validator for after or null if validation should not decent into the subtree rooted at after.

Throws:

CommitFailedException - if validation fails.

childNodeDeleted

public Validator childNodeDeleted(java.lang.String name,
                                  NodeState before)
                           throws CommitFailedException

Description copied from interface: Validator

Validate a deleted node

Specified by:

childNodeDeleted in interface Editor

Specified by:

childNodeDeleted in interface Validator

Parameters:

name - The name of the deleted node.

before - the original node

Returns:

a Validator for the removed subtree or null if validation should not decent into the subtree

Throws:

CommitFailedException - if validation fails.