org.jboss.dna.repository.sequencer
Class SequencerPathExpression

java.lang.Object
  extended by org.jboss.dna.repository.sequencer.SequencerPathExpression
All Implemented Interfaces:
Serializable

@Immutable
public class SequencerPathExpression
extends Object
implements Serializable

An expression that defines a selection of some change in the repository that signals a sequencing operation should be run, and the location where the sequencing output should be placed. Sequencer path expressions are used within the sequencer configurations and used to determine whether information in the repository needs to be sequenced.

A simple example is the following:

     /a/b/c@title => /d/e/f
 
which means that a sequencer (that uses this expression in its configuration) should be run any time there is a new or modified title property on the /a/b/c node, and that the output of the sequencing should be placed at /d/e/f.

See Also:
Serialized Form

Nested Class Summary
static class SequencerPathExpression.Matcher
           
 
Method Summary
static SequencerPathExpression compile(String expression)
          Compile the supplied expression and return the resulting SequencerPathExpression instance.
 boolean equals(Object obj)
          
 String getOutputExpression()
           
 String getSelectExpression()
           
 int hashCode()
          
 SequencerPathExpression.Matcher matcher(String absolutePath)
           
 String toString()
          
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

compile

public static final SequencerPathExpression compile(String expression)
                                             throws InvalidSequencerPathExpression
Compile the supplied expression and return the resulting SequencerPathExpression instance.

Parameters:
expression - the expression
Returns:
the path expression; never null
Throws:
IllegalArgumentException - if the expression is null
InvalidSequencerPathExpression - if the expression is blank or is not a valid expression

getSelectExpression

public String getSelectExpression()
Returns:
selectExpression

getOutputExpression

public String getOutputExpression()
Returns:
outputExpression

hashCode

public int hashCode()

Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:
equals in class Object

toString

public String toString()

Overrides:
toString in class Object

matcher

public SequencerPathExpression.Matcher matcher(String absolutePath)
Parameters:
absolutePath -
Returns:
the matcher


Copyright © 2008-2010 JBoss, a division of Red Hat. All Rights Reserved.