Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.saxonica.expr.flwor
Class CountClause

    java.lang.Object
      net.sf.saxon.expr.flwor.Clause
          com.saxonica.expr.flwor.CountClause

    public class CountClause

extends Clause

A "count" clause in a FLWOR expression

Field Summary

Fields inherited from class net.sf.saxon.expr.flwor.Clause
`COUNT, FOR, GROUPBYCLAUSE, LET, ORDERBYCLAUSE, WHERE, WINDOW`

Constructor Summary
`CountClause()`

Method Summary
`CountClause` | `copy()`
`void` | `explain(ExpressionPresenter out)` Diagnostic print of expression structure.
`int` | `getClauseKey()` Get a keyword identifying what kind of clause this is
`TuplePull` | `getPullStream(TuplePull base, XPathContext context)` Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies
`TuplePush` | `getPushStream(TuplePush destination, XPathContext context)` Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream
`LocalVariableBinding` | `getRangeVariable()`
`LocalVariableBinding[]` | `getRangeVariables()` Get the number of variables bound by this clause
`void` | `processSubExpressions(ExpressionProcessor processor)` Process the subexpressions of this clause
`void` | `setRangeVariable(LocalVariableBinding binding)`
`String` | `toString()`

Methods inherited from class net.sf.saxon.expr.flwor.Clause
`gatherVariableReferences, optimize, refineVariableType, typeCheck`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### CountClause

    public CountClause()

Method Detail

### getClauseKey

    public int getClauseKey()

  Description copied from class: `Clause`
  Get a keyword identifying what kind of clause this is

  Specified by:
    `getClauseKey` in class `Clause`
  Returns:
    the kind of clause

### copy

    public CountClause copy()

  Specified by:
    `copy` in class `Clause`

### setRangeVariable

    public void setRangeVariable(LocalVariableBinding binding)

### getRangeVariable

    public LocalVariableBinding getRangeVariable()

### getRangeVariables

    public LocalVariableBinding[] getRangeVariables()

  Get the number of variables bound by this clause

  Overrides:
    `getRangeVariables` in class `Clause`
  Returns:
    the number of variable bindings

### getPullStream

    public TuplePull getPullStream(TuplePull base,
                                   XPathContext context)

  Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies

  Specified by:
    `getPullStream` in class `Clause`
  Parameters:
    `base` - the input tuple stream
    `context` -
  Returns:
    the output tuple stream

### getPushStream

    public TuplePush getPushStream(TuplePush destination,
                                   XPathContext context)

  Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream

  Specified by:
    `getPushStream` in class `Clause`
  Parameters:
    `destination` - the output tuple stream
    `context` -
  Returns:
    the push tuple stream that implements the functionality of this clause of the FLWOR expression

### processSubExpressions

    public void processSubExpressions(ExpressionProcessor processor)
                               throws XPathException

  Process the subexpressions of this clause

  Specified by:
    `processSubExpressions` in class `Clause`
  Parameters:
    `processor` - the expression processor used to process the subexpressions
  Throws:
    `XPathException` - if any error is detected

### explain

    public void explain(ExpressionPresenter out)

  Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

  Specified by:
    `explain` in class `Clause`
  Parameters:
    `out` - the expression presenter used to display the structure

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.