net.sf.saxon.style
Class XSLVariable

java.lang.Object
  net.sf.saxon.tree.NodeImpl
      net.sf.saxon.tree.ElementImpl
          net.sf.saxon.tree.ElementWithAttributes
              net.sf.saxon.style.StyleElement
                  net.sf.saxon.style.XSLGeneralVariable
                      net.sf.saxon.style.XSLVariableDeclaration
                          net.sf.saxon.style.XSLVariable

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.Source, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, VariableDeclaration, FingerprintedNode, Item, NamespaceResolver, NodeInfo, ValueRepresentation, StylesheetProcedure, InstructionInfo, org.xml.sax.Locator

public class XSLVariable
extends XSLVariableDeclaration

Handler for xsl:variable elements in stylesheet.
The xsl:variable element has mandatory attribute name and optional attribute select

See Also:

Serialized Form

Field Summary

protected int

sequence

Fields inherited from class net.sf.saxon.style.XSLVariableDeclaration

references

Fields inherited from class net.sf.saxon.style.XSLGeneralVariable

assignable, constantText, global, implicitlyRequiredParam, redundant, requiredParam, requiredType, select, slotManager, tunnel

Fields inherited from class net.sf.saxon.style.StyleElement

defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version

Fields inherited from class net.sf.saxon.tree.ElementWithAttributes

attributeList, namespaceList

Fields inherited from class net.sf.saxon.tree.ElementImpl

nameCode, root

Fields inherited from class net.sf.saxon.tree.NodeImpl

index, NODE_LETTER, parent

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

XSLVariable()

Method Summary

void	addChild(NodeImpl node, int index) Add a child node to this node.
void	compact(int size) Compact the space used by this node
Expression	compile(Executable exec) Compile: used only for global variables.
Expression	compileLocalVariable(Executable exec)
protected AxisIterator	enumerateChildren(NodeTest test) Get an enumeration of the children of this node
NodeInfo	getFirstChild() Get the first child node of the element
NodeInfo	getLastChild() Get the last child node of the element
protected NodeImpl	getNthChild(int n) Get the nth child node of the element (numbering from 0)
SequenceType	getRequiredType() Get the static type of the variable.
protected long	getSequenceNumber() Get the node sequence number (in document order).
java.lang.String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
java.lang.CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
boolean	hasChildNodes() Determine if the node has any children.
boolean	isInstruction() Determine whether this node is an instruction.
void	prepareAttributes() Set the attribute list for the element.
protected void	useChildrenArray(NodeImpl[] array) Supply an array to be used for the array of children.

Methods inherited from class net.sf.saxon.style.XSLVariableDeclaration

fixupBinding, fixupReferences, getSlotManager, getSlotNumber, registerReference, setReferenceCount, setSlotNumber, validate

Methods inherited from class net.sf.saxon.style.XSLGeneralVariable

allowsAsAttribute, allowsRequired, allowsTunnelAttribute, allowsValue, checkAgainstRequiredType, getConstructType, getReturnedItemType, getVariableDisplayName, getVariableQName, initializeInstruction, isAssignable, isGlobal, isRequiredParam, isTunnelParam, mayContainSequenceConstructor, setRedundant

Methods inherited from class net.sf.saxon.style.StyleElement

allocateLocationId, allocatePatternSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeSets, getAttributeValue, getCommonChildItemType, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getObjectName, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, getWithParamInstructions, isExcludedNamespace, isExplaining, isExtensionNamespace, isPermittedChild, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, postValidate, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, replaceSubExpression, reportAbsence, setLineNumber, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree

Methods inherited from class net.sf.saxon.tree.ElementWithAttributes

copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, setNamespaceDeclarations

Methods inherited from class net.sf.saxon.tree.ElementImpl

generateId, getBaseURI, getDocumentRoot, getNameCode, getNodeKind, getRoot, getSystemId, setNameCode, setSystemId

Methods inherited from class net.sf.saxon.tree.NodeImpl

atomize, compareOrder, equals, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.expr.VariableDeclaration

getVariableQName

Methods inherited from interface net.sf.saxon.trace.InstructionInfo

getSystemId

Methods inherited from interface org.xml.sax.Locator

getColumnNumber, getPublicId

Methods inherited from interface javax.xml.transform.SourceLocator

getColumnNumber, getPublicId

Field Detail

sequence

protected int sequence

Constructor Detail

XSLVariable

public XSLVariable()

Method Detail

prepareAttributes

public void prepareAttributes()
                       throws XPathException

Description copied from class: StyleElement

Set the attribute list for the element. This is called to process the attributes (note the distinction from processAttributes in the superclass). Must be supplied in a subclass

Overrides:

prepareAttributes in class XSLGeneralVariable

Throws:

XPathException

isInstruction

public boolean isInstruction()

Determine whether this node is an instruction.

Overrides:

isInstruction in class XSLVariableDeclaration

Returns:

true - it is an instruction (well, it can be, anyway)

getRequiredType

public SequenceType getRequiredType()

Get the static type of the variable. This is the declared type, unless the value is statically known and constant, in which case it is the actual type of the value.

Specified by:

getRequiredType in class XSLVariableDeclaration

Returns:

the static type declared for the variable

compile

public Expression compile(Executable exec)
                   throws XPathException

Compile: used only for global variables. This method ensures space is available for local variables declared within this global variable

Specified by:

compile in class StyleElement

Parameters:

exec - the Executable

Returns:

either a ComputedExpression, or null. The value null is returned when compiling an instruction that returns a no-op, or when compiling a top-level object such as an xsl:template that compiles into something other than an instruction.

Throws:

XPathException

compileLocalVariable

public Expression compileLocalVariable(Executable exec)
                                throws XPathException

Throws:

XPathException

getSequenceNumber

protected final long getSequenceNumber()

Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and roots) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position.

Overrides:

getSequenceNumber in class NodeImpl

Returns:

the node sequence number

hasChildNodes

public final boolean hasChildNodes()

Determine if the node has any children.

Specified by:

hasChildNodes in interface NodeInfo

Overrides:

hasChildNodes in class NodeImpl

Returns:

true if the node has any children, false if the node has no children.

enumerateChildren

protected final AxisIterator enumerateChildren(NodeTest test)

Get an enumeration of the children of this node

Parameters:

test - A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned

Returns:

an iterator over the children of this node

getFirstChild

public final NodeInfo getFirstChild()

Get the first child node of the element

Overrides:

getFirstChild in class NodeImpl

Returns:

the first child node of the required type, or null if there are no children

getLastChild

public final NodeInfo getLastChild()

Get the last child node of the element

Overrides:

getLastChild in class NodeImpl

Returns:

the last child of the element, or null if there are no children

getNthChild

protected final NodeImpl getNthChild(int n)

Get the nth child node of the element (numbering from 0)

Parameters:

n - identifies the required child

Returns:

the last child of the element, or null if there is no n'th child

getStringValue

public java.lang.String getStringValue()

Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.

Returns:

the accumulated character content of the element, including descendant elements.

See Also:

Item.getStringValueCS()

getStringValueCS

public java.lang.CharSequence getStringValueCS()

Description copied from class: NodeImpl

Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.

Specified by:

getStringValueCS in interface Item

Specified by:

getStringValueCS in interface ValueRepresentation

Overrides:

getStringValueCS in class NodeImpl

Returns:

the string value of the item

See Also:

Item.getStringValue()

useChildrenArray

protected void useChildrenArray(NodeImpl[] array)

Supply an array to be used for the array of children. For system use only.

Parameters:

array - the array to be used

addChild

public void addChild(NodeImpl node,
                     int index)

Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.

Parameters:

node - the node to be added as a child of this node

index - the position where the child is to be added

compact

public void compact(int size)

Compact the space used by this node

Parameters:

size - the number of actual children