Package com.adobe.xfa.connectionset

Class ConnectionSetModel

  • All Implemented Interfaces:
    Element.DualDomNode, Peer
    public final class ConnectionSetModel
extends Model
    A class to model the collection of all XFA nodes that make up form connectionset.

    • Constructor Detail

      • ConnectionSetModel

        public ConnectionSetModel​(Element parent,
                          Node prevSibling)

    • Method Detail

      • connectionSetNS

        public static java.lang.String connectionSetNS()
        Namespace
        Returns:
        The connectionset namespace URI string

      • getConnectionSetModel

        public static ConnectionSetModel getConnectionSetModel​(AppModel appModel,
                                                       boolean bCreateIfNotFound)
        Gets the connectionset model held within an XFA DOM hierarchy.
        Parameters:
        appModel - the application model.
        bCreateIfNotFound - when set, create a model if necessary.
        Returns:
        the connectionset model or null if none found.

      • createNode

        public Node createNode​(int eTag,
                       Element parent,
                       java.lang.String aName,
                       java.lang.String aNS,
                       boolean bDoVersionCheck)
        Description copied from class: Model
        Create an element with the given tag, parent, name and uri.
        Specified by:
        createNode in class Model
        Parameters:
        eTag - the element's tag.
        parent - the element's parent.
        aName - the element's name.
        aNS - the element's namespace.
        bDoVersionCheck - check the element's version.
        Returns:
        a new element.
        See Also:
        Model.createNode(int, Element, String, String, boolean)

      • execute

        public boolean execute​(Element oConnectionNode,
                       boolean bDynamicMerge)
        Executes the given connection.

        Adobe patent application tracking # P624, entitled "Form-based Data Storage And Retrieval", inventors: Matveief,Young,Solc

      • execute

        public boolean execute​(java.lang.String sConnectionName,
                       boolean bDynamicMerge)
        Executes the given connection.

        Adobe patent application tracking # P624, entitled "Form-based Data Storage And Retrieval", inventors: Matveief,Young,Solc

        Parameters:
        sConnectionName - the name of the connection to execute.
        bDynamicMerge - do a full remerge, killing all that is in the data DOM.
        Returns:
        true if connection was executed, false otherwise.

      • getDataDescriptionName

        public java.lang.String getDataDescriptionName​(java.lang.String sConnectionName)
        Gets the name of the dataDescription property for the given connection.
        Parameters:
        sConnectionName - the name of the connection.
        Returns:
        name of the dataDescription.

      • getDefaultDataConnection

        public Node getDefaultDataConnection()
        Gets the default data connection, if any.
        Returns:
        The default data connection or null if not found.

      • getHeadNS

        public java.lang.String getHeadNS()
        Specified by:
        getHeadNS in class Model

      • getNamedConnection

        public Node getNamedConnection​(java.lang.String sConnectionName,
                               int eClass)

      • getNS

        public java.lang.String getNS()
        Description copied from class: Element
        Gets this element's namespace.
        Overrides:
        getNS in class Model
        Returns:
        the namespace URI.
        See Also:
        Element.getNS()

      • loadChildren

        public void loadChildren​(Node startNode,
                         Generator genTag)

      • publish

        public boolean publish​(Model.Publisher publisher)
        Description copied from class: Model
        Publish the model to an Application Storage facility. This involves updating all external references (such as image hrefs) such that they point to local collateral. The actual details of this are left up to the implementer of the class derived from Model.Publisher specified in the oPublisher parameter. What publish() itself does is recursively traverse the tree structure of the model. When an external reference is encountered (for example, the href attribute of an image node), the updateExternalRef() method is called. The node, attribute identifier and original value of the external reference are passed to updateExternalRef(). The derived class should copy the collateral to the application storage area (if desired), and should update the value of sExternalRefValue to indicate the new value for the external reference (probably some sort of relative path). If an external reference stored as an element value (for example, a uri node) is encountered, updateExternalRef is called with node and the eAttribute arg is set to XFA.TEXTNODETAG. Two or more instances of an identical external reference result in only one call to updateExternalRef(), because returned values are cached and reused. If called on the AppModel, this method recursively calls publish on all contained models.
        Overrides:
        publish in class Model
        Parameters:
        publisher - an instance of a class derived from TemplateModel.Publisher.