com.ibm.xml.xapi

Interface XSequenceTypeFactory



  • public interface XSequenceTypeFactory
    Factory for creating sequence types. The sequence type factory associated with an XFactory instance can be obtained by calling the getSequenceTypeFactory method on the XFactory instance. The two are related because they share the schemas that are registered with the XFactory instance. Schemas added to the XFactory after getSequenceTypeFactory is called will be visible to the XSequenceTypeFactory instance that was returned.
    See Also:
    XSequenceType, XFactory.getSequenceTypeFactory()
    • Method Detail

      • emptySequence

        XSequenceType emptySequence()
        Creates a sequence type that matches the empty sequence.
        Returns:
        an XSequenceType
      • item

        XSequenceType item(XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches items.
        Parameters:
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
      • atomic

        XSequenceType atomic(javax.xml.namespace.QName typeName,
                           XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches atomic items.
        Parameters:
        typeName - the name of the simple type to match
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if typeName or cardinality is null
        java.lang.IllegalArgumentException - if typeName does not refer to a known simple type
      • documentNode

        XSequenceType documentNode(XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches document nodes.
        Parameters:
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
      • documentNodeWithElement

        XSequenceType documentNodeWithElement(javax.xml.namespace.QName elementNameOrWildcard,
                                            javax.xml.namespace.QName typeName,
                                            boolean nillable,
                                            XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches document nodes having exactly one element node matching a given element test.
        Parameters:
        elementNameOrWildcard - the name of the element to match or null for wildcard
        typeName - the name of a type to match (or null for any type)
        nillable - whether the sequence type matches nil elements
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
        java.lang.IllegalArgumentException - if a typeName is supplied but does not refer to a known type
      • documentNodeWithSchemaElement

        XSequenceType documentNodeWithSchemaElement(javax.xml.namespace.QName elementName,
                                                  XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches document nodes having exactly one element node matching a given schema-element test.
        Parameters:
        elementName - the name of the schema element declaration to match
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if elementName or cardinality is null
        java.lang.IllegalArgumentException - if elementName refers to an unknown global element declaration
      • element

        XSequenceType element(javax.xml.namespace.QName elementNameOrWildcard,
                            javax.xml.namespace.QName typeName,
                            boolean nillable,
                            XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches elements
        Parameters:
        elementNameOrWildcard - the name of the element to match or null for wildcard
        typeName - the name of a type to match (or null for any type)
        nillable - whether the sequence type matches nil elements
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
        java.lang.IllegalArgumentException - if a typeName is supplied but does not refer to a known type
      • attribute

        XSequenceType attribute(javax.xml.namespace.QName attributeNameOrWildcard,
                              javax.xml.namespace.QName typeName,
                              XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches attributes.
        Parameters:
        attributeNameOrWildcard - the name of the attribute to match or null for wildcard
        typeName - the name of a simple type to match (or null for any type)
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
        java.lang.IllegalArgumentException - if a typeName is supplied but does not refer to a known simple type
      • schemaElement

        XSequenceType schemaElement(javax.xml.namespace.QName elementName,
                                  XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches schema elements.
        Parameters:
        elementName - the name of the schema element declaration to match
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if elementName or cardinality is null
        java.lang.IllegalArgumentException - if elementName refers to an unknown global element declaration
      • schemaAttribute

        XSequenceType schemaAttribute(javax.xml.namespace.QName attributeName,
                                    XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches schema attributes.
        Parameters:
        attributeName - the name of the schema element declaration to match
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if attributeName or cardinality is null
        java.lang.IllegalArgumentException - if attributeName refers to an unknown global attribute declaration
      • processingInstruction

        XSequenceType processingInstruction(javax.xml.namespace.QName piNCName,
                                          XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches processing instructions.
        Parameters:
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
      • comment

        XSequenceType comment(XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches comments.
        Parameters:
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
      • text

        XSequenceType text(XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches text nodes.
        Parameters:
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
      • node

        XSequenceType node(XSequenceType.OccurrenceIndicator cardinality)
        Creates a sequence type that matches nodes..
        Parameters:
        cardinality - the cardinality of the sequence type
        Returns:
        an XSequenceType
        Throws:
        java.lang.NullPointerException - if cardinality is null
IBM WebSphere Application Server XML API JavadocTM
Release 9.0