Class AnalyzeString
- All Implemented Interfaces:
Serializable
,SourceLocator
,Container
,Expression
,TailCallReturner
,InstructionInfoProvider
- See Also:
-
Field Summary
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
ConstructorsConstructorDescriptionAnalyzeString
(Expression select, Expression regex, Expression flags, Expression matching, Expression nonMatching, RegularExpression pattern) Construct an AnalyzeString instruction -
Method Summary
Modifier and TypeMethodDescriptionvoid
checkPermittedContents
(SchemaType parentType, StaticContext env, boolean whole) Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type.int
Compute the dependencies of an expression, as the union of the dependencies of its subexpressions.void
display
(int level, PrintStream out, Configuration config) Diagnostic print of expression structure.int
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().int
Get the namecode of the instruction for use in diagnosticsGet the item type of the items returned by evaluating this instructionGet the expression used to process matching substringsGet the expression used to process non-matching substringsiterate
(XPathContext context) Return an Iterator to iterate over the values of a sequence.Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)optimize
(Optimizer opt, StaticContext env, ItemType contextItemType) Perform optimisation of an expression and its subexpressions.processLeavingTail
(XPathContext context) ProcessLeavingTail: called to do the real work of this instruction.protected void
promoteInst
(PromotionOffer offer) Handle promotion offers, that is, non-local tree rewrites.boolean
replaceSubExpression
(Expression original, Expression replacement) Replace one subexpression by a replacement subexpressionsimplify
(StaticContext env) Simplify an expression.typeCheck
(StaticContext env, ItemType contextItemType) Perform type checking of an expression and its subexpressions.Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, createsNewNodes, dynamicError, evaluateAsString, evaluateItem, getInstructionInfo, getSourceLocator, isXSLT, process, promote
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
-
Constructor Details
-
AnalyzeString
public AnalyzeString(Expression select, Expression regex, Expression flags, Expression matching, Expression nonMatching, RegularExpression pattern) Construct an AnalyzeString instruction- Parameters:
select
- the expression containing the input stringregex
- the regular expressionflags
- the flags parametermatching
- actions to be applied to a matching substringnonMatching
- actions to be applied to a non-matching substringpattern
- the compiled regular expression, if it was known statically
-
-
Method Details
-
getInstructionNameCode
public int getInstructionNameCode()Description copied from class:Instruction
Get the namecode of the instruction for use in diagnostics- Overrides:
getInstructionNameCode
in classInstruction
-
getImplementationMethod
public int getImplementationMethod()An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is prefered.- Specified by:
getImplementationMethod
in interfaceExpression
- Overrides:
getImplementationMethod
in classInstruction
-
getMatchingExpression
Get the expression used to process matching substrings -
getNonMatchingExpression
Get the expression used to process non-matching substrings -
simplify
Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression).- Specified by:
simplify
in interfaceExpression
- Specified by:
simplify
in classInstruction
- Parameters:
env
- the static context- Returns:
- the simplified expression
- Throws:
XPathException
- if an error is discovered during expression rewriting
-
typeCheck
Description copied from interface:Expression
Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.
This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.
If the implementation returns a value other than "this", then it is required to ensure that the parent pointer and location information in the returned expression have been set up correctly. It should not rely on the caller to do this, although for historical reasons many callers do so.
- 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:
XPathException
-
optimize
public Expression optimize(Optimizer opt, StaticContext env, ItemType contextItemType) throws XPathException Description copied from interface:Expression
Perform optimisation of an expression and its subexpressions. This is the third and final phase of static optimization.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:
XPathException
-
checkPermittedContents
public void checkPermittedContents(SchemaType parentType, StaticContext env, boolean whole) throws XPathException Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type. It's always OK to say yes, since the check will be repeated at run-time. The process of checking element and attribute constructors against the content model of a complex type also registers the type of content expected of those constructors, so the static validation can continue recursively.- Specified by:
checkPermittedContents
in interfaceExpression
- Overrides:
checkPermittedContents
in classComputedExpression
- Parameters:
parentType
- The schema typeenv
- the static contextwhole
- true if this expression is expected to make the whole content of the type, false if it is expected to make up only a part- Throws:
XPathException
- if the expression doesn't match the required content type
-
getItemType
Get the item type of the items returned by evaluating this instruction- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classInstruction
- Parameters:
th
-- Returns:
- the static item type of the instruction
-
computeDependencies
public int computeDependencies()Compute the dependencies of an expression, as the union of the dependencies of its subexpressions. (This is overridden for path expressions and filter expressions, where the dependencies of a subexpression are not all propogated). This method should be called only once, to compute the dependencies; after that, getDependencies should be used.- Overrides:
computeDependencies
in classComputedExpression
- Returns:
- the depencies, as a bit-mask
-
promoteInst
Handle promotion offers, that is, non-local tree rewrites.- Overrides:
promoteInst
in classInstruction
- Parameters:
offer
- The type of rewrite being offered- Throws:
XPathException
-
iterateSubExpressions
Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)- Specified by:
iterateSubExpressions
in interfaceExpression
- Overrides:
iterateSubExpressions
in classComputedExpression
- Returns:
- an iterator containing the sub-expressions of this expression
-
replaceSubExpression
Replace one subexpression by a replacement subexpression- Specified by:
replaceSubExpression
in interfaceContainer
- Overrides:
replaceSubExpression
in classComputedExpression
- Parameters:
original
- the original subexpressionreplacement
- the replacement subexpression- Returns:
- true if the original subexpression is found
-
processLeavingTail
ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.- Specified by:
processLeavingTail
in interfaceTailCallReturner
- Specified by:
processLeavingTail
in classInstruction
- Parameters:
context
- The dynamic context of the transformation, giving access to the current node, the current variables, etc.- Returns:
- null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.
- Throws:
XPathException
-
iterate
Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.- Specified by:
iterate
in interfaceExpression
- Overrides:
iterate
in classInstruction
- 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
-
display
Diagnostic print of expression structure. The expression is written to the System.err output stream- Parameters:
level
- indentation level for this expressionout
-config
-
-