Interface SchemaIndex

  • All Known Implementing Classes:
    SchemaIndexImpl

    public interface SchemaIndex
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void destroy()
      Cleans up the index before desctruction.
      XSDAttributeDeclaration getAttributeDeclaration​(QName qName)
      Returns the attribute declaration with the specified qualified name.
      XSDAttributeGroupDefinition getAttributeGroupDefinition​(QName qName)
      Returns the attribute group definition with the specified qualified name.
      List getAttributes​(XSDElementDeclaration element)
      Returns the attributes of a specified elements.
      XSDElementDeclaration getChildElement​(XSDElementDeclaration parent, QName childName)
      Returns a child element specified by name of a parent element.
      List<XSDParticle> getChildElementParticles​(XSDElementDeclaration parent)
      Returns a list of the particles which correspond to child element declarations.
      XSDComplexTypeDefinition getComplexTypeDefinition​(QName qName)
      Returns the complex type definition with the specified qualified name.
      XSDElementDeclaration getElementDeclaration​(QName qName)
      Returns the element declaration with the specified qualified name.
      XSDSchema[] getSchemas()  
      XSDSimpleTypeDefinition getSimpleTypeDefinition​(QName qName)
      Returns the simple type definition with the specified qualified name.
      XSDTypeDefinition getTypeDefinition​(QName qName)
      Returns the type definition with the specified qualified name.
    • Method Detail

      • getSchemas

        XSDSchema[] getSchemas()
        Returns:
        The schema itself.
      • getElementDeclaration

        XSDElementDeclaration getElementDeclaration​(QName qName)
        Returns the element declaration with the specified qualified name.
        Parameters:
        qName - the qualified name of the element.
        Returns:
        The element declaration, or null if no such element declaration exists.
      • getAttributeDeclaration

        XSDAttributeDeclaration getAttributeDeclaration​(QName qName)
        Returns the attribute declaration with the specified qualified name.
        Parameters:
        qName - the qualified name of the attribute.
        Returns:
        The attribute declaration, or null if no such attribute declaration exists.
      • getAttributeGroupDefinition

        XSDAttributeGroupDefinition getAttributeGroupDefinition​(QName qName)
        Returns the attribute group definition with the specified qualified name.
        Parameters:
        qName - the qualified name of the attribute group.
        Returns:
        The attribute group definition, or null if no such attribute group definition exists.
      • getComplexTypeDefinition

        XSDComplexTypeDefinition getComplexTypeDefinition​(QName qName)
        Returns the complex type definition with the specified qualified name.
        Parameters:
        qName - qualified name of the complex type.
        Returns:
        The complex type definition, or null if no such complex type definition exists.
      • getSimpleTypeDefinition

        XSDSimpleTypeDefinition getSimpleTypeDefinition​(QName qName)
        Returns the simple type definition with the specified qualified name.
        Parameters:
        qName - qualified name of the simple type.
        Returns:
        The simple type definition, or null if no such simple type definition exists.
      • getTypeDefinition

        XSDTypeDefinition getTypeDefinition​(QName qName)
        Returns the type definition with the specified qualified name.
        Parameters:
        qName - qualified name of the type.
        Returns:
        The type definition, or null if no such type definition exists.
      • getChildElement

        XSDElementDeclaration getChildElement​(XSDElementDeclaration parent,
                                              QName childName)
        Returns a child element specified by name of a parent element.
        Parameters:
        parent - The parent element.
        childName - The name of the child.
        Returns:
        The element declaration, or null if no such child exists.
      • getChildElementParticles

        List<XSDParticle> getChildElementParticles​(XSDElementDeclaration parent)
        Returns a list of the particles which correspond to child element declarations.
        Parameters:
        parent - The parent element.
        Returns:
        A list of XSDParticle.
      • getAttributes

        List getAttributes​(XSDElementDeclaration element)
        Returns the attributes of a specified elements.
        Parameters:
        element - The element.
        Returns:
        The list of attributed definied for the element.
      • destroy

        void destroy()
        Cleans up the index before desctruction.