public interface

DocumentAS

org.apache.xerces.dom3.as.DocumentAS

This interface is deprecated.
This interface extends the Document interface with additional methods for both document and AS editing.

See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load and Save Specification.

Summary

Public Methods
abstract void addAS(ASModel as)
Associate a ASModel with a document.
abstract ASModel getActiveASModel()
The active external ASModel.
abstract ASObjectList getBoundASModels()
A list of ASObjects of type AS_MODELs associated with a document.
abstract ASElementDeclaration getElementDeclaration()
Gets the AS editing object describing this elementThis method needs to be changed and others added.
abstract ASModel getInternalAS()
Retrieve the internal ASModel of a document.
abstract void removeAS(ASModel as)
Removes a ASModel associated with a document.
abstract void setActiveASModel(ASModel activeASModel)
The active external ASModel.
abstract void setBoundASModels(ASObjectList boundASModels)
A list of ASObjects of type AS_MODELs associated with a document.
abstract void setInternalAS(ASModel as)
Sets the internal subset ASModel of a document.
abstract void validate()
Validates the document against the ASModel.

Public Methods

public abstract void addAS (ASModel as)

Associate a ASModel with a document. Can be invoked multiple times to result in a list of ASModels. Note that only one internal ASModel is associated with the document, however, and that only one of the possible list of ASModels is active at any one time.

Parameters
as ASModel to be associated with the document.

public abstract ASModel getActiveASModel ()

The active external ASModel. Note that the active external ASModel is responsible for consulting the internal ASModel, so if an attribute is declared in the internal ASModel and the corresponding ownerElements points to a ASElementDeclarations defined in the active external ASModel, changing the active external ASModel will cause the ownerElements to be recomputed. If the ownerElements is not defined in the newly active external ASModel, the ownerElements will be an empty node list.

public abstract ASObjectList getBoundASModels ()

A list of ASObjects of type AS_MODELs associated with a document. The addAS method associates a ASModel with a document.

public abstract ASElementDeclaration getElementDeclaration ()

Gets the AS editing object describing this elementThis method needs to be changed and others added.

Returns
  • ASElementDeclaration object if the implementation supports " AS-EDIT" feature. Otherwise null.
Throws
DOMException NOT_FOUND_ERR: Raised if no ASModel is present.

public abstract ASModel getInternalAS ()

Retrieve the internal ASModel of a document.

Returns
  • ASModel.

public abstract void removeAS (ASModel as)

Removes a ASModel associated with a document. Can be invoked multiple times to remove a number of these in the list of ASModels.

Parameters
as The ASModel to be removed.

public abstract void setActiveASModel (ASModel activeASModel)

The active external ASModel. Note that the active external ASModel is responsible for consulting the internal ASModel, so if an attribute is declared in the internal ASModel and the corresponding ownerElements points to a ASElementDeclarations defined in the active external ASModel, changing the active external ASModel will cause the ownerElements to be recomputed. If the ownerElements is not defined in the newly active external ASModel, the ownerElements will be an empty node list.

public abstract void setBoundASModels (ASObjectList boundASModels)

A list of ASObjects of type AS_MODELs associated with a document. The addAS method associates a ASModel with a document.

public abstract void setInternalAS (ASModel as)

Sets the internal subset ASModel of a document. This could be null as a mechanism for "removal".

Parameters
as ASModel to be the internal subset of the document.

public abstract void validate ()

Validates the document against the ASModel.

Throws
DOMASException