net.sf.saxon.instruct
Class AnalyzeString

java.lang.Object
  extended bynet.sf.saxon.expr.ComputedExpression
      extended bynet.sf.saxon.instruct.Instruction
          extended bynet.sf.saxon.instruct.AnalyzeString
All Implemented Interfaces:
Container, Expression, InstructionInfoProvider, java.io.Serializable, javax.xml.transform.SourceLocator

public class AnalyzeString
extends Instruction

An xsl:analyze-string elements in the stylesheet. New at XSLT 2.0

See Also:
Serialized Form

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
AnalyzeString(Expression select, Expression regex, Expression flags, Expression matching, Expression nonMatching, java.util.regex.Pattern pattern)
          Construct an AnalyzeString instruction
 
Method Summary
 Expression analyze(StaticContext env, ItemType contextItemType)
          Perform static analysis of an expression and its subexpressions.
 int computeDependencies()
          Compute the dependencies of an expression, as the union of the dependencies of its subexpressions.
 void display(int level, NamePool pool, java.io.PrintStream out)
          Diagnostic print of expression structure.
 int getInstructionNameCode()
          Get the namecode of the instruction for use in diagnostics
 ItemType getItemType()
          Get the item type of the items returned by evaluating this instruction
 Expression getMatchingExpression()
          Get the expression used to process matching substrings
 Expression getNonMatchingExpression()
          Get the expression used to process non-matching substrings
 java.util.Iterator 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)
 TailCall 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.
 Expression simplify(StaticContext env)
          Simplify an expression.
 
Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, createsNewNodes, dynamicError, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getImplementationMethod, getInstructionInfo, getSourceLocator, isXSLT, iterate, process, promote
 
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeStaticProperties, dynamicError, dynamicError, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getIntrinsicDependencies, getLineNumber, getLocationId, getParentExpression, getPublicId, getSpecialProperties, getSystemId, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, typeError, 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 Detail

AnalyzeString

public AnalyzeString(Expression select,
                     Expression regex,
                     Expression flags,
                     Expression matching,
                     Expression nonMatching,
                     java.util.regex.Pattern pattern)
Construct an AnalyzeString instruction

Parameters:
select - the expression containing the input string
regex - the regular expression
flags - the flags parameter
matching - actions to be applied to a matching substring
nonMatching - actions to be applied to a non-matching substring
pattern - the compiled regular expression, if it was known statically
Method Detail

getInstructionNameCode

public int getInstructionNameCode()
Description copied from class: Instruction
Get the namecode of the instruction for use in diagnostics

Overrides:
getInstructionNameCode in class Instruction

getMatchingExpression

public Expression getMatchingExpression()
Get the expression used to process matching substrings


getNonMatchingExpression

public Expression getNonMatchingExpression()
Get the expression used to process non-matching substrings


simplify

public Expression simplify(StaticContext env)
                    throws XPathException
Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression).

Specified by:
simplify in interface Expression
Specified by:
simplify in class Instruction
Returns:
the simplified expression
Throws:
XPathException - if an error is discovered during expression rewriting

analyze

public Expression analyze(StaticContext env,
                          ItemType contextItemType)
                   throws XPathException
Perform static analysis of an expression and its subexpressions.

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 will only be accurately known if they have been explicitly declared.

Specified by:
analyze in interface Expression
Specified by:
analyze in class Instruction
Parameters:
env - the static context of the expression
Returns:
the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
Throws:
XPathException - if an error is discovered during this phase (typically a type error)

getItemType

public ItemType getItemType()
Get the item type of the items returned by evaluating this instruction

Specified by:
getItemType in interface Expression
Overrides:
getItemType in class Instruction
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 class ComputedExpression
Returns:
the depencies, as a bit-mask

promoteInst

protected void promoteInst(PromotionOffer offer)
                    throws XPathException
Handle promotion offers, that is, non-local tree rewrites.

Overrides:
promoteInst in class Instruction
Parameters:
offer - The type of rewrite being offered
Throws:
XPathException

iterateSubExpressions

public java.util.Iterator 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 interface Expression
Overrides:
iterateSubExpressions in class ComputedExpression
Returns:
an iterator containing the sub-expressions of this expression

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws XPathException
Description copied from class: Instruction
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 class Instruction
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

display

public void display(int level,
                    NamePool pool,
                    java.io.PrintStream out)
Diagnostic print of expression structure. The expression is written to the System.err output stream

Parameters:
level - indentation level for this expression
out -
pool - NamePool used to expand any names appearing in the expression