Java Doc for StepPattern.java in  » XML » xalan » org » apache » xpath » patterns » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xalan » org.apache.xpath.patterns 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xpath.Expression
      org.apache.xpath.patterns.NodeTest
         org.apache.xpath.patterns.StepPattern

All known Subclasses:   org.apache.xpath.patterns.FunctionPattern,  org.apache.xpath.patterns.ContextMatchStepPattern,
StepPattern
public class StepPattern extends NodeTest implements SubContextList,ExpressionOwner(Code)
This class represents a single pattern match step.

Inner Class :class PredOwner implements ExpressionOwner

Field Summary
protected  intm_axis
     The axis for this test.
 Expression[]m_predicates
     The list of predicate expressions for this pattern step.
 StepPatternm_relativePathPattern
     Reference to nodetest and predicate for parent or ancestor.
 Stringm_targetString
     The target local name or psuedo name, for hash table lookup optimization.
final static  longserialVersionUID
    

Constructor Summary
public  StepPattern(int whatToShow, String namespace, String name, int axis, int axisForPredicate)
     Construct a StepPattern that tests for namespaces and node names.
public  StepPattern(int whatToShow, int axis, int axisForPredicate)
     Construct a StepPattern that doesn't test for node names.

Method Summary
public  voidcalcScore()
     Static calc of match score.
public  voidcalcTargetString()
     Calculate the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.
protected  voidcallSubtreeVisitors(XPathVisitor visitor)
     Call the visitors on the subtree.
public  voidcallVisitors(ExpressionOwner owner, XPathVisitor visitor)
    
public  booleancanTraverseOutsideSubtree()
     Tell if this expression or it's subexpressions can traverse outside the current subtree.
public  booleandeepEquals(Expression expr)
    
public  XObjectexecute(XPathContext xctxt, int currentNode)
     Execute this pattern step, including predicates.
Parameters:
  xctxt - XPath runtime context.
Parameters:
  currentNode - The current node context.
public  XObjectexecute(XPathContext xctxt)
     Execute this pattern step, including predicates.
Parameters:
  xctxt - XPath runtime context.
public  XObjectexecute(XPathContext xctxt, int currentNode, DTM dtm, int expType)
     Execute an expression in the XPath runtime context, and return the result of the expression.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  currentNode - The currentNode.
Parameters:
  dtm - The DTM of the current node.
Parameters:
  expType - The expanded type ID of the current node.
final protected  booleanexecutePredicates(XPathContext xctxt, DTM dtm, int currentNode)
     Execute the predicates on this step to determine if the current node should be filtered or accepted.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  dtm - The DTM of the current node.
Parameters:
  currentNode - The current node context.
final protected  XObjectexecuteRelativePathPattern(XPathContext xctxt, DTM dtm, int currentNode)
     Execute the match pattern step relative to another step.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  dtm - The DTM of the current node.
Parameters:
  currentNode - The current node context.
public  voidfixupVariables(java.util.Vector vars, int globalsSize)
     This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
Parameters:
  vars - List of QNames that correspond to variables.
public  intgetAxis()
     Get the axis that this step follows.
public  ExpressiongetExpression()
    
public  intgetLastPos(XPathContext xctxt)
     Get the count of the nodes that match the test, which is the proximity position of the last node that can pass this test in the sub context selection.
public  doublegetMatchScore(XPathContext xctxt, int context)
     Get the match score of the given node.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  context - The node to be tested.
public  ExpressiongetPredicate(int i)
     Get a predicate expression.
Parameters:
  i - The index of the predicate.
final public  intgetPredicateCount()
     Get the number of predicates for this match pattern step.
public  Expression[]getPredicates()
     Set the list of predicate expressions for this pattern step.
public  intgetProximityPosition(XPathContext xctxt)
     Get the proximity position index of the current node based on this node test.
Parameters:
  xctxt - XPath runtime context.
public  StepPatterngetRelativePathPattern()
     Get the reference to nodetest and predicate for parent or ancestor.
public  StringgetTargetString()
     Get the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.
public  voidsetAxis(int axis)
     Set the axis that this step should follow.
public  voidsetExpression(Expression exp)
    
public  voidsetPredicates(Expression[] predicates)
     Set the predicates for this match pattern step.
public  voidsetRelativePathPattern(StepPattern expr)
     Set the reference to nodetest and predicate for parent or ancestor.
public  StringtoString()
     Get the string represenentation of this step for diagnostic purposes.

Field Detail
m_axis
protected int m_axis(Code)
The axis for this test.



m_predicates
Expression[] m_predicates(Code)
The list of predicate expressions for this pattern step.



m_relativePathPattern
StepPattern m_relativePathPattern(Code)
Reference to nodetest and predicate for parent or ancestor.



m_targetString
String m_targetString(Code)
The target local name or psuedo name, for hash table lookup optimization.



serialVersionUID
final static long serialVersionUID(Code)




Constructor Detail
StepPattern
public StepPattern(int whatToShow, String namespace, String name, int axis, int axisForPredicate)(Code)
Construct a StepPattern that tests for namespaces and node names.
Parameters:
  whatToShow - Bit set defined mainly by org.w3c.dom.traversal.NodeFilter.
Parameters:
  namespace - The namespace to be tested.
Parameters:
  name - The local name to be tested.
Parameters:
  axis - The Axis for this test, one of of Axes.ANCESTORORSELF, etc.
Parameters:
  axisForPredicate - No longer used.



StepPattern
public StepPattern(int whatToShow, int axis, int axisForPredicate)(Code)
Construct a StepPattern that doesn't test for node names.
Parameters:
  whatToShow - Bit set defined mainly by org.w3c.dom.traversal.NodeFilter.
Parameters:
  axis - The Axis for this test, one of of Axes.ANCESTORORSELF, etc.
Parameters:
  axisForPredicate - No longer used.




Method Detail
calcScore
public void calcScore()(Code)
Static calc of match score.



calcTargetString
public void calcTargetString()(Code)
Calculate the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.
See Also:   org.apache.xpath.compiler.PsuedoNames



callSubtreeVisitors
protected void callSubtreeVisitors(XPathVisitor visitor)(Code)
Call the visitors on the subtree. Factored out from callVisitors so it may be called by derived classes.



callVisitors
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)(Code)

See Also:   org.apache.xpath.XPathVisitable.callVisitors(ExpressionOwnerXPathVisitor)



canTraverseOutsideSubtree
public boolean canTraverseOutsideSubtree()(Code)
Tell if this expression or it's subexpressions can traverse outside the current subtree. NOTE: Ancestors tests with predicates are problematic, and will require special treatment. true if traversal outside the context node's subtree can occur.



deepEquals
public boolean deepEquals(Expression expr)(Code)

See Also:   Expression.deepEquals(Expression)



execute
public XObject execute(XPathContext xctxt, int currentNode) throws javax.xml.transform.TransformerException(Code)
Execute this pattern step, including predicates.
Parameters:
  xctxt - XPath runtime context.
Parameters:
  currentNode - The current node context. org.apache.xpath.patterns.NodeTest.SCORE_NODETEST,org.apache.xpath.patterns.NodeTest.SCORE_NONE,org.apache.xpath.patterns.NodeTest.SCORE_NSWILD,org.apache.xpath.patterns.NodeTest.SCORE_QNAME, ororg.apache.xpath.patterns.NodeTest.SCORE_OTHER.
throws:
  javax.xml.transform.TransformerException -



execute
public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)
Execute this pattern step, including predicates.
Parameters:
  xctxt - XPath runtime context. org.apache.xpath.patterns.NodeTest.SCORE_NODETEST,org.apache.xpath.patterns.NodeTest.SCORE_NONE,org.apache.xpath.patterns.NodeTest.SCORE_NSWILD,org.apache.xpath.patterns.NodeTest.SCORE_QNAME, ororg.apache.xpath.patterns.NodeTest.SCORE_OTHER.
throws:
  javax.xml.transform.TransformerException -



execute
public XObject execute(XPathContext xctxt, int currentNode, DTM dtm, int expType) throws javax.xml.transform.TransformerException(Code)
Execute an expression in the XPath runtime context, and return the result of the expression.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  currentNode - The currentNode.
Parameters:
  dtm - The DTM of the current node.
Parameters:
  expType - The expanded type ID of the current node. The result of the expression in the form of a XObject.
throws:
  javax.xml.transform.TransformerException - if a runtime exceptionoccurs.



executePredicates
final protected boolean executePredicates(XPathContext xctxt, DTM dtm, int currentNode) throws javax.xml.transform.TransformerException(Code)
Execute the predicates on this step to determine if the current node should be filtered or accepted.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  dtm - The DTM of the current node.
Parameters:
  currentNode - The current node context. true if the node should be accepted, false otherwise.
throws:
  javax.xml.transform.TransformerException -



executeRelativePathPattern
final protected XObject executeRelativePathPattern(XPathContext xctxt, DTM dtm, int currentNode) throws javax.xml.transform.TransformerException(Code)
Execute the match pattern step relative to another step.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  dtm - The DTM of the current node.
Parameters:
  currentNode - The current node context. org.apache.xpath.patterns.NodeTest.SCORE_NODETEST,org.apache.xpath.patterns.NodeTest.SCORE_NONE,org.apache.xpath.patterns.NodeTest.SCORE_NSWILD,org.apache.xpath.patterns.NodeTest.SCORE_QNAME, ororg.apache.xpath.patterns.NodeTest.SCORE_OTHER.
throws:
  javax.xml.transform.TransformerException -



fixupVariables
public void fixupVariables(java.util.Vector vars, int globalsSize)(Code)
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
Parameters:
  vars - List of QNames that correspond to variables. This listshould be searched backwards for the first qualified name thatcorresponds to the variable reference qname. The position of theQName in the vector from the start of the vector will be its positionin the stack frame (but variables above the globalsTop value will needto be offset to the current stack frame).
Parameters:
  globalsSize - The number of variables in the global variable area.



getAxis
public int getAxis()(Code)
Get the axis that this step follows. The Axis for this test, one of of Axes.ANCESTORORSELF, etc.



getExpression
public Expression getExpression()(Code)

See Also:   ExpressionOwner.getExpression



getLastPos
public int getLastPos(XPathContext xctxt)(Code)
Get the count of the nodes that match the test, which is the proximity position of the last node that can pass this test in the sub context selection. In XSLT 1-based indexing, this count is the index of the last node.
Parameters:
  xctxt - XPath runtime context. the count of the nodes that match the test.



getMatchScore
public double getMatchScore(XPathContext xctxt, int context) throws javax.xml.transform.TransformerException(Code)
Get the match score of the given node.
Parameters:
  xctxt - The XPath runtime context.
Parameters:
  context - The node to be tested. org.apache.xpath.patterns.NodeTest.SCORE_NODETEST,org.apache.xpath.patterns.NodeTest.SCORE_NONE,org.apache.xpath.patterns.NodeTest.SCORE_NSWILD,org.apache.xpath.patterns.NodeTest.SCORE_QNAME, ororg.apache.xpath.patterns.NodeTest.SCORE_OTHER.
throws:
  javax.xml.transform.TransformerException -



getPredicate
public Expression getPredicate(int i)(Code)
Get a predicate expression.
Parameters:
  i - The index of the predicate. A predicate expression.



getPredicateCount
final public int getPredicateCount()(Code)
Get the number of predicates for this match pattern step. the number of predicates for this match pattern step.



getPredicates
public Expression[] getPredicates()(Code)
Set the list of predicate expressions for this pattern step. List of expression objects.



getProximityPosition
public int getProximityPosition(XPathContext xctxt)(Code)
Get the proximity position index of the current node based on this node test.
Parameters:
  xctxt - XPath runtime context. the proximity position index of the current node based on thenode test.



getRelativePathPattern
public StepPattern getRelativePathPattern()(Code)
Get the reference to nodetest and predicate for parent or ancestor. The relative pattern expression.



getTargetString
public String getTargetString()(Code)
Get the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization. local name or psuedo name of the node.
See Also:   org.apache.xpath.compiler.PsuedoNames



setAxis
public void setAxis(int axis)(Code)
Set the axis that this step should follow.
Parameters:
  axis - The Axis for this test, one of of Axes.ANCESTORORSELF, etc.



setExpression
public void setExpression(Expression exp)(Code)

See Also:   ExpressionOwner.setExpression(Expression)



setPredicates
public void setPredicates(Expression[] predicates)(Code)
Set the predicates for this match pattern step.
Parameters:
  predicates - An array of expressions that define predicatesfor this step.



setRelativePathPattern
public void setRelativePathPattern(StepPattern expr)(Code)
Set the reference to nodetest and predicate for parent or ancestor.
Parameters:
  expr - The relative pattern expression.



toString
public String toString()(Code)
Get the string represenentation of this step for diagnostic purposes. A string representation of this step, built by reverse-engineering the contained info.



Fields inherited from org.apache.xpath.patterns.NodeTest
final public static XNumber SCORE_NODETEST(Code)(Java Doc)
final public static XNumber SCORE_NONE(Code)(Java Doc)
final public static XNumber SCORE_NSWILD(Code)(Java Doc)
final public static XNumber SCORE_OTHER(Code)(Java Doc)
final public static XNumber SCORE_QNAME(Code)(Java Doc)
final public static int SHOW_BYFUNCTION(Code)(Java Doc)
final public static String SUPPORTS_PRE_STRIPPING(Code)(Java Doc)
final public static String WILD(Code)(Java Doc)
protected String m_name(Code)(Java Doc)
String m_namespace(Code)(Java Doc)
XNumber m_score(Code)(Java Doc)
protected int m_whatToShow(Code)(Java Doc)
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.xpath.patterns.NodeTest
protected void calcScore()(Code)(Java Doc)
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)(Code)(Java Doc)
public static void debugWhatToShow(int whatToShow)(Code)(Java Doc)
public boolean deepEquals(Expression expr)(Code)(Java Doc)
public XObject execute(XPathContext xctxt, int context) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, int context, DTM dtm, int expType) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void fixupVariables(java.util.Vector vars, int globalsSize)(Code)(Java Doc)
public double getDefaultScore()(Code)(Java Doc)
public String getLocalName()(Code)(Java Doc)
public String getNamespace()(Code)(Java Doc)
public static int getNodeTypeTest(int whatToShow)(Code)(Java Doc)
public XNumber getStaticScore()(Code)(Java Doc)
public int getWhatToShow()(Code)(Java Doc)
public void initNodeTest(int whatToShow)(Code)(Java Doc)
public void initNodeTest(int whatToShow, String namespace, String name)(Code)(Java Doc)
public void setLocalName(String name)(Code)(Java Doc)
public void setNamespace(String ns)(Code)(Java Doc)
public void setStaticScore(XNumber score)(Code)(Java Doc)
public void setWhatToShow(int what)(Code)(Java Doc)

Methods inherited from org.apache.xpath.Expression
public DTMIterator asIterator(XPathContext xctxt, int contextNode) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public DTMIterator asIteratorRaw(XPathContext xctxt, int contextNode) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public int asNode(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void assertion(boolean b, java.lang.String msg)(Code)(Java Doc)
public boolean bool(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public boolean canTraverseOutsideSubtree()(Code)(Java Doc)
abstract public boolean deepEquals(Expression expr)(Code)(Java Doc)
public void error(XPathContext xctxt, String msg, Object[] args) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, int currentNode) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, int currentNode, DTM dtm, int expType) throws javax.xml.transform.TransformerException(Code)(Java Doc)
abstract public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, boolean destructiveOK) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void executeCharsToContentHandler(XPathContext xctxt, ContentHandler handler) throws javax.xml.transform.TransformerException, org.xml.sax.SAXException(Code)(Java Doc)
public void exprAddChild(ExpressionNode n, int i)(Code)(Java Doc)
public ExpressionNode exprGetChild(int i)(Code)(Java Doc)
public int exprGetNumChildren()(Code)(Java Doc)
public ExpressionNode exprGetParent()(Code)(Java Doc)
public void exprSetParent(ExpressionNode n)(Code)(Java Doc)
abstract public void fixupVariables(java.util.Vector vars, int globalsSize)(Code)(Java Doc)
public int getColumnNumber()(Code)(Java Doc)
public ExpressionNode getExpressionOwner()(Code)(Java Doc)
public int getLineNumber()(Code)(Java Doc)
public String getPublicId()(Code)(Java Doc)
public String getSystemId()(Code)(Java Doc)
public boolean isNodesetExpr()(Code)(Java Doc)
final protected boolean isSameClass(Expression expr)(Code)(Java Doc)
public boolean isStableNumber()(Code)(Java Doc)
public double num(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void warn(XPathContext xctxt, String msg, Object[] args) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XMLString xstr(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.