com.adobe.xfa.connectionset

Class ConnectionSetModel

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.Node

com.adobe.xfa.Element

com.adobe.xfa.Model

com.adobe.xfa.connectionset.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.

Nested Class Summary

Nested classes/interfaces inherited from class com.adobe.xfa.Model

Model.DualDomModel, Model.Publisher

Nested classes/interfaces inherited from class com.adobe.xfa.Element

Element.DualDomNode, Element.ReplaceContent

Nested classes/interfaces inherited from class com.adobe.xfa.Node

Node.ChangeLogger

Field Summary

Fields inherited from class com.adobe.xfa.Element

AttrIsDefault, AttrIsFragment, AttrIsTransient, CREATEACTION

Fields inherited from class com.adobe.xfa.Node

CREATE_ALWAYS_NEW, CREATE_IF_NOT_EXIST, CREATE_MUST_NOT_EXIST, CREATE_REPLACE, gsXFANamespacePrefix

Fields inherited from interface com.adobe.xfa.ut.Peer

ATTR_CHANGED, CHILD_ADDED, CHILD_REMOVED, DESCENDENT_ADDED, DESCENDENT_ATTR_CHANGED, DESCENDENT_REMOVED, DESCENDENT_VALUE_CHANGED, PARENT_CHANGED, PERMS_LOCK_CLEARED, PERMS_LOCK_SET, PROTO_ATTR_CHANGED, PROTO_CHILD_ADDED, PROTO_CHILD_REMOVED, PROTO_DESCENDENT_ADDED, PROTO_DESCENDENT_ATTR_CHANGED, PROTO_DESCENDENT_REMOVED, PROTO_DESCENDENT_VALUE_CHANGED, PROTO_VALUE_CHANGED, UPDATED, VALUE_CHANGED

Constructor Summary

Constructors

Constructor and Description
ConnectionSetModel(Element parent, Node prevSibling)

Method Summary

Modifier and Type	Method and Description
static String	connectionSetNS() Namespace
Node	createNode(int eTag, Element parent, String aName, String aNS, boolean bDoVersionCheck) Create an element with the given tag, parent, name and uri.
Node	doLoadNode(Node parent, Node node, Generator genTag)
boolean	execute(Element oConnectionNode, boolean bDynamicMerge) Executes the given connection.
boolean	execute(String sConnectionName, boolean bDynamicMerge) Executes the given connection.
String	getBaseNS()
static ConnectionSetModel	getConnectionSetModel(AppModel appModel, boolean bCreateIfNotFound) Gets the connectionset model held within an XFA DOM hierarchy.
String	getDataDescriptionName(String sConnectionName) Gets the name of the dataDescription property for the given connection.
Node	getDefaultDataConnection() Gets the default data connection, if any.
String	getHeadNS()
int	getHeadVersion()
Node	getNamedConnection(String sConnectionName, int eClass)
String	getNS() Gets this element's namespace.
void	loadChildren(Node startNode, Generator genTag)
void	loadNode(Node parent, Node node, Generator genTag)
boolean	publish(Model.Publisher publisher) Publish the model to an Application Storage facility.
void	registerProxy(ConnectionSetProxy oProxy)

Methods inherited from class com.adobe.xfa.Model

addErrorList, addUseHRefNode, addUseNode, addXMLLoadErrorContext, allowUpdates, checkforCompatibleNS, clearErrorList, clone, createElement, createElement, createElement, createElement, createElement, createTextNode, createTextNode, doAttributeCleanup, getAliasNode, getAppModel, getAppModelIsTransient, getCachedLocale, getContext, getCurrentVersion, getDelta, getDeltas, getDocument, getErrorContextList, getErrorList, getEventManager, getGenerator, getIDValueMap, getLegacySetting, getLogMessenger, getName, getNeedsNSNormalize, getNode, getOriginalVersion, getOriginalVersionNode, getOriginalXFAVersion, getProtoList, getSchema, getScriptTable, getSourceBelow, getVersion, getXmlPeer, isCompatibleNS, isContainer, isLoading, isVersionCompatible, loadNode, loadRootAttributes, loadSpecialAttribute, loadSpecialNode, modelCleanup, nodeCleanup, normalizeNameSpaces, normalizeNameSpaces, normalizeNameSpaces, preLoadNode, preSave, ready, remapTag, remove, removeLastError, removeReferences, resolveNodes, resolveProtos, serialize, setAliasNode, setAppModel, setAppModelIsTransient, setContext, setCurrentVersion, setDOMProperties, setIDValueMap, setName, setNeedsNSNormalize, setOriginalXFAVersion, setXmlPeer, shortCutName, validateUsage, validateUsageFailedIsFatal, willDirtyDoc, willDirtyDoc

Methods inherited from class com.adobe.xfa.Element

appendChild, appendChild, appendPI, appendPI, assignNode, clone, connectPeerToDocument, constructKey, constructKeys, copyContent, defaultAttribute, defaultElement, defaultElement, establishID, evaluate, explodeQName, findAttr, findSchemaAttr, foundBadAttribute, foundBadAttribute, getAll, getAtom, getAttr, getAttribute, getAttribute, getAttributeByName, getAttrIndex, getAttrName, getAttrNS, getAttrProp, getAttrQName, getAttrVal, getChildReln, getClassAll, getClassIndex, getClassName, getDeltas, getElement, getElement, getElementClass, getElementLocal, getEnum, getEnum, getEventTable, getFirstXFAChild, getFirstXMLChild, getID, getIndex, getInheritedNS, getInstalledLocale, getIsNull, getLastXMLChild, getLineNumber, getLocalName, getModel, getNode, getNodes, getNodeSchema, getNumAttrs, getOneOfChild, getOneOfChild, getPI, getPI, getPrefix, getProperty, getProperty, getSaveXMLSaveTransient, getSchemaType, getScriptMethodInfo, getSibling, getText, getXFAChild, getXMLChild, getXMLName, getXPath, getXsiNilAttribute, inhibitPrettyPrint, inhibitPrettyPrint, insertChild, isFragment, isHidden, isHidden, isIndexed, isInstalledLocaleAmbient, isLeaf, isNameSpaceAttr, isPropertySpecified, isPropertySpecified, isPropertyValid, isSpecified, isSpecified, isSpecified, isTransient, isTransparent, isValidAttr, isValidChild, isValidElement, loadXML, loadXML, makeDefault, makeNonDefault, newAttribute, optimizeNameSpace, peekAttribute, peekElement, peekOneOfChild, peekProperty, peekProperty, postSave, privateSetName, processTextChildrenDuringParse, removeAttr, removeAttr, removeChild, removePI, removePI, removeWhiteSpace, removeXsiNilAttribute, replaceChild, resetPostLoadXML, resolveAndEnumerateChildren, resolveNodeCreate, resolvePrefix, saveFilteredXML, saveXML, saveXML, setAttribute, setAttribute, setAttribute, setAttribute, setAttrProp, setDefaultFlag, setElement, setIsDataWindowRoot, setIsIndexed, setLineNumber, setLocalName, setModel, setNS, setOneOfChild, setProperty, setProperty, setQName, setSaveXMLSaveTransient, setTransparent, setXMLName, setXsiNilAttribute, updateFromPeer

Methods inherited from class com.adobe.xfa.Node

checkAncestorPerms, checkDescendentPerms, checkPerms, cleanDirtyFlags, compareVersions, getData, getFirstXMLChildElement, getLocked, getNextXFASibling, getNextXMLSibling, getNextXMLSiblingElement, getNodeAsXML, getOwnerDocument, getPIAsXML, getPIName, getPreviousXMLSibling, getPrivateName, getPropName, getSOMExpression, getSOMExpression, getSomName, getUniqueSOMName, getWillDirty, getXFAChildCount, getXFAParent, getXfaPeer, getXMLChildCount, getXMLParent, hasChanged, isDefault, isDirty, isMapped, isPermsLockSet, isTransient, locateChildByClass, locateChildByName, logValueChangeHelper, notifyPeers, performSOMAssignment, resolveNode, resolveNode, resolveNode, resolveNodes, sendMessenge, setDirty, setDocument, setLocked, setMapped, setPermsLock, setPrivateName, setWillDirty, setXfaPeer, unLock, validateSchema

Methods inherited from class com.adobe.xfa.Obj

addPeer, addPeeredNode, clearPeers, deafen, getClassAtom, getClassTag, getPeer, getScriptProperty, getScriptThis, invokeFunction, isDeaf, isMute, isSameClass, isSameClass, isSameClass, mute, peerRemoved, removePeer, removePeeredNode, setClass, setClassTag, setScriptProperty, unDeafen, unMute

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionSetModel

public ConnectionSetModel(Element parent,
                          Node prevSibling)

Method Detail

connectionSetNS

public static 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,
                       String aName,
                       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)

doLoadNode

public Node doLoadNode(Node parent,
                       Node node,
                       Generator genTag)

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(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.

getBaseNS

public String getBaseNS()

Specified by:

getBaseNS in class Model

See Also:

Model.getBaseNS()

getDataDescriptionName

public String getDataDescriptionName(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 String getHeadNS()

Specified by:

getHeadNS in class Model

getHeadVersion

public int getHeadVersion()

Overrides:

getHeadVersion in class Model

getNamedConnection

public Node getNamedConnection(String sConnectionName,
                               int eClass)

getNS

public 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)

loadNode

public void loadNode(Node parent,
                     Node node,
                     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.

registerProxy

public void registerProxy(ConnectionSetProxy oProxy)