net.sf.saxon.style

Class XSLMergeSource

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ParentNodeImpl

net.sf.saxon.tree.linked.ElementImpl

net.sf.saxon.style.StyleElement

net.sf.saxon.style.XSLMergeSource

All Implemented Interfaces:

Iterable<NodeInfo>, Source, SourceLocator, Location, GroundedValue<NodeInfo>, Item<NodeInfo>, MutableNodeInfo, NamespaceResolver, NodeInfo, Sequence<NodeInfo>, SteppingNode<NodeImpl>, SiblingCountingNode, Locator

public class XSLMergeSource
extends StyleElement

Implements the xsl:merge-source element available in XSLT 3.0 as a child of xsl:merge.

March 2012: xsl:merge-source and xsl:merge-input combined into a single element

Field Summary

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

ACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultMode, defaultXPathNamespace, expandText, extensionNamespaces, IGNORED_INSTRUCTION, REPORT_ALWAYS, REPORT_DYNAMICALLY_UNLESS_FALLBACK_AVAILABLE, REPORT_IF_INSTANTIATED, REPORT_STATICALLY_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version, YES_NO

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

NODE_LETTER

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor and Description
XSLMergeSource()

Method Summary

Modifier and Type	Method and Description
Expression	compile(Compilation exec, ComponentDeclaration decl) Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.
Expression	getForEachItem() Get the for-each-item expression, if it exists
Expression	getForEachSource() Get the for-each-source expression, if it exists
SchemaType	getSchemaTypeAttribute() Get the value of the type attribute, if present
Expression	getSelect() Get the select expression
String	getSourceName() Get the name of the merge source, or null if not specified
int	getValidationAction() Get the value of the validation attribute, if present
boolean	isInstruction() Determine whether this node is an instruction.
boolean	isSortBeforeMerge() Ask whether the sort-before-merge option is set
MergeInstr.MergeSource	makeMergeSource(MergeInstr mi, Expression select)
boolean	mayContainSequenceConstructor() Determine whether this type of element is allowed to contain a sequence constructor
protected void	prepareAttributes() Set the attribute list for the element.
void	validate(ComponentDeclaration decl) Check that the stylesheet element is valid.

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

allocateLocalSlots, allocateLocation, bindLocalVariable, bindVariable, changesRetainedStaticContext, checkAttributeValue, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compileContentValueTemplate, compileDeclaration, compileError, compileError, compileError, compileError, compileErrorInAttribute, compileSequenceConstructor, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, findAncestorElement, findCollation, fixupReferences, forwardsCompatibleModeIsEnabled, generateId, getAttributeValue, getBaseURI, getBindingInformation, getCompilation, getConfiguration, getConstructType, getContainingPackage, getContainingSlotManager, getContainingStylesheet, getDeclaredVisibility, getDefaultCollationName, getDefaultMode, getDefaultValidation, getDefaultXPathNamespace, getEffectiveVersion, getEffectiveVersionAsString, getLastChildInstruction, getNamespaceResolver, getObjectName, getOverriddenComponent, getPackageData, getPrincipalStylesheetModule, getProperties, getProperty, getSchemaType, getStaticContext, getStaticContext, getTypeAnnotation, getUsedAttributeSets, getUsedPackage, getVisibility, getWithParamInstructions, getXslOriginal, hasImplicitBinding, index, interpretVisibilityValue, invalidAttribute, isActionCompleted, isConstructingComplexContent, isDeclaration, isExcludedNamespace, isExpandingText, isExplaining, isExtensionNamespace, isNo, isPermittedChild, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, isYes, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeExtendedSequenceType, makeNamespaceContext, makePattern, makeQName, makeRetainedStaticContext, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, mayContainParam, postValidate, processAllAttributes, processAttributes, processBooleanAttribute, processDefaultCollationAttribute, processDefaultMode, processDefaultValidationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExpandTextAttribute, processExtensionElementAttribute, processStandardAttributes, processStreamableAtt, processVersionAttribute, reportAbsence, seesAvuncularVariables, setActionCompleted, setCompilation, setIgnoreInstruction, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree, validateValidationAttribute, xPath10ModeIsEnabled

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

addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getLineNumber, getNamespaceList, getNodeKind, getNodeName, getRoot, getSchemaType, getSystemId, getURIForPrefix, gsetAttributeCollection, initialise, isId, isIdref, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, setLocation, setNamespaceDeclarations, setNamespaceList, setNilled, setNodeName, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl

addChild, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, insertChildrenAt, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber

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

atomize, compareOrder, effectiveBooleanValue, equals, getDisplayName, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getRawParent, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasFingerprint, head, insertSiblings, isDeleted, iterate, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPosition

Methods inherited from class java.lang.Object

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

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

equals, getGenre, getPublicId, hashCode, isSameNodeInfo, isStreamed, toShortString

Methods inherited from interface net.sf.saxon.om.Item

getLength, itemAt, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XSLMergeSource

public XSLMergeSource()

Method Detail

isInstruction

public boolean isInstruction()

Determine whether this node is an instruction.

Overrides:

isInstruction in class StyleElement

Returns:

true - it is an instruction

mayContainSequenceConstructor

public boolean mayContainSequenceConstructor()

Determine whether this type of element is allowed to contain a sequence constructor

Overrides:

mayContainSequenceConstructor in class StyleElement

Returns:

false: no, it may not contain a sequence constructor

getForEachItem

public Expression getForEachItem()

Get the for-each-item expression, if it exists

Returns:

the for-each-item expression, if defined, or null otherwise

getForEachSource

public Expression getForEachSource()

Get the for-each-source expression, if it exists

Returns:

the for-each-source expression, if defined, or null otherwise

getSelect

public Expression getSelect()

Get the select expression

Returns:

the select expression. Never null.

isSortBeforeMerge

public boolean isSortBeforeMerge()

Ask whether the sort-before-merge option is set

Returns:

true if the input sequence is to be sorted before merging

getSourceName

public String getSourceName()

Get the name of the merge source, or null if not specified

Returns:

the value of the @name attribute, or null if the attribute was absent

getValidationAction

public int getValidationAction()

Get the value of the validation attribute, if present

Returns:

the value of the validation attribute

getSchemaTypeAttribute

public SchemaType getSchemaTypeAttribute()

Get the value of the type attribute, if present

Returns:

the value of the type attribute

makeMergeSource

public MergeInstr.MergeSource makeMergeSource(MergeInstr mi,
                                              Expression select)

compile

public Expression compile(Compilation exec,
                          ComponentDeclaration decl)
                   throws XPathException

Description copied from class: StyleElement

Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.

Overrides:

compile in class StyleElement

Parameters:

exec - the compilation episode

decl - the containing top-level declaration, for example xsl:function or xsl:template

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 - if validation fails

prepareAttributes

protected 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

Specified by:

prepareAttributes in class StyleElement

Throws:

XPathException - if a static error is detected

validate

public void validate(ComponentDeclaration decl)
              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

Parameters:

decl - the declaration to be validated

Throws:

XPathException - if any error is found during validation