Overview (Extensible Abstract Model (XAM))

Extensible Abstract Model (XAM)
Package	Description
org.netbeans.modules.xml.xam
org.netbeans.modules.xml.xam.dom
org.netbeans.modules.xml.xam.locator
org.netbeans.modules.xml.xam.spi

XAM (Extensible Abstract Model) was developed as part of an effort to create tools friendly schema model. This module was the extraction of useful patterns for undo/redo, simple write transactions (in this sense a transaction supports Isloation and Durability (to the extent possible) by allowing a single writer and deferring dispatching of events to the end of the transaction, lazy initialization, , inter/intra model references, and model creation. org.netbeans.modules.xml.xam Represents a domain independent model and associated artifacts such as a factory, source, and the concept of a reference. org.netbeans.modules.xml.xam.dom Provides entities for working on XML based models. This package depends on org.w3c packages and assumes a mapping between an xml tree and a strongly typed binding. This package also provides the ability to resolve other models A client will normally subclass the appropriate abstract model and component and thus have a starting point for a domain model (examples are the wsdl and schema models).

What is New (see all changes)?

Dec 11 '12 Method AbstractDocumentModel.prepareChangeInfo() is replaced with a new one.
Introduced DocumentComponent2 and DocumentModelAccess2 to provide additional method findEndPosition() to get the end position of the object representation in document. It's complimentary to existing findPosition
May 19 '10 Method AbstractDocumentModel.prepareChangeInfo() is replaced with a new one.
The modufication is necessary for fixing issue #166177. The old method AbstractDocumentModel.prepareChangeInfo(List) is marked as deprecated and a new one AbstractDocumentModel.prepareChangeInfo(List, List) is created. The new one contains additional parameter nsContextPathToRoot, which is necessary for correct calculation of namespace context after deletion of namespace prefix. See the issue for details.
Jul 30 '09 Two new methods to enhance model's performance
Two new methods are added:
- AbstractComponent.checkChildrenPopulated()
- AbstractComponent.getChildrenCount()
They are intended to be used instead of getChildren() in cases when the children's list isn't required. It helps impove performance.

Use Cases

domain model developer

A domain model developer would determine the appropriate extension package. A model outside of XML would extend org.netbeans.modules.xml.xam.AbstractModel, and have the components in the domain extend org.netbeans.modules.xml.xam.AbstractComponent. The org.netbeans.modules.xml.xam.AbstractFactory can also be used for creation of models. The factory provides the creational, the model provides the entry point into the domain model as well as a concrete reference point to register for events. The component serves as the root of the domain level objects. This provides some consistency across models as the original intention was to be able to provide a unified model across different XML vocabularies. An XML model developer would likely want to start using the XDM model which provides the full fidelty XML document model. This is in the xml/xdm module (described seperately). The XML module developer would also incorporate the facilities for reading and writing to a catalog. This is incorporated into methods available to subclasses in the xam.dom and xdm.xam models. The project based catalog facility provides the ability to support versioned catalog files which allow local access but URL based location attributes.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name

In/Out

Stability

Specified in What Document?

org.netbeans.modules.xml.xam

Exported

Under Development

Represents a domain independent model and associated artifacts such as a factory, source, and the concept of a reference.

org.netbeans.modules.xml.xam.dom

Exported

Under Development

Provides entities for working on XML based models. This package depends on org.w3c packages and assumes a mapping between an xml tree and a strongly typed binding. This package also provides the ability to resolve other models

Implementation Details

Where are the sources for the module?

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

This module was developed from the bottom up (the api is not yet stable) and thus a friend declaration is required before the module can be used.

Read more about the implementation in the answers to architecture questions.

Extensible Abstract Model (XAM)Under Development