Package ro.sync.exml.workspace.api.editor.page.text

Class WSTextXMLSchemaManager

  • @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class WSTextXMLSchemaManager
extends java.lang.Object
    Text page XML schema manager. Provides support for obtaining information about what elements, attributes can be inserted in a given context.
    Since:
    12.1

    • Constructor Detail

      • WSTextXMLSchemaManager

        public WSTextXMLSchemaManager()

    • Method Detail

      • createWhatElementsCanGoHereContext

        public abstract WhatElementsCanGoHereContext createWhatElementsCanGoHereContext​(int offset)
                                                                         throws javax.swing.text.BadLocationException
        Create an element context for the given offset.
        Parameters:
        offset - Offset in document for which to create an element context.
        Returns:
        The element context. Null value will be returned if node at given offset is not an element.
        Throws:
        javax.swing.text.BadLocationException - When the offset is below zero or greater than the content.

      • createWhatPossibleValuesHasAttributeContext

        public abstract WhatPossibleValuesHasAttributeContext createWhatPossibleValuesHasAttributeContext​(int offset)
        Create an attribute values context for the given element and attribute name.
        Parameters:
        offset - The offset of the attribute name on the element whose attribute values interest us.
        Returns:
        An attribute values context.

      • whatAttributesCanGoHere

        public abstract java.util.List<CIAttribute> whatAttributesCanGoHere​(WhatAttributesCanGoHereContext whatAttributesCanGoHereContext)
        Examines the grammar and decides what attributes can be inserted in the parent element, after the list of attributes names.
        Parameters:
        whatAttributesCanGoHereContext - the context for the call. It must have:
        • elementName the name of the element in which will be done the insertion.
        • proxyNamespaceMapping the proxy - uri mappings defined before the insertion point.
        • previousAttributesNames the names of the existing attributes in the element, attributes that are before the insertion point.
        Returns:
        a list of attributes or null if there is none. Null value is also returned when schema is not specified.

      • whatElementsCanGoHere

        public abstract java.util.List<CIElement> whatElementsCanGoHere​(WhatElementsCanGoHereContext whatElementsCanGoHereContext)
        Examines the grammar and decides what elements can be inserted in the parent element, after the list of child names.
        Parameters:
        whatElementsCanGoHereContext - the context for the call. It must have:
        • parentElementName the qName of the parent element
        • previousElementNames the list of qNames of the previous elements
        • previousElementNamespaces the list of qNames of the previous elements
        • proxyNamespaceMapping the proxy - uri mappings defined before the insertion point.
        Returns:
        a list of CIElement representing the elements, or null if there is none. Null value is also returned when schema is not specified.

      • whatPossibleValuesHasAttribute

        public abstract java.util.List<CIValue> whatPossibleValuesHasAttribute​(WhatPossibleValuesHasAttributeContext ctxt)
        Queries the possible values of an element attribute. If the attribute type was an enumeration, then a list with the tokens of the enumeration will be returned.
        Parameters:
        ctxt - The context WhatPossiBleValuesHasAttributeContext.
        Returns:
        the list of CIValue representing possible values of the attribute or null if they are not known. Null value is also returned when schema is not specified.

      • whatPossibleValuesHasElement

        public abstract java.util.List<CIValue> whatPossibleValuesHasElement​(WhatElementsCanGoHereContext ctxt)
        Queries the possible values of an element. If the element type was an enumeration, then a list with the tokens of the enumeration will be returned.
        Parameters:
        ctxt - The context.
        Returns:
        a list of attribute values as CIValue or null if there is none or no schema is specified. The list of values can contain duplicates.

      • getGrammarURLs

        public abstract java.net.URL[] getGrammarURLs()
        Get the array of URLs of the loaded DTD or XML Schema. These URLs were set using one of the update methods, and includes the URLs that were collected from the calls of the update(InputSource[]) methods.
        Returns:
        The URLs of the schemas loaded, or null if there was nothing loaded.

      • getAttributeDescription

        public abstract CIAttribute getAttributeDescription​(WhatPossibleValuesHasAttributeContext ctxt)
        Get the description of an attribute. This model must be human readable.
        Parameters:
        ctxt - the context describing the target attribute.
        Returns:
        a hash describing the model of the element.

      • getEntities

        public abstract java.util.List<NameValue> getEntities()
        Gets the context-independent list of entities declared in the document's DOCTYPE declaration.

        If the DOCTYPE declaration is not changed, the document should not be processed each time this method is called.

        Returns:
        a list of name value representing the entities, or null if there is none. The reference of the list is changed on update.

      • getElementDescription

        public abstract CIElement getElementDescription​(Context ctxt)
        Get the description of an element. This model must be human readable.
        Parameters:
        ctxt - the context describing the target element. It contains:
        • The element names stack, having at top the current element name.
        • The element namespaces stack, having at top the current element namespace.
        Returns:
        a description the model of the element, or null.

      • isElementDescriptionSupported

        public abstract boolean isElementDescriptionSupported()
        If true the element description(model) support is available, otherwise not.
        Returns:
        True if element description is supported by the SM.

      • getChildrenElements

        public abstract java.util.List<CIElement> getChildrenElements​(WhatElementsCanGoHereContext context)
        Get the elements that can be children of the element for which the context was built.
        Parameters:
        context - The element context.
        Returns:
        A list with CIElements that are allowed as children.

      • isLearnSchema

        public abstract boolean isLearnSchema()
        Returns:
        Return true if schema was learned by Oxygen from the structure of the document.

      • hasLoadingErrors

        public abstract boolean hasLoadingErrors()
        Returns:
        Return true if there were errors when loading schema document(missing, not wellformed, not valid schema).

      • getGlobalElements

        public abstract java.util.List<CIElement> getGlobalElements()
        Get all the names of global elements defined in the associated grammar.
        Returns:
        A list of CIElements.
        Since:
        11.2