APIdia Launch Partner
Top Description Inners Fields Constructors Methods
com.sun.org.apache.xpath.internal.patterns

public Class FunctionPattern

extends StepPattern
Class Inheritance
Imports
com.sun.org.apache.xml.internal.dtm.DTM, .DTMIterator, com.sun.org.apache.xml.internal.utils.QName, com.sun.org.apache.xpath.internal.Expression, .ExpressionOwner, .XPathContext, .XPathVisitor, com.sun.org.apache.xpath.internal.objects.XNumber, .XObject, java.util.List
Match pattern step that contains a function.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
FunctionPattern.FunctionOwner

Field Summary

Modifier and TypeField and Description
pack-priv Expression
m_functionExpr

Should be a expression.

pack-priv static final long
serialVersionUID

Hides com.sun.org.apache.xpath.internal.patterns.StepPattern.serialVersionUID.

Inherited from com.sun.org.apache.xpath.internal.patterns.StepPattern:
m_axism_predicatesm_relativePathPatternm_targetString

Constructor Summary

AccessConstructor and Description
public
FunctionPattern(Expression expr, int axis, int predaxis)

Construct a FunctionPattern from a expression.

Method Summary

Modifier and TypeMethod and Description
public final void
calcScore()

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.calcScore.

Static calc of match score.

protected void
callSubtreeVisitors(XPathVisitor visitor)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.callSubtreeVisitors.

Call the visitor for the function.

public XObject

Returns:

com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NODETEST, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NONE, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NSWILD, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_QNAME, or com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_OTHER.
execute(XPathContext
XPath runtime context.
xctxt, int context)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

Test a node to see if it matches the given node test.

public XObject

Returns:

com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NODETEST, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NONE, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NSWILD, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_QNAME, or com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_OTHER.
execute(XPathContext
XPath runtime context.
xctxt, int context, DTM dtm, int expType)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

Test a node to see if it matches the given node test.

public XObject

Returns:

com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NODETEST, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NONE, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NSWILD, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_QNAME, or com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_OTHER.
execute(XPathContext
XPath runtime context.
xctxt)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

Test a node to see if it matches the given node test.

public void
fixupVariables(List<QName>
List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).
vars, int globalsSize)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.fixupVariables.

This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.

Inherited from com.sun.org.apache.xpath.internal.patterns.StepPattern:
calcTargetStringcallVisitorscanTraverseOutsideSubtreedeepEqualsexecutePredicatesexecuteRelativePathPatterngetAxisgetExpressiongetLastPosgetMatchScoregetPredicategetPredicateCountgetPredicatesgetProximityPositiongetRelativePathPatterngetTargetStringsetAxissetExpressionsetPredicatessetRelativePathPatterntoString

Field Detail

m_functionExprback to summary
pack-priv Expression m_functionExpr

Should be a expression.

serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides com.sun.org.apache.xpath.internal.patterns.StepPattern.serialVersionUID.

Constructor Detail

FunctionPatternback to summary
public FunctionPattern(Expression expr, int axis, int predaxis)

Construct a FunctionPattern from a expression. NEEDSDOC @param expr

Method Detail

calcScoreback to summary
public final void calcScore()

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.calcScore.

Static calc of match score.

callSubtreeVisitorsback to summary
protected void callSubtreeVisitors(XPathVisitor visitor)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.callSubtreeVisitors.

Call the visitor for the function.

executeback to summary
public XObject execute(XPathContext xctxt, int context) throws TransformerException

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

Test a node to see if it matches the given node test.

Parameters
xctxt:XPathContext

XPath runtime context.

Returns:XObject

com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NODETEST, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NONE, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NSWILD, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_QNAME, or com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_OTHER.

Exceptions
TransformerException:

Doc from com.sun.org.apache.xpath.internal.Expression.execute.

if a runtime exception occurs.

executeback to summary
public XObject execute(XPathContext xctxt, int context, DTM dtm, int expType) throws TransformerException

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

Test a node to see if it matches the given node test.

Parameters
xctxt:XPathContext

XPath runtime context.

Returns:XObject

com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NODETEST, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NONE, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NSWILD, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_QNAME, or com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_OTHER.

Exceptions
TransformerException:

Doc from com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

if a runtime exception occurs.

executeback to summary
public XObject execute(XPathContext xctxt) throws TransformerException

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.execute.

Test a node to see if it matches the given node test.

Parameters
xctxt:XPathContext

XPath runtime context.

Returns:XObject

com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NODETEST, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NONE, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_NSWILD, com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_QNAME, or com.sun.org.apache.xpath.internal.patterns.NodeTest#SCORE_OTHER.

Exceptions
TransformerException:

Doc from com.sun.org.apache.xpath.internal.Expression.execute.

if a runtime exception occurs.

fixupVariablesback to summary
public void fixupVariables(List<QName> vars, int globalsSize)

Overrides com.sun.org.apache.xpath.internal.patterns.StepPattern.fixupVariables.

This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.

Parameters
vars:List<QName>

List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).

com.sun.org.apache.xpath.internal.patterns back to summary

pack-priv Class FunctionPattern.FunctionOwner

extends Object
implements ExpressionOwner
Class Inheritance
  • java.lang.Object
  • com.sun.org.apache.xpath.internal.patterns.FunctionPattern.FunctionOwner
All Implemented Interfaces
com.sun.org.apache.xpath.internal.ExpressionOwner

Constructor Summary

AccessConstructor and Description
pack-priv
FunctionOwner()

Method Summary

Modifier and TypeMethod and Description
public Expression
getExpression()

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.getExpression.

Get the raw Expression object that this class wraps.

public void
setExpression(Expression exp)

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.setExpression.

Set the raw expression object for this object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

FunctionOwnerback to summary
pack-priv FunctionOwner()

Method Detail

getExpressionback to summary
public Expression getExpression()

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.getExpression.

Doc from com.sun.org.apache.xpath.internal.ExpressionOwner.getExpression.

Get the raw Expression object that this class wraps.

See Also
ExpressionOwner#getExpression()
setExpressionback to summary
public void setExpression(Expression exp)

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.setExpression.

Doc from com.sun.org.apache.xpath.internal.ExpressionOwner.setExpression.

Set the raw expression object for this object.

See Also
ExpressionOwner#setExpression(Expression)