Package net.sf.saxon.style

Class XSLKey

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.XSLKey
All Implemented Interfaces:
Source, SourceLocator, ActiveSource, GroundedValue, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, Sequence, Location, StylesheetComponent, SteppingNode, SiblingCountingNode, Locator
public class XSLKey extends StyleElement implements StylesheetComponent
Handler for xsl:key elements in stylesheet.

  • Constructor Details

    • XSLKey

      public XSLKey()

  • Method Details

    • getActor

      public Actor getActor()
      Get the corresponding Actor object that results from the compilation of this StylesheetComponent
      Specified by:
      getActor in interface StylesheetComponent
      Returns:
      the compiled ComponentCode
      Throws:
      UnsupportedOperationException - for second-class components such as keys that support outwards references but not inwards references

    • getSymbolicName

      public SymbolicName getSymbolicName()
      Description copied from interface: StylesheetComponent
      Get the symbolic name of the component, that is, the combination of the component kind and the qualified name
      Specified by:
      getSymbolicName in interface StylesheetComponent
      Returns:
      the component's symbolic name

    • checkCompatibility

      public void checkCompatibility(Component component)
      Description copied from interface: StylesheetComponent
      Check the compatibility of this component with another component that it is overriding
      Specified by:
      checkCompatibility in interface StylesheetComponent
      Parameters:
      component - the overridden component

    • isDeclaration

      public boolean isDeclaration()
      Description copied from class: StyleElement
      Ask 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:
      isDeclaration in class StyleElement
      Returns:
      true if the element is a permitted child of xsl:stylesheet or xsl:transform

    • mayContainSequenceConstructor

      protected boolean mayContainSequenceConstructor()
      Determine whether this type of element is allowed to contain a sequence constructor
      Overrides:
      mayContainSequenceConstructor in class StyleElement
      Returns:
      true: yes, it may contain a sequence constructor

    • getSlotManager

      public SlotManager getSlotManager()
      Get the Procedure object that looks after any local variables declared in the content constructor
      Specified by:
      getSlotManager in interface StylesheetComponent
      Returns:
      the associated SlotManager object

    • prepareAttributes

      protected void prepareAttributes()
      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

    • getKeyName

      public StructuredQName getKeyName()

    • 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

    • index

      public void index(ComponentDeclaration decl, PrincipalStylesheetModule top)
      Description copied from class: StyleElement
      Method supplied by declaration elements to add themselves to a stylesheet-level index
      Overrides:
      index in 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 - represents the outermost XSLStylesheet or XSLPackage element

    • compileDeclaration

      public void compileDeclaration(Compilation compilation, ComponentDeclaration decl) throws XPathException
      Description copied from class: StyleElement
      Compile a declaration in the stylesheet tree for use at run-time.
      Overrides:
      compileDeclaration in 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

    • optimize

      public void optimize(ComponentDeclaration declaration) throws XPathException
      Optimize the stylesheet construct
      Specified by:
      optimize in interface StylesheetComponent
      Parameters:
      declaration - this xsl:key declaration
      Throws:
      XPathException - if an error is found at this stage (which shouldn't really happen)