Class XSLOutput

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.XSLOutput

All Implemented Interfaces:

Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item<NodeInfo>, MutableNodeInfo, NamespaceResolver, NodeInfo, ValueRepresentation<NodeInfo>, InstructionInfo, SiblingCountingNode, Locator

public class XSLOutput
extends StyleElement

An xsl:output element in the stylesheet.

See Also:

• Serialized Form

Field Summary

Fields inherited from class StyleElement

ACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, YES_NO

Fields inherited from class NodeImpl

NODE_LETTER

Fields inherited from interface NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields inherited from interface ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

Constructors

Constructor	Description
XSLOutput()

Method Summary

Modifier and Type	Method	Description
void	compileDeclaration(Executable exec, Declaration decl)	Compile a declaration in the stylesheet tree for use at run-time.
protected void	gatherOutputProperties(Properties details, HashMap<String,Integer> precedences, int thisPrecedence)	Validate the properties, and return the values as additions to a supplied Properties object.
StructuredQName	getFormatQName()	Get the name of the xsl:output declaration
boolean	isDeclaration()	Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).
void	prepareAttributes()	Set the attribute list for the element.
static String	prepareCharacterMaps(StyleElement element, String useCharacterMaps, Properties details)	Process the use-character-maps attribute
void	validate(Declaration decl)	Check that the stylesheet element is valid.

Methods inherited from class StyleElement

allocateLocationId, allocatePatternSlots, allocateSlots, bindLocalVariable, bindVariable, checkAttributeValue, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compile, compileError, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getColumnNumber, getCommonChildItemType, getConstructType, getContainerGranularity, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getEffectiveVersion, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getPreparedStylesheet, getPrincipalStylesheetModule, getProcessorVersion, getProperties, getProperty, getReturnedItemType, getSchemaType, getStaticContext, getSystemId, getTypeAnnotation, getWithParamInstructions, index, isActionCompleted, isExcludedNamespace, isExplaining, isExtensionNamespace, isInstruction, isPermittedChild, issueWarning, issueWarning, isTopLevel, isXslt30Processor, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, mayContainParam, mayContainSequenceConstructor, postValidate, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processStandardAttributes, processVersionAttribute, reportAbsence, seesAvuncularVariables, setActionCompleted, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree, xPath10ModeIsEnabled

Methods inherited from class ElementImpl

addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getPrefixForURI, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, initialise, isId, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, setLocation, setNameCode, setNamespaceDeclarations, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class ParentNodeImpl

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

Methods inherited from class NodeImpl

atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getRawParent, getSiblingPosition, getTypedValue, getURI, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace, setRawParent, setSiblingPosition

Methods inherited from class Object

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

Methods inherited from interface InstructionInfo

getLineNumber, getSystemId

Methods inherited from interface Locator

getColumnNumber, getPublicId

Methods inherited from interface NodeInfo

hashCode

Methods inherited from interface Source

isEmpty

Methods inherited from interface SourceLocator

getColumnNumber, getLineNumber, getPublicId, getSystemId

Constructor Details

XSLOutput

public XSLOutput()

Method Details

isDeclaration

public boolean isDeclaration()

Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).

Overrides:

isDeclaration in class StyleElement

Returns:

true for this element

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

Specified by:

prepareAttributes in class StyleElement

Throws:

XPathException - if a static error is detected

getFormatQName

public StructuredQName getFormatQName()

Get the name of the xsl:output declaration

Returns:

the name, as a structured QName; or null for an unnamed output declaration

validate

public void validate(Declaration 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

compileDeclaration

public void compileDeclaration(Executable exec,
 Declaration decl)

Description copied from class: StyleElement

Compile a declaration in the stylesheet tree for use at run-time.

Overrides:

compileDeclaration in class StyleElement

Parameters:

exec - the Executable

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

gatherOutputProperties

protected void gatherOutputProperties(Properties details,
 HashMap<String,Integer> precedences,
 int thisPrecedence)
                               throws XPathException

Validate the properties, and return the values as additions to a supplied Properties object.

Parameters:

details - the Properties object to be populated with property values

precedences - a HashMap to be populated with information about the precedence of the property values: the key is the property name as a Clark name, the value is a boxed integer giving the property's import precedence

thisPrecedence - the precedence of thi instruction

Throws:

XPathException - if an error is found

prepareCharacterMaps

public static String prepareCharacterMaps(StyleElement element,
 String useCharacterMaps,
 Properties details)
                                   throws XPathException

Process the use-character-maps attribute

Parameters:

element - the stylesheet element on which the use-character-maps attribute appears

useCharacterMaps - the value of the use-character-maps attribute

details - The existing output properties

Returns:

the augmented value of the use-character-maps attribute in Clark notation

Throws:

XPathException - if the value is invalid