|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.expr.Expression
net.sf.saxon.expr.UnaryExpression
net.sf.saxon.expr.SingletonAtomizer
public final class SingletonAtomizer
A SingletonAtomizer combines the functions of an Atomizer and a CardinalityChecker: it is used to atomize a sequence of nodes, checking that the result of the atomization contains zero or one atomic values. Note that the input may be a sequence of nodes or atomic values, even though the result must contain at most one atomic value.
| Field Summary |
|---|
| Fields inherited from class net.sf.saxon.expr.UnaryExpression |
|---|
operand |
| Fields inherited from class net.sf.saxon.expr.Expression |
|---|
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD |
| Constructor Summary | |
|---|---|
SingletonAtomizer(Expression sequence,
RoleLocator role,
boolean allowEmpty)
Constructor |
|
| Method Summary | |
|---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap. |
int |
computeCardinality()
Determine the static cardinality of the expression |
int |
computeSpecialProperties()
Determine the special properties of this expression |
Expression |
copy()
Copy an expression. |
Item |
evaluateItem(XPathContext context)
Evaluate as an Item. |
String |
getExpressionName()
Give a string representation of the expression name for use in diagnostics |
ItemType |
getItemType(TypeHierarchy th)
Determine the data type of the items returned by the expression, if possible |
RoleLocator |
getRole()
Get the RoleLocator (used to construct error messages) |
Expression |
optimize(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform optimisation of an expression and its subexpressions. |
Expression |
simplify(ExpressionVisitor visitor)
Simplify an expression |
Expression |
typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Type-check the expression |
| Methods inherited from class net.sf.saxon.expr.UnaryExpression |
|---|
displayOperator, equals, explain, getBaseExpression, hashCode, iterateSubExpressions, promote, replaceSubExpression, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public SingletonAtomizer(Expression sequence,
RoleLocator role,
boolean allowEmpty)
sequence - the sequence to be atomizedrole - contains information about where the expression appears, for use in any error messageallowEmpty - true if the result sequence is allowed to be empty.| Method Detail |
|---|
public Expression simplify(ExpressionVisitor visitor)
throws XPathException
simplify in class UnaryExpressionvisitor - an expression visitor
XPathException - if an error is discovered during expression
rewriting
public Expression typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
throws XPathException
typeCheck in class UnaryExpressionvisitor - an expression visitorcontextItemType - 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 to
Type.ITEM_TYPE
XPathException - if an error is discovered during this phase
(typically a type error)
public Expression optimize(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
throws XPathException
UnaryExpressionThis 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.
optimize in class UnaryExpressionvisitor - an expression visitorcontextItemType - 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 to
Type.ITEM_TYPE
XPathException - if an error is discovered during this phase
(typically a type error)public int computeSpecialProperties()
computeSpecialProperties in class UnaryExpressionStaticProperty.NON_CREATIVE.public Expression copy()
copy in class Expressionpublic RoleLocator getRole()
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
ExpressionThe default implementation of this method assumes that an expression does no navigation other than the navigation done by evaluating its subexpressions, and that the subexpressions are evaluated in the same context as the containing expression. The method must be overridden for any expression where these assumptions do not hold. For example, implementations exist for AxisExpression, ParentExpression, and RootExpression (because they perform navigation), and for the doc(), document(), and collection() functions because they create a new navigation root. Implementations also exist for PathExpression and FilterExpression because they have subexpressions that are evaluated in a different context from the calling expression.
addToPathMap in class ExpressionpathMap - the PathMap to which the expression should be addedpathMapNodeSet - the PathMapNodeSet to which the paths embodied in this expression should be added
public Item evaluateItem(XPathContext context)
throws XPathException
evaluateItem in class Expressioncontext - The context in which the expression is to be evaluated
XPathException - if any dynamic error occurs evaluating the
expressionpublic ItemType getItemType(TypeHierarchy th)
getItemType in class UnaryExpressionth - the type hierarchy cache
public int computeCardinality()
computeCardinality in class UnaryExpressionStaticProperty.ALLOWS_ZERO_OR_ONE,
StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ONE_OR_MORE,
StaticProperty.ALLOWS_ZERO_OR_MOREpublic String getExpressionName()
getExpressionName in class Expression
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||