net.sf.saxon.style
Class XSLGeneralVariable

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

All Implemented Interfaces:

Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, NamespaceResolver, NodeInfo, ValueRepresentation, InstructionInfo, Locator

Direct Known Subclasses:

SaxonAssign, SQLColumn, XSLVariableDeclaration, XSLWithParam

public abstract class XSLGeneralVariable
extends StyleElement

This class defines common behaviour across xsl:variable, xsl:param, and xsl:with-param

See Also:

Serialized Form

Field Summary

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

REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE

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

NODE_LETTER

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

XSLGeneralVariable()

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
int	getConstructType() Get the type of construct.
NodeInfo	getFirstChild() Get the first child node of the element
NodeInfo	getLastChild() Get the last child node of the element
String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
String	getVariableDisplayName() Get the display name of the variable.
StructuredQName	getVariableQName() Get the QName of the variable
boolean	hasChildNodes() Determine if the node has any children.
boolean	isAssignable() Test whether it is permitted to assign to the variable using the saxon:assign extension element.
boolean	isGlobal() Test whether this is a global variable or parameter
boolean	isRequiredParam() Test whether this is a required parameter (required="yes")
boolean	isTunnelParam() Test whether this is a tunnel parameter (tunnel="yes")
boolean	mayContainSequenceConstructor() Determine whether this type of element is allowed to contain a template-body
void	prepareAttributes() Set the attribute list for the element.
void	setRedundant() Mark this global variable as redundant.
void	validate() Check that the stylesheet element is valid.

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

allocatePatternSlots, allocateSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkTopLevel, checkWithinTemplate, compile, compileSequenceConstructor, fixupReferences, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeValue, getContainingSlotManager, getContainingStylesheet, getExecutable, getHostLanguage, getLineNumber, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getObjectName, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, isExcludedNamespace, isExtensionNamespace, isInstruction, isTopLevel, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, postValidate, replaceSubExpression, reportAbsence, setLineNumber, setObjectName, substituteFor, typeCheck, typeCheck, 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

getClass, notify, notifyAll, toString, wait, wait, wait

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

getSystemId

Constructor Detail

XSLGeneralVariable

public XSLGeneralVariable()

Method Detail

mayContainSequenceConstructor

public boolean mayContainSequenceConstructor()

Determine whether this type of element is allowed to contain a template-body

Returns:

true: yes, it may contain a template-body

isAssignable

public boolean isAssignable()

Test whether it is permitted to assign to the variable using the saxon:assign extension element.

Returns:

true if the extra attribute saxon:assignable="yes" is present.

isTunnelParam

public boolean isTunnelParam()

Test whether this is a tunnel parameter (tunnel="yes")

Returns:

true if this is a tunnel parameter

isRequiredParam

public boolean isRequiredParam()

Test whether this is a required parameter (required="yes")

Returns:

true if this is a required parameter

isGlobal

public boolean isGlobal()

Test whether this is a global variable or parameter

Returns:

true if this is global

getVariableDisplayName

public String getVariableDisplayName()

Get the display name of the variable.

Returns:

the lexical QName

setRedundant

public void setRedundant()

Mark this global variable as redundant. This is done before prepareAttributes is called.

getVariableQName

public StructuredQName getVariableQName()

Get the QName of the variable

Returns:

the name as a structured QName, or a dummy name if the variable has no name attribute or has an invalid name attribute

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

Throws:

XPathException

validate

public void validate()
              throws XPathException

Description copied from class: StyleElement

Check that the stylesheet element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.

Overrides:

validate in class StyleElement

Throws:

XPathException

getConstructType

public int getConstructType()

Get the type of construct. This will be a constant in class Location. This method is part of the InstructionInfo interface

Specified by:

getConstructType in interface InstructionInfo

Overrides:

getConstructType in class StyleElement

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.

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

getStringValue

public 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 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()

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