net.sf.saxon.expr
Class AppendExpression

java.lang.Object
  extended bynet.sf.saxon.expr.ComputedExpression
      extended bynet.sf.saxon.expr.BinaryExpression
          extended bynet.sf.saxon.expr.AppendExpression
All Implemented Interfaces:
Expression, java.io.Serializable

public final class AppendExpression
extends BinaryExpression

An expression representing a sequence that is the concatenation of two given sequences. This implements the "comma" operator in XPath sequence expressions.

See Also:
Serialized Form

Nested Class Summary
static class AppendExpression.AppendIterator
          Iterator that concatenates the results of two supplied iterators
 
Field Summary
protected  Expression[] operands
           
protected  int operator
           
 
Fields inherited from class net.sf.saxon.expr.ComputedExpression
lineNumber, NO_ARGUMENTS, staticProperties
 
Constructor Summary
AppendExpression(Expression p1, int op, Expression p2)
          Constructor
 
Method Summary
 Expression analyze(StaticContext env)
          Type-check the expression.
 int computeCardinality()
          Determine the static cardinality of the expression
 void display(int level, NamePool pool)
          Diagnostic print of expression structure
protected  java.lang.String displayOperator()
           
 boolean equals(java.lang.Object other)
          Is this expression the same as another expression?
 ItemType getItemType()
          Determine the data type of the items returned by this expression
 Expression[] getSubExpressions()
          Get the immediate subexpressions of this expression
 int hashCode()
          get HashCode for comparing two expressions.
protected static boolean isCommutative(int operator)
           
 SequenceIterator iterate(XPathContext c)
          Iterate over the value of the expression.
 Expression promote(PromotionOffer offer)
          Promote this expression if possible
 void setDetails(Expression p1, int op, Expression p2)
          Identify the two operands and the operator (for use when the default constructor was used)
 Expression simplify()
          Simplify the expression
 
Methods inherited from class net.sf.saxon.expr.ComputedExpression
computeDependencies, computeSpecialProperties, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getDependencies, getIntrinsicDependencies, getLineNumber, getSpecialProperties, markTailFunctionCalls, setLineNumber, typeError
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

operands

protected Expression[] operands

operator

protected int operator
Constructor Detail

AppendExpression

public AppendExpression(Expression p1,
                        int op,
                        Expression p2)
Constructor

Parameters:
p1 - the left-hand operand
op - the operator (always ",")
p2 - the right-hand operand
Method Detail

getItemType

public final ItemType getItemType()
Determine the data type of the items returned by this expression

Returns:
the data type

computeCardinality

public final int computeCardinality()
Determine the static cardinality of the expression

Overrides:
computeCardinality in class BinaryExpression

simplify

public Expression simplify()
                    throws XPathException
Simplify the expression

Specified by:
simplify in interface Expression
Overrides:
simplify in class BinaryExpression
Returns:
the simplified expression
Throws:
XPathException

iterate

public SequenceIterator iterate(XPathContext c)
                         throws XPathException
Iterate over the value of the expression.

Specified by:
iterate in interface Expression
Overrides:
iterate in class ComputedExpression
Parameters:
c - The context for evaluation
Returns:
a SequenceIterator representing the concatenation of the two operands
Throws:
XPathException - if any dynamic error occurs evaluating the expression

setDetails

public void setDetails(Expression p1,
                       int op,
                       Expression p2)
Identify the two operands and the operator (for use when the default constructor was used)

Parameters:
p1 - the left-hand operand
op - the operator, as a token returned by the Tokenizer (e.g. Tokenizer.AND)
p2 - the right-hand operand

analyze

public Expression analyze(StaticContext env)
                   throws XPathException
Type-check the expression. Default implementation for binary operators that accept any kind of operand

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)

promote

public Expression promote(PromotionOffer offer)
                   throws XPathException
Promote this expression if possible

Specified by:
promote in interface Expression
Overrides:
promote in class ComputedExpression
Parameters:
offer - details of the offer, for example the offer to move expressions that don't depend on the context to an outer level in the containing expression
Returns:
if the offer is not accepted, return this expression unchanged. Otherwise return the result of rewriting the expression to promote this subexpression
Throws:
XPathException - if any error is detected

getSubExpressions

public Expression[] getSubExpressions()
Get the immediate subexpressions of this expression

Specified by:
getSubExpressions in interface Expression
Overrides:
getSubExpressions in class ComputedExpression
Returns:
an array containing the sub-expressions of this expression

isCommutative

protected static boolean isCommutative(int operator)

equals

public boolean equals(java.lang.Object other)
Is this expression the same as another expression?


hashCode

public int hashCode()
get HashCode for comparing two expressions. Note that this hashcode gives the same result for (A op B) and for (B op A), whether or not the operator is commutative.


display

public void display(int level,
                    NamePool pool)
Diagnostic print of expression structure

Parameters:
level - indentation level for this expression

displayOperator

protected java.lang.String displayOperator()