Package net.sf.saxon.style
Class XSLMode
- java.lang.Object
- 
- All Implemented Interfaces:
- javax.xml.transform.Source,- javax.xml.transform.SourceLocator,- ActiveSource,- GroundedValue,- Item,- MutableNodeInfo,- NamespaceResolver,- NodeInfo,- Sequence,- Location,- SteppingNode,- SiblingCountingNode,- org.xml.sax.Locator
 
 public class XSLMode extends StyleElement Handler for xsl:mode elements in stylesheet. The xsl:mode element defines the properties of a mode. The mode is identified by the name attribute, defaulting to the unnamed default mode (which may also be written "#default").The attribute streamable="yes|no" which indicates whether templates in this mode are to be processed by streaming. The attribute on-no-match indicates which family of template rules should be used to process nodes when there is no explicit match 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class net.sf.saxon.style.StyleElementStyleElement.OnFailure
 
- 
 - 
Field Summary- 
Fields inherited from class net.sf.saxon.style.StyleElementACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultMode, defaultXPathNamespace, expandText, extensionNamespaces, reportingCircumstances, staticContext, validationError, version, YES_NO
 - 
Fields inherited from class net.sf.saxon.tree.linked.NodeImplNODE_LETTER
 
- 
 - 
Constructor SummaryConstructors Constructor Description XSLMode()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcompileDeclaration(Compilation compilation, ComponentDeclaration decl)Compile a declaration in the stylesheet tree for use at run-time.SimpleModegetMode()StructuredQNamegetObjectName()Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.voidindex(ComponentDeclaration decl, PrincipalStylesheetModule top)Method supplied by declaration elements to add themselves to a stylesheet-level indexbooleanisDeclaration()Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).booleanisInstruction()Determine whether this node is an instruction.protected voidprepareAttributes()Set the attribute list for the element.voidvalidate(ComponentDeclaration decl)Check that the stylesheet element is valid.- 
Methods inherited from class net.sf.saxon.style.StyleElementallocateLocation, arrayToSequence, bindLocalVariable, bindVariable, checkEmpty, checkTopLevel, checkUnknownAttribute, compile, compileError, compileError, compileError, compileError, compileError, compileError, compileErrorInAttribute, compileSequenceConstructor, compileSequenceConstructor, compileWarning, compileWarning, compileWarning, fixupReferences, generateId, getAttributeValue, getBaseURI, getBindingInformation, getCompilation, getConfiguration, getContainingPackage, getContainingSlotManager, getDeclaredVisibility, getDefaultCollationName, getDefaultXPathNamespace, getNamespaceResolver, getPackageData, getPrincipalStylesheetModule, getProperties, getSchemaType, getStaticContext, getStaticContext, getTypeAnnotation, getUsedPackage, getVisibility, getWithParamInstructions, getXslOriginal, hasImplicitBinding, invalidAttribute, isExtensionAttributeAllowed, isExtensionNamespace, isNo, isPermittedChild, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, isYes, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeQName, makeRetainedStaticContext, makeSequenceType, mapToSequence, markTailCalls, mayContainFallback, mayContainParam, mayContainSequenceConstructor, postValidate, processAllAttributes, processAttributes, processBooleanAttribute, processStandardAttributes, processVersionAttribute, reportAbsence, requireXslt40, seesAvuncularVariables, setCompilation, setInstructionLocation, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, validateChildren, validateSubtree, validateValidationAttribute
 - 
Methods inherited from class net.sf.saxon.tree.linked.ElementImpladdAttribute, addNamespace, addNamespace, attributes, checkNotNamespaceSensitiveElement, copy, delete, fixupInsertedNamespaces, generateId, getAllNamespaces, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getLineNumber, getNodeKind, getNodeName, getRoot, getSchemaType, getSystemId, getURIForPrefix, initialise, isId, isIdref, isIdRefNode, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeNamespace, removeTypeAnnotation, rename, replaceStringValue, setAttributeInfo, setAttributes, setLocation, setNamespaceMap, setNilled, setNodeName, setSystemId, setTypeAnnotation
 - 
Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpladdChild, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getUnicodeStringValue, hasChildNodes, insertChildren, insertChildrenAt, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber
 - 
Methods inherited from class net.sf.saxon.tree.linked.NodeImplatomize, compareOrder, effectiveBooleanValue, equals, getDisplayName, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getRawParent, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasFingerprint, hashCode, head, insertSiblings, isDeleted, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPosition
 - 
Methods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface net.sf.saxon.om.GroundedValueasIterable, concatenate, containsNode, materialize
 - 
Methods inherited from interface net.sf.saxon.om.ItemgetLength, getStringValue, itemAt, iterate, reduce, subsequence
 - 
Methods inherited from interface net.sf.saxon.om.NodeInfoasActiveSource, children, children, deliver, getGenre, getPublicId, isSameNodeInfo, isStreamed, toShortString
 - 
Methods inherited from interface net.sf.saxon.om.SequencemakeRepeatable
 
- 
 
- 
- 
- 
Method Detail- 
isDeclarationpublic boolean isDeclaration() Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).- Overrides:
- isDeclarationin class- StyleElement
- Returns:
- true for this element
 
 - 
isInstructionpublic boolean isInstruction() Determine whether this node is an instruction.- Overrides:
- isInstructionin class- StyleElement
- Returns:
- false - it is a declaration
 
 - 
getObjectNamepublic StructuredQName getObjectName() Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically. If there is no name, the value will be null.- Overrides:
- getObjectNamein class- StyleElement
- Returns:
- the name of the object declared in this element, if any
 
 - 
indexpublic void index(ComponentDeclaration decl, PrincipalStylesheetModule top) throws XPathException Method supplied by declaration elements to add themselves to a stylesheet-level index- Overrides:
- indexin class- StyleElement
- 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- the outermost XSLStylesheet element
- Throws:
- XPathException- if any error is encountered
 
 - 
prepareAttributesprotected 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 class- StyleElement
 
 - 
validatepublic void validate(ComponentDeclaration decl) throws XPathException 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 class- StyleElement
- Parameters:
- decl- the declaration to be validated
- Throws:
- XPathException- if any error is found during validation
 
 - 
compileDeclarationpublic 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 class- StyleElement
- Parameters:
- compilation- the compilation episode
- decl- the containing top-level declaration, for example xsl:function or xsl:template
- Throws:
- XPathException- if compilation fails
 
 - 
getModepublic SimpleMode getMode() 
 
- 
 
-