org.exist.xpath
Class LocationStep

java.lang.Object
  extended byorg.exist.xpath.Step
      extended byorg.exist.xpath.LocationStep
All Implemented Interfaces:
Expression

public class LocationStep
extends Step


Field Summary
protected  NodeSet buf
           
protected  boolean keepVirtual
           
protected static org.apache.log4j.Category LOG
           
 
Fields inherited from class org.exist.xpath.Step
axis, inPredicate, pool, predicates, test
 
Constructor Summary
LocationStep(BrokerPool pool, int axis)
           
LocationStep(BrokerPool pool, int axis, NodeTest test)
           
 
Method Summary
protected  NodeSet applyPredicate(DocumentSet documents, NodeSet context)
           
 Value eval(DocumentSet documents, NodeSet context, NodeProxy node)
          Evaluate the expression represented by this object.
protected  NodeSet getAncestors(DocumentSet documents, NodeSet context)
           
protected  NodeSet getAttributes(DocumentSet documents, NodeSet context)
           
protected  NodeSet getChildren(DocumentSet documents, NodeSet context)
           
protected  NodeSet getDescendants(DocumentSet documents, NodeSet context)
           
protected  NodeImpl getNextSibling(NodeImpl last)
           
protected  NodeSet getParents(DocumentSet documents, NodeSet context)
           
protected  NodeSet getSiblings(DocumentSet documents, NodeSet context)
           
 DocumentSet preselect(DocumentSet inDocs)
          Determine the documents, taken from in_docs, for which this expression will possibly yield a result.
 void setKeepVirtual(boolean virtual)
           
 
Methods inherited from class org.exist.xpath.Step
addPredicate, getAxis, pprint, returnsType, setAxis, setInPredicate, setTest
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static org.apache.log4j.Category LOG

buf

protected NodeSet buf

keepVirtual

protected boolean keepVirtual
Constructor Detail

LocationStep

public LocationStep(BrokerPool pool,
                    int axis)

LocationStep

public LocationStep(BrokerPool pool,
                    int axis,
                    NodeTest test)
Method Detail

applyPredicate

protected NodeSet applyPredicate(DocumentSet documents,
                                 NodeSet context)

eval

public Value eval(DocumentSet documents,
                  NodeSet context,
                  NodeProxy node)
Description copied from interface: Expression
Evaluate the expression represented by this object. Depending on the context in which this expression is executed, either context, node or both of them may be set. An implementing class should know how to handle this. Most classes only expect context to contain a list of nodes which represents the current context of this expression.

Specified by:
eval in interface Expression
Specified by:
eval in class Step

getAttributes

protected NodeSet getAttributes(DocumentSet documents,
                                NodeSet context)

getChildren

protected NodeSet getChildren(DocumentSet documents,
                              NodeSet context)

getDescendants

protected NodeSet getDescendants(DocumentSet documents,
                                 NodeSet context)

getSiblings

protected NodeSet getSiblings(DocumentSet documents,
                              NodeSet context)

getNextSibling

protected NodeImpl getNextSibling(NodeImpl last)

getAncestors

protected NodeSet getAncestors(DocumentSet documents,
                               NodeSet context)

getParents

protected NodeSet getParents(DocumentSet documents,
                             NodeSet context)

preselect

public DocumentSet preselect(DocumentSet inDocs)
Description copied from interface: Expression
Determine the documents, taken from in_docs, for which this expression will possibly yield a result. An expression does not have to do anything here. It may simply return in_docs. This method is used to restrict the range of documents in question for a given xpath-expression. It is called before the xpath-expression is actually executed.

Specified by:
preselect in interface Expression
Overrides:
preselect in class Step

setKeepVirtual

public void setKeepVirtual(boolean virtual)


Copyright (C) Wolfgang Meier. All rights reserved.