Class XSModelImpl

    • Constructor Detail

      • XSModelImpl

        public XSModelImpl​(SchemaGrammar[] grammars)
        Construct an XSModelImpl, by storing some grammars and grammars imported by them to this object.
        Parameters:
        grammars - the array of schema grammars
      • XSModelImpl

        public XSModelImpl​(SchemaGrammar[] grammars,
                           short s4sVersion)
    • Method Detail

      • getNamespaces

        public StringList getNamespaces()
        Convenience method. Returns a list of all namespaces that belong to this schema.
        Specified by:
        getNamespaces in interface XSModel
        Returns:
        A list of all namespaces that belong to this schema or null if all components don't have a targetNamespace.
      • getNamespaceItems

        public XSNamespaceItemList getNamespaceItems()
        A set of namespace schema information information items (of type XSNamespaceItem), one for each namespace name which appears as the target namespace of any schema component in the schema used for that assessment, and one for absent if any schema component in the schema had no target namespace. For more information see schema information.
        Specified by:
        getNamespaceItems in interface XSModel
      • getComponents

        public XSNamedMap getComponents​(short objectType)
        Returns a list of top-level components, i.e. element declarations, attribute declarations, etc.
        Specified by:
        getComponents in interface XSModel
        Parameters:
        objectType - The type of the declaration, i.e. ELEMENT_DECLARATION. Note that XSTypeDefinition.SIMPLE_TYPE and XSTypeDefinition.COMPLEX_TYPE can also be used as the objectType to retrieve only complex types or simple types, instead of all types.
        Returns:
        A list of top-level definitions of the specified type in objectType or an empty XSNamedMap if no such definitions exist.
      • getComponentsByNamespace

        public XSNamedMap getComponentsByNamespace​(short objectType,
                                                   String namespace)
        Convenience method. Returns a list of top-level component declarations that are defined within the specified namespace, i.e. element declarations, attribute declarations, etc.
        Specified by:
        getComponentsByNamespace in interface XSModel
        Parameters:
        objectType - The type of the declaration, i.e. ELEMENT_DECLARATION.
        namespace - The namespace to which the declaration belongs or null (for components with no target namespace).
        Returns:
        A list of top-level definitions of the specified type in objectType and defined in the specified namespace or an empty XSNamedMap.
      • getTypeDefinition

        public XSTypeDefinition getTypeDefinition​(String name,
                                                  String namespace)
        Convenience method. Returns a top-level simple or complex type definition.
        Specified by:
        getTypeDefinition in interface XSModel
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        Returns:
        An XSTypeDefinition or null if such definition does not exist.
      • getTypeDefinition

        public XSTypeDefinition getTypeDefinition​(String name,
                                                  String namespace,
                                                  String loc)
        Convenience method. Returns a top-level simple or complex type definition.
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        loc - The schema location where the component was defined
        Returns:
        An XSTypeDefinition or null if such definition does not exist.
      • getAttributeDeclaration

        public XSAttributeDeclaration getAttributeDeclaration​(String name,
                                                              String namespace)
        Convenience method. Returns a top-level attribute declaration.
        Specified by:
        getAttributeDeclaration in interface XSModel
        Parameters:
        name - The name of the declaration.
        namespace - The namespace of the definition, otherwise null.
        Returns:
        A top-level attribute declaration or null if such declaration does not exist.
      • getAttributeDeclaration

        public XSAttributeDeclaration getAttributeDeclaration​(String name,
                                                              String namespace,
                                                              String loc)
        Convenience method. Returns a top-level attribute declaration.
        Parameters:
        name - The name of the declaration.
        namespace - The namespace of the definition, otherwise null.
        loc - The schema location where the component was defined
        Returns:
        A top-level attribute declaration or null if such declaration does not exist.
      • getElementDeclaration

        public XSElementDeclaration getElementDeclaration​(String name,
                                                          String namespace)
        Convenience method. Returns a top-level element declaration.
        Specified by:
        getElementDeclaration in interface XSModel
        Parameters:
        name - The name of the declaration.
        namespace - The namespace of the definition, otherwise null.
        Returns:
        A top-level element declaration or null if such declaration does not exist.
      • getElementDeclaration

        public XSElementDeclaration getElementDeclaration​(String name,
                                                          String namespace,
                                                          String loc)
        Convenience method. Returns a top-level element declaration.
        Parameters:
        name - The name of the declaration.
        namespace - The namespace of the definition, otherwise null.
        loc - The schema location where the component was defined
        Returns:
        A top-level element declaration or null if such declaration does not exist.
      • getAttributeGroup

        public XSAttributeGroupDefinition getAttributeGroup​(String name,
                                                            String namespace)
        Convenience method. Returns a top-level attribute group definition.
        Specified by:
        getAttributeGroup in interface XSModel
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        Returns:
        A top-level attribute group definition or null if such definition does not exist.
      • getAttributeGroup

        public XSAttributeGroupDefinition getAttributeGroup​(String name,
                                                            String namespace,
                                                            String loc)
        Convenience method. Returns a top-level attribute group definition.
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        loc - The schema location where the component was defined
        Returns:
        A top-level attribute group definition or null if such definition does not exist.
      • getModelGroupDefinition

        public XSModelGroupDefinition getModelGroupDefinition​(String name,
                                                              String namespace)
        Convenience method. Returns a top-level model group definition.
        Specified by:
        getModelGroupDefinition in interface XSModel
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        Returns:
        A top-level model group definition definition or null if such definition does not exist.
      • getModelGroupDefinition

        public XSModelGroupDefinition getModelGroupDefinition​(String name,
                                                              String namespace,
                                                              String loc)
        Convenience method. Returns a top-level model group definition.
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        loc - The schema location where the component was defined
        Returns:
        A top-level model group definition definition or null if such definition does not exist.
      • getIDCDefinition

        public XSIDCDefinition getIDCDefinition​(String name,
                                                String namespace)
        Convenience method. Returns a top-level model group definition.
        Specified by:
        getIDCDefinition in interface XSModel
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        Returns:
        A top-level model group definition definition or null if such definition does not exist.
      • getIDCDefinition

        public XSIDCDefinition getIDCDefinition​(String name,
                                                String namespace,
                                                String loc)
        Convenience method. Returns a top-level model group definition.
        Parameters:
        name - The name of the definition.
        namespace - The namespace of the definition, otherwise null.
        loc - The schema location where the component was defined
        Returns:
        A top-level model group definition definition or null if such definition does not exist.
      • getAnnotations

        public XSObjectList getAnnotations()
        [annotations]: a set of annotations if it exists, otherwise an empty XSObjectList.
        Specified by:
        getAnnotations in interface XSModel
      • hasIDConstraints

        public boolean hasIDConstraints()
        REVISIT: to expose identity constraints from XSModel. For now, we only expose whether there are any IDCs. We also need to add these methods to the public XSModel interface.
      • getSubstitutionGroup

        public XSObjectList getSubstitutionGroup​(XSElementDeclaration head)
        Convenience method. Returns a list containing the members of the substitution group for the given XSElementDeclaration or an empty XSObjectList if the substitution group contains no members.
        Specified by:
        getSubstitutionGroup in interface XSModel
        Parameters:
        head - The substitution group head.
        Returns:
        A list containing the members of the substitution group for the given XSElementDeclaration or an empty XSObjectList if the substitution group contains no members.
      • getLength

        public int getLength()
        The number of XSNamespaceItems in the list. The range of valid child object indices is 0 to length-1 inclusive.
        Specified by:
        getLength in interface XSNamespaceItemList
      • item

        public XSNamespaceItem item​(int index)
        Returns the indexth item in the collection or null if index is greater than or equal to the number of objects in the list. The index starts at 0.
        Specified by:
        item in interface XSNamespaceItemList
        Parameters:
        index - index into the collection.
        Returns:
        The XSNamespaceItem at the indexth position in the XSNamespaceItemList, or null if the index specified is not valid.