Class KeyDefinitionSet

  • All Implemented Interfaces:
    java.io.Serializable

    public class KeyDefinitionSet
    extends java.lang.Object
    implements java.io.Serializable
    A set of xsl:key definitions in a stylesheet that share the same name
    See Also:
    Serialized Form
    • Field Detail

      • keySetNumber

        int keySetNumber
      • collationName

        java.lang.String collationName
      • backwardsCompatible

        boolean backwardsCompatible
    • Constructor Detail

      • KeyDefinitionSet

        public KeyDefinitionSet​(StructuredQName keyName,
                                int keySetNumber)
        Create a key definition set for keys sharing a given name
        Parameters:
        keyName - the name of the key definitions in this set
        keySetNumber - a unique number identifying this key definition set
    • Method Detail

      • addKeyDefinition

        public void addKeyDefinition​(KeyDefinition keyDef)
                              throws XPathException
        Add a key definition to this set of key definitions. The caller is responsible for ensuring that all key definitions in a key definition set have the same name
        Parameters:
        keyDef - the key definition to be added
        Throws:
        XPathException - if the key definition uses a different collation from others in the set
      • getKeyName

        public StructuredQName getKeyName()
        Get the name of the key definitions in this set (they all share the same name)
        Returns:
        the name of these key definitions
      • getKeySetNumber

        public int getKeySetNumber()
        Get the KeySet number. This uniquely identifies the KeyDefinitionSet within a KeyManager
        Returns:
        the unique number
      • getKeyDefinitions

        public java.util.List<KeyDefinition> getKeyDefinitions()
        Get the key definitions in this set
        Returns:
        the key definitions in this set
      • isBackwardsCompatible

        public boolean isBackwardsCompatible()
        Determine if the keys are to be evaluated in backwards compatible mode
        Returns:
        true if backwards compatibility is in force for at least one of the keys in the set