Package net.sf.saxon.expr
Class ContextItemExpression
- java.lang.Object
-
- net.sf.saxon.expr.ComputedExpression
-
- net.sf.saxon.expr.ContextItemExpression
-
- All Implemented Interfaces:
java.io.Serializable
,javax.xml.transform.SourceLocator
,Container
,Expression
,InstructionInfoProvider
- Direct Known Subclasses:
CurrentItemExpression
public class ContextItemExpression extends ComputedExpression
This class represents the expression "(dot)", which always returns the context item. This may be a AtomicValue or a Node.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description (package private) ItemType
itemType
-
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
-
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
-
Constructor Summary
Constructors Constructor Description ContextItemExpression()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
computeCardinality()
Get the static cardinalityint
computeSpecialProperties()
Determine the special properties of this expressionContextItemExpression
copy()
Create a clone copy of this expressionvoid
display(int level, java.io.PrintStream out, Configuration config)
Diagnostic print of expression structureboolean
equals(java.lang.Object other)
Is this expression the same as another expression?Item
evaluateItem(XPathContext context)
Evaluate the expressionprotected java.lang.String
getErrorCodeForUndefinedContext()
int
getIntrinsicDependencies()
Determine the intrinsic dependencies of an expression, that is, those which are not derived from the dependencies of its subexpressions.ItemType
getItemType(TypeHierarchy th)
Determine the item typeint
hashCode()
get HashCode for comparing two expressionsSequenceIterator
iterate(XPathContext context)
Iterate over the value of the expressionExpression
optimize(Optimizer opt, StaticContext env, ItemType contextItemType)
Perform optimisation of an expression and its subexpressions.Expression
typeCheck(StaticContext env, ItemType contextItemType)
Type-check the expression.-
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterateSubExpressions, markTailFunctionCalls, process, promote, replaceSubExpression, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, simplify, suppressValidation, typeError
-
-
-
-
Field Detail
-
itemType
ItemType itemType
-
-
Method Detail
-
copy
public ContextItemExpression copy()
Create a clone copy of this expression- Returns:
- a copy of this expression
-
getErrorCodeForUndefinedContext
protected java.lang.String getErrorCodeForUndefinedContext()
-
typeCheck
public Expression typeCheck(StaticContext env, ItemType contextItemType) throws XPathException
Type-check the expression.- Parameters:
env
- the static context of the expressioncontextItemType
- the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set toType.ITEM_TYPE
- Returns:
- the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
- Throws:
StaticError
- if an error is discovered during this phase (typically a type error)XPathException
-
optimize
public Expression optimize(Optimizer opt, StaticContext env, ItemType contextItemType) throws XPathException
Perform optimisation of an expression and its subexpressions.This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.
- Parameters:
opt
- the optimizer in use. This provides access to supporting functions; it also allows different optimization strategies to be used in different circumstances.env
- the static context of the expressioncontextItemType
- the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set toType.ITEM_TYPE
- Returns:
- the original expression, rewritten if appropriate to optimize execution
- Throws:
StaticError
- if an error is discovered during this phase (typically a type error)XPathException
-
getItemType
public ItemType getItemType(TypeHierarchy th)
Determine the item type- Parameters:
th
-- Returns:
- a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known at compile time)
-
computeCardinality
public int computeCardinality()
Get the static cardinality- Specified by:
computeCardinality
in classComputedExpression
-
computeSpecialProperties
public int computeSpecialProperties()
Determine the special properties of this expression- Overrides:
computeSpecialProperties
in classComputedExpression
- Returns:
StaticProperty.NON_CREATIVE
-
equals
public boolean equals(java.lang.Object other)
Is this expression the same as another expression?- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
get HashCode for comparing two expressions- Overrides:
hashCode
in classjava.lang.Object
-
getIntrinsicDependencies
public int getIntrinsicDependencies()
Description copied from class:ComputedExpression
Determine the intrinsic dependencies of an expression, that is, those which are not derived from the dependencies of its subexpressions. For example, position() has an intrinsic dependency on the context position, while (position()+1) does not. The default implementation of the method returns 0, indicating "no dependencies".- Overrides:
getIntrinsicDependencies
in classComputedExpression
- Returns:
- a set of bit-significant flags identifying the "intrinsic" dependencies. The flags are documented in class net.sf.saxon.value.StaticProperty
-
iterate
public SequenceIterator iterate(XPathContext context) throws XPathException
Iterate over the value of the expression- Specified by:
iterate
in interfaceExpression
- Overrides:
iterate
in classComputedExpression
- Parameters:
context
- supplies the context for evaluation- Returns:
- a SequenceIterator that can be used to iterate over the result of the expression
- Throws:
XPathException
- if any dynamic error occurs evaluating the expression
-
evaluateItem
public Item evaluateItem(XPathContext context) throws XPathException
Evaluate the expression- Specified by:
evaluateItem
in interfaceExpression
- Overrides:
evaluateItem
in classComputedExpression
- Parameters:
context
- The context in which the expression is to be evaluated- Returns:
- the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
- Throws:
XPathException
- if any dynamic error occurs evaluating the expression
-
display
public void display(int level, java.io.PrintStream out, Configuration config)
Diagnostic print of expression structure- Parameters:
level
- indentation level for this expressionout
- Output destination
-
-