Package net.sf.saxon.style
Class XSLKey
- All Implemented Interfaces:
Source,SourceLocator,GroundedValue,Item,MutableNodeInfo,NamespaceResolver,NodeInfo,Sequence,Location,StylesheetComponent,SteppingNode<NodeImpl>,SiblingCountingNode,Locator
Handler for xsl:key elements in stylesheet.
-
Nested Class Summary
Nested classes/interfaces inherited from class net.sf.saxon.style.StyleElement
StyleElement.OnFailure -
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, reportingCircumstances, staticContext, validationError, version, YES_NOFields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTERFields inherited from interface net.sf.saxon.om.NodeInfo
IS_DTD_TYPE, IS_NILLED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckCompatibility(Component component) Check the compatibility of this component with another component that it is overridingvoidcompileDeclaration(Compilation compilation, ComponentDeclaration decl) Compile a declaration in the stylesheet tree for use at run-time.voidGenerate byte code if appropriategetActor()Get the corresponding Actor object that results from the compilation of this StylesheetComponentGet the Procedure object that looks after any local variables declared in the content constructorGet the symbolic name of the component, that is, the combination of the component kind and the qualified namevoidindex(ComponentDeclaration decl, PrincipalStylesheetModule top) Method supplied by declaration elements to add themselves to a stylesheet-level indexbooleanAsk whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).booleanDetermine whether this type of element is allowed to contain a sequence constructorvoidoptimize(ComponentDeclaration declaration) Optimize the stylesheet constructvoidSet the attribute list for the element.voidvalidate(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, compile, compileContentValueTemplate, compileError, compileError, compileError, compileError, compileError, compileError, compileErrorInAttribute, compileSequenceConstructor, compileSequenceConstructor, compileWarning, compileWarning, compileWarning, fallbackProcessing, findAncestorElement, findCollation, fixupReferences, forwardsCompatibleModeIsEnabled, generateId, getAttributeValue, getBaseURI, getBindingInformation, getCompilation, getConfiguration, getContainingPackage, getContainingSlotManager, getDeclaredVisibility, getDefaultCollationName, getDefaultMode, getDefaultValidation, getDefaultXPathNamespace, getEffectiveVersion, getLastChildInstruction, getNamespaceResolver, getObjectName, getOverriddenComponent, getPackageData, getPrincipalStylesheetModule, getProperties, getSchemaType, getStaticContext, getStaticContext, getTypeAnnotation, getUsedAttributeSets, getUsedPackage, getVisibility, getWithParamInstructions, getXslOriginal, hasImplicitBinding, interpretVisibilityValue, invalidAttribute, isActionCompleted, isConstructingComplexContent, isExcludedNamespace, isExpandingText, isExtensionAttributeAllowed, isExtensionNamespace, isInstruction, isNo, isPermittedChild, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, isYes, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeExtendedSequenceType, makePattern, makeQName, makeRetainedStaticContext, makeSequenceType, makeSortKeys, markTailCalls, mayContainFallback, mayContainParam, postValidate, processAllAttributes, processAttributes, processBooleanAttribute, processDefaultCollationAttribute, processDefaultMode, processDefaultValidationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExpandTextAttribute, processExtensionElementAttribute, processStandardAttributes, processStreamableAtt, processVersionAttribute, reportAbsence, requireSyntaxExtensions, seesAvuncularVariables, setActionCompleted, setCompilation, setIgnoreInstruction, setInstructionLocation, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree, validateValidationAttribute, xPath10ModeIsEnabledMethods inherited from class net.sf.saxon.tree.linked.ElementImpl
addAttribute, addNamespace, addNamespace, attributes, checkNotNamespaceSensitiveElement, copy, delete, fixupInsertedNamespaces, generateId, getAllNamespaces, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getLineNumber, getNodeKind, getNodeName, getRoot, getSchemaType, getSystemId, getURIForPrefix, initialise, isId, isIdref, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeNamespace, removeTypeAnnotation, rename, replaceStringValue, setAttributeInfo, setAttributes, setLocation, setNamespaceMap, setNilled, setNodeName, setSystemId, setTypeAnnotationMethods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl
addChild, children, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumberMethods 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, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPositionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materializeMethods inherited from interface net.sf.saxon.om.Item
getLength, itemAt, iterate, reduce, subsequenceMethods inherited from interface net.sf.saxon.om.NodeInfo
children, equals, getGenre, getPublicId, hashCode, isSameNodeInfo, isStreamed, toShortStringMethods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
XSLKey
public XSLKey()
-
-
Method Details
-
getActor
Get the corresponding Actor object that results from the compilation of this StylesheetComponent- Specified by:
getActorin interfaceStylesheetComponent- Returns:
- the compiled ComponentCode
- Throws:
UnsupportedOperationException- for second-class components such as keys that support outwards references but not inwards references
-
getSymbolicName
Description copied from interface:StylesheetComponentGet the symbolic name of the component, that is, the combination of the component kind and the qualified name- Specified by:
getSymbolicNamein interfaceStylesheetComponent- Returns:
- the component's symbolic name
-
checkCompatibility
Description copied from interface:StylesheetComponentCheck the compatibility of this component with another component that it is overriding- Specified by:
checkCompatibilityin interfaceStylesheetComponent- Parameters:
component- the overridden component
-
isDeclaration
public boolean isDeclaration()Description copied from class:StyleElementAsk whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import). The default implementation returns false- Overrides:
isDeclarationin classStyleElement- Returns:
- true if the element is a permitted child of xsl:stylesheet or xsl:transform
-
mayContainSequenceConstructor
public boolean mayContainSequenceConstructor()Determine whether this type of element is allowed to contain a sequence constructor- Overrides:
mayContainSequenceConstructorin classStyleElement- Returns:
- true: yes, it may contain a sequence constructor
-
getSlotManager
Get the Procedure object that looks after any local variables declared in the content constructor- Specified by:
getSlotManagerin interfaceStylesheetComponent- Returns:
- the associated SlotManager object
-
prepareAttributes
public void prepareAttributes()Description copied from class:StyleElementSet 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:
prepareAttributesin classStyleElement
-
getKeyName
-
validate
Description copied from class:StyleElementCheck 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:
validatein classStyleElement- Parameters:
decl- the declaration to be validated- Throws:
XPathException- if any error is found during validation
-
index
Description copied from class:StyleElementMethod supplied by declaration elements to add themselves to a stylesheet-level index- Overrides:
indexin classStyleElement- Parameters:
decl- the Declaration being indexed. (This corresponds to the StyleElement object except in cases where one module is imported several times with different precedence.)top- represents the outermost XSLStylesheet or XSLPackage element
-
compileDeclaration
public void compileDeclaration(Compilation compilation, ComponentDeclaration decl) throws XPathException Description copied from class:StyleElementCompile a declaration in the stylesheet tree for use at run-time.- Overrides:
compileDeclarationin classStyleElement- Parameters:
compilation- the compilation episodedecl- the containing top-level declaration, for example xsl:function or xsl:template- Throws:
XPathException- if compilation fails
-
optimize
Optimize the stylesheet construct- Specified by:
optimizein interfaceStylesheetComponent- Parameters:
declaration- this xsl:key declaration- Throws:
XPathException
-
generateByteCode
Generate byte code if appropriate- Specified by:
generateByteCodein interfaceStylesheetComponent- Parameters:
opt- the optimizer
-