public class AtomicSequenceConverter extends UnaryExpression
| Modifier and Type | Class and Description |
|---|---|
static class |
AtomicSequenceConverter.AtomicSequenceMappingFunction
Mapping function wrapped around a converter
|
static class |
AtomicSequenceConverter.ToStringMappingFunction
Mapping function that converts every item in a sequence to a string
|
| Modifier and Type | Field and Description |
|---|---|
protected Converter |
converter |
static AtomicSequenceConverter.ToStringMappingFunction |
TO_STRING_MAPPER |
operandEFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, INHERITED_CONTEXT, INSPECTION_CONTEXT, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, NAVIGATION_CONTEXT, NODE_VALUE_CONTEXT, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, W3C_CONSUMING, W3C_FREE_RANGING, W3C_GROUP_CONSUMING, W3C_MOTIONLESS, WATCH_METHOD| Constructor and Description |
|---|
AtomicSequenceConverter(Expression sequence,
PlainType requiredItemType)
Constructor
|
| Modifier and Type | Method and Description |
|---|---|
void |
allocateConverter(Configuration config,
boolean allowNull) |
int |
computeCardinality()
Determine the static cardinality of the expression
|
int |
computeSpecialProperties()
Determine the special properties of this expression
|
Expression |
copy()
Copy an expression.
|
protected String |
displayOperator(Configuration config)
Give a string representation of the operator for use in diagnostics
|
boolean |
equals(Object other)
Is this expression the same as another expression?
|
AtomicValue |
evaluateItem(XPathContext context)
Evaluate as an Item.
|
void |
explain(ExpressionPresenter destination)
Diagnostic print of expression structure.
|
Converter |
getConverter()
Get the converter used to convert the items in the sequence
|
ExpressionCompiler |
getExpressionCompiler()
Return the compiler of the expression
|
String |
getExpressionName()
Get a name identifying the kind of expression, in terms meaningful to a user.
|
ItemType |
getItemType(TypeHierarchy th)
Determine the data type of the items returned by the expression, if possible
|
PlainType |
getRequiredItemType()
Get the required item type (the target type of the conversion
|
int |
getStreamability(int syntacticContext,
boolean allowExtensions,
List<String> reasons)
Get the "sweep" of this expression as defined in the W3C streamability specifications.
|
AtomicSequenceConverterAdjunct |
getStreamingAdjunct()
Get a class that supports streamed evaluation of this expression
|
int |
hashCode()
get HashCode for comparing two expressions.
|
SequenceIterator<? extends AtomicValue> |
iterate(XPathContext context)
Iterate over the sequence of values
|
Expression |
optimize(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform optimisation of an expression and its subexpressions.
|
void |
setConverter(Converter converter) |
Expression |
simplify(ExpressionVisitor visitor)
Simplify an expression
|
Expression |
typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Type-check the expression
|
getBaseExpression, iterateSubExpressions, promote, replaceSubExpression, toStringaddToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getImplementationMethod, getIntegerBounds, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasVariableBinding, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, iterateSubExpressionInfo, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeErrorpublic static AtomicSequenceConverter.ToStringMappingFunction TO_STRING_MAPPER
protected Converter converter
public AtomicSequenceConverter(Expression sequence, PlainType requiredItemType)
sequence - this must be a sequence of atomic values. This is not checked; a ClassCastException
will occur if the precondition is not satisfied.requiredItemType - the item type to which all items in the sequence should be converted,public void allocateConverter(Configuration config, boolean allowNull)
public PlainType getRequiredItemType()
public Converter getConverter()
public void setConverter(Converter converter)
public Expression simplify(ExpressionVisitor visitor) throws XPathException
simplify in class UnaryExpressionvisitor - an expression visitorXPathException - if an error is discovered during expression
rewritingpublic 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_TYPEXPathException - if an error is discovered during this phase
(typically a type error)public Expression optimize(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
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_TYPEXPathException - if an error is discovered during this phase
(typically a type error)public int computeSpecialProperties()
computeSpecialProperties in class UnaryExpressionStaticProperty.NON_CREATIVE.public int getStreamability(int syntacticContext,
boolean allowExtensions,
List<String> reasons)
ExpressiongetStreamability in class ExpressionsyntacticContext - one of the values Expression.NAVIGATION_CONTEXT,
Expression.NODE_VALUE_CONTEXT, Expression.INHERITED_CONTEXT, Expression.INSPECTION_CONTEXTallowExtensions - if false, the definition of "guaranteed streamability" in the
W3C specification is used. If true, Saxon extensions are permitted, which make somereasons - the caller may supply a list, in which case the implementation may add to this
list a message explaining why the construct is not streamable, suitable for inclusion in an
error message.Expression.W3C_MOTIONLESS, Expression.W3C_CONSUMING,
Expression.W3C_GROUP_CONSUMING, Expression.W3C_FREE_RANGINGpublic AtomicSequenceConverterAdjunct getStreamingAdjunct()
getStreamingAdjunct in class Expressionpublic Expression copy()
copy in class Expressionpublic SequenceIterator<? extends AtomicValue> iterate(XPathContext context) throws XPathException
iterate in class Expressioncontext - supplies the context for evaluationXPathException - if any dynamic error occurs evaluating the
expressionpublic AtomicValue evaluateItem(XPathContext context) throws XPathException
evaluateItem in class Expressioncontext - The context in which the expression is to be evaluatedXPathException - if any dynamic error occurs evaluating the
expressionpublic ItemType getItemType(TypeHierarchy th)
getItemType in class UnaryExpressionth - the type hierarchy cachepublic int computeCardinality()
computeCardinality in class UnaryExpressionStaticProperty.ALLOWS_ZERO_OR_ONE,
StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ONE_OR_MORE,
StaticProperty.ALLOWS_ZERO_OR_MOREpublic boolean equals(Object other)
equals in class UnaryExpressionpublic int hashCode()
hashCode in class UnaryExpressionpublic ExpressionCompiler getExpressionCompiler()
getExpressionCompiler in class Expressionpublic String getExpressionName()
getExpressionName in class Expressionprotected String displayOperator(Configuration config)
UnaryExpressiondisplayOperator in class UnaryExpressionconfig - the Saxon configurationpublic void explain(ExpressionPresenter destination)
explain in class UnaryExpressiondestination - the expression presenter used to display the structureCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.