org.apache.xerces.dom

Class ASModelImpl

java.lang.Object

org.apache.xerces.dom.ASModelImpl

All Implemented Interfaces:

ASModel, ASObject

Deprecated.

public class ASModelImpl
extends Object
implements ASModel

To begin with, an abstract schema is a generic structure that could contain both internal and external subsets. An ASModel is an abstract object that could map to a DTD , an XML Schema , a database schema, etc. An ASModel could represent either an internal or an external subset; hence an abstract schema could be composed of an ASModel representing the internal subset and an ASModel representing the external subset. Note that the ASModel representing the external subset could consult the ASModel representing the internal subset. Furthermore, the ASModel representing the internal subset could be set to null by the setInternalAS method as a mechanism for "removal". In addition, only one ASModel representing the external subset can be specified as "active" and it is possible that none are "active". Finally, the ASModel contains the factory methods needed to create a various types of ASObjects like ASElementDeclaration, ASAttributeDeclaration, etc.

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

Version:

$Id$

Author:

Pavani Mukthipudi, Neil Graham

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector	fASModels Deprecated.
protected SchemaGrammar	fGrammar Deprecated.

Fields inherited from interface org.apache.xerces.dom3.as.ASObject

AS_ATTRIBUTE_DECLARATION, AS_CONTENTMODEL, AS_ELEMENT_DECLARATION, AS_ENTITY_DECLARATION, AS_MODEL, AS_NOTATION_DECLARATION

Constructor Summary

Constructors

Constructor and Description
ASModelImpl() Deprecated.
ASModelImpl(boolean isNamespaceAware) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addASModel(ASModel abstractSchema) Deprecated. This method will allow the nesting or "importation" of ASModels.
ASObject	cloneASObject(boolean deep) Deprecated. Creates a copy of this ASObject.
ASAttributeDeclaration	createASAttributeDeclaration(String namespaceURI, String name) Deprecated. Creates an attribute declaration.
ASContentModel	createASContentModel(int minOccurs, int maxOccurs, short operator) Deprecated. Creates an object which describes part of an ASElementDeclaration's content model.
ASElementDeclaration	createASElementDeclaration(String namespaceURI, String name) Deprecated. Creates an element declaration for the element type specified.
ASEntityDeclaration	createASEntityDeclaration(String name) Deprecated. Creates an ASEntityDeclaration.
ASNotationDeclaration	createASNotationDeclaration(String namespaceURI, String name, String systemId, String publicId) Deprecated. Creates a new notation declaration.
String	getAsHint() Deprecated. The hint to locating an ASModel.
String	getAsLocation() Deprecated. The URI reference.
ASObjectList	getASModels() Deprecated. To retrieve a list of nested ASModels without reference to names.
short	getAsNodeType() Deprecated. A code representing the underlying object as defined above.
ASNamedObjectMap	getAttributeDeclarations() Deprecated. Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" attribute declarations.
boolean	getContainer() Deprecated. If usage is EXTERNAL_SUBSET or NOT_USED, and the ASModel is simply a container of other ASModels.
ASNamedObjectMap	getContentModelDeclarations() Deprecated. Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global content model declarations.
ASNamedObjectMap	getElementDeclarations() Deprecated. Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" element declarations.
ASNamedObjectMap	getEntityDeclarations() Deprecated. Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" entity declarations.
SchemaGrammar	getGrammar() Deprecated.
Vector	getInternalASModels() Deprecated.
boolean	getIsNamespaceAware() Deprecated. true if this ASModel defines the document structure in terms of namespaces and local names ; false if the document structure is defined only in terms of QNames.
String	getLocalName() Deprecated. Returns the local part of the qualified name of this ASObject.
String	getNamespaceURI() Deprecated. The namespace URI of this node, or null if it is unspecified.
String	getNodeName() Deprecated. The name of this ASObject depending on the ASObject type.
ASNamedObjectMap	getNotationDeclarations() Deprecated. Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" notation declarations.
ASModel	getOwnerASModel() Deprecated. The ASModel object associated with this ASObject.
String	getPrefix() Deprecated. The namespace prefix of this node, or null if it is unspecified.
short	getUsageLocation() Deprecated. 0 if used internally, 1 if used externally, 2 if not all.
void	importASObject(ASObject asobject) Deprecated. Imports ASObject into ASModel.
void	insertASObject(ASObject asobject) Deprecated. Inserts ASObject into ASModel.
void	removeAS(ASModel as) Deprecated. Removes only the specified ASModel from the list of ASModels.
void	setAsHint(String asHint) Deprecated. The hint to locating an ASModel.
void	setAsLocation(String asLocation) Deprecated. The URI reference.
void	setGrammar(SchemaGrammar grammar) Deprecated.
void	setLocalName(String localName) Deprecated. Returns the local part of the qualified name of this ASObject.
void	setNamespaceURI(String namespaceURI) Deprecated. The namespace URI of this node, or null if it is unspecified.
void	setNodeName(String nodeName) Deprecated. The name of this ASObject depending on the ASObject type.
void	setOwnerASModel(ASModel ownerASModel) Deprecated. The ASModel object associated with this ASObject.
void	setPrefix(String prefix) Deprecated. The namespace prefix of this node, or null if it is unspecified.
boolean	validate() Deprecated. Determines if an ASModel itself is valid, i.e., confirming that it's well-formed and valid per its own formal grammar.

Methods inherited from class java.lang.Object

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

Field Detail

fASModels

protected Vector fASModels

Deprecated.

fGrammar

protected SchemaGrammar fGrammar

Deprecated.

Constructor Detail

ASModelImpl

public ASModelImpl()

Deprecated.

ASModelImpl

public ASModelImpl(boolean isNamespaceAware)

Deprecated.

Method Detail

getAsNodeType

public short getAsNodeType()

Deprecated.

A code representing the underlying object as defined above.

Specified by:

getAsNodeType in interface ASObject

getOwnerASModel

public ASModel getOwnerASModel()

Deprecated.

The ASModel object associated with this ASObject. For a node of type AS_MODEL, this is null.

Specified by:

getOwnerASModel in interface ASObject

setOwnerASModel

public void setOwnerASModel(ASModel ownerASModel)

Deprecated.

The ASModel object associated with this ASObject. For a node of type AS_MODEL, this is null.

Specified by:

setOwnerASModel in interface ASObject

getNodeName

public String getNodeName()

Deprecated.

The name of this ASObject depending on the ASObject type.

Specified by:

getNodeName in interface ASObject

setNodeName

public void setNodeName(String nodeName)

Deprecated.

The name of this ASObject depending on the ASObject type.

Specified by:

setNodeName in interface ASObject

getPrefix

public String getPrefix()

Deprecated.

The namespace prefix of this node, or null if it is unspecified.

Specified by:

getPrefix in interface ASObject

setPrefix

public void setPrefix(String prefix)

Deprecated.

The namespace prefix of this node, or null if it is unspecified.

Specified by:

setPrefix in interface ASObject

getLocalName

public String getLocalName()

Deprecated.

Returns the local part of the qualified name of this ASObject.

Specified by:

getLocalName in interface ASObject

setLocalName

public void setLocalName(String localName)

Deprecated.

Returns the local part of the qualified name of this ASObject.

Specified by:

setLocalName in interface ASObject

getNamespaceURI

public String getNamespaceURI()

Deprecated.

The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.

Specified by:

getNamespaceURI in interface ASObject

setNamespaceURI

public void setNamespaceURI(String namespaceURI)

Deprecated.

The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.

Specified by:

setNamespaceURI in interface ASObject

cloneASObject

public ASObject cloneASObject(boolean deep)

Deprecated.

Creates a copy of this ASObject. See text for cloneNode off of Node but substitute AS functionality.

Specified by:

cloneASObject in interface ASObject

Parameters:

deep - Setting the deep flag on, causes the whole subtree to be duplicated. Setting it to false only duplicates its immediate child nodes.

Returns:

Cloned ASObject.

getIsNamespaceAware

public boolean getIsNamespaceAware()

Deprecated.

true if this ASModel defines the document structure in terms of namespaces and local names ; false if the document structure is defined only in terms of QNames.

Specified by:

getIsNamespaceAware in interface ASModel

getUsageLocation

public short getUsageLocation()

Deprecated.

0 if used internally, 1 if used externally, 2 if not all. An exception will be raised if it is incompatibly shared or in use as an internal subset.

Specified by:

getUsageLocation in interface ASModel

getAsLocation

public String getAsLocation()

Deprecated.

The URI reference.

Specified by:

getAsLocation in interface ASModel

setAsLocation

public void setAsLocation(String asLocation)

Deprecated.

The URI reference.

Specified by:

setAsLocation in interface ASModel

getAsHint

public String getAsHint()

Deprecated.

The hint to locating an ASModel.

Specified by:

getAsHint in interface ASModel

setAsHint

public void setAsHint(String asHint)

Deprecated.

The hint to locating an ASModel.

Specified by:

setAsHint in interface ASModel

getContainer

public boolean getContainer()

Deprecated.

If usage is EXTERNAL_SUBSET or NOT_USED, and the ASModel is simply a container of other ASModels.

getElementDeclarations

public ASNamedObjectMap getElementDeclarations()

Deprecated.

Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" element declarations. If one attempts to add, set, or remove a node type other than the intended one, a hierarchy exception (or equivalent is thrown).

Specified by:

getElementDeclarations in interface ASModel

getAttributeDeclarations

public ASNamedObjectMap getAttributeDeclarations()

Deprecated.

Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" attribute declarations. If one attempts to add, set, or remove a node type other than the intended one, a hierarchy exception (or equivalent is thrown).

Specified by:

getAttributeDeclarations in interface ASModel

getNotationDeclarations

public ASNamedObjectMap getNotationDeclarations()

Deprecated.

Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" notation declarations. If one attempts to add, set, or remove a node type other than the intended one, a hierarchy exception (or equivalent is thrown).

Specified by:

getNotationDeclarations in interface ASModel

getEntityDeclarations

public ASNamedObjectMap getEntityDeclarations()

Deprecated.

Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global" entity declarations. If one attempts to add, set, or remove a node type other than the intended one, a hierarchy exception (or equivalent is thrown).

Specified by:

getEntityDeclarations in interface ASModel

getContentModelDeclarations

public ASNamedObjectMap getContentModelDeclarations()

Deprecated.

Instead of returning an all-in-one ASObject with ASModel methods, have discernible top-level/"global content model declarations. If one attempts to add, set, or remove a node type other than the intended one, a hierarchy exception (or equivalent is thrown).

Specified by:

getContentModelDeclarations in interface ASModel

addASModel

public void addASModel(ASModel abstractSchema)

Deprecated.

This method will allow the nesting or "importation" of ASModels.

Specified by:

addASModel in interface ASModel

Parameters:

abstractSchema - ASModel to be set. Subsequent calls will nest the ASModels within the specified ownerASModel.

getASModels

public ASObjectList getASModels()

Deprecated.

To retrieve a list of nested ASModels without reference to names.

Specified by:

getASModels in interface ASModel

Returns:

A list of ASModels.

removeAS

public void removeAS(ASModel as)

Deprecated.

Removes only the specified ASModel from the list of ASModels.

Specified by:

removeAS in interface ASModel

Parameters:

as - AS to be removed.

validate

public boolean validate()

Deprecated.

Determines if an ASModel itself is valid, i.e., confirming that it's well-formed and valid per its own formal grammar.

Specified by:

validate in interface ASModel

Returns:

true if the ASModel is valid, false otherwise.

importASObject

public void importASObject(ASObject asobject)

Deprecated.

Imports ASObject into ASModel.

Parameters:

asobject - ASObject to be imported.

insertASObject

public void insertASObject(ASObject asobject)

Deprecated.

Inserts ASObject into ASModel.

Parameters:

asobject - ASObject to be inserted.

createASElementDeclaration

public ASElementDeclaration createASElementDeclaration(String namespaceURI,
                                                       String name)
                                                throws DOMException

Deprecated.

Creates an element declaration for the element type specified.

Specified by:

createASElementDeclaration in interface ASModel

Parameters:

namespaceURI - The namespace URI of the element type being declared.

name - The name of the element. The format of the name could be an NCName as defined by XML Namespaces or a Name as defined by XML 1.0; it's ASModel-dependent.

Returns:

A new ASElementDeclaration object with name attribute set to tagname and namespaceURI set to systemId. Other attributes of the element declaration are set through ASElementDeclaration interface methods.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createASAttributeDeclaration

public ASAttributeDeclaration createASAttributeDeclaration(String namespaceURI,
                                                           String name)
                                                    throws DOMException

Deprecated.

Creates an attribute declaration.

Specified by:

createASAttributeDeclaration in interface ASModel

Parameters:

namespaceURI - The namespace URI of the attribute being declared.

name - The name of the attribute. The format of the name could be an NCName as defined by XML Namespaces or a Name as defined by XML 1.0; it's ASModel-dependent.

Returns:

A new ASAttributeDeclaration object with appropriate attributes set by input parameters.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the input name parameter contains an illegal character.

createASNotationDeclaration

public ASNotationDeclaration createASNotationDeclaration(String namespaceURI,
                                                         String name,
                                                         String systemId,
                                                         String publicId)
                                                  throws DOMException

Deprecated.

Creates a new notation declaration.

Specified by:

createASNotationDeclaration in interface ASModel

Parameters:

namespaceURI - The namespace URI of the notation being declared.

name - The name of the notation. The format of the name could be an NCName as defined by XML Namespaces or a Name as defined by XML 1.0; it's ASModel-dependent.

systemId - The system identifier for the notation declaration.

publicId - The public identifier for the notation declaration.

Returns:

A new ASNotationDeclaration object with notationName attribute set to name and publicId and systemId set to the corresponding fields.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createASEntityDeclaration

public ASEntityDeclaration createASEntityDeclaration(String name)
                                              throws DOMException

Deprecated.

Creates an ASEntityDeclaration.

Specified by:

createASEntityDeclaration in interface ASModel

Parameters:

name - The name of the entity being declared.

Returns:

A new ASEntityDeclaration object with entityName attribute set to name.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

createASContentModel

public ASContentModel createASContentModel(int minOccurs,
                                           int maxOccurs,
                                           short operator)
                                    throws DOMASException

Deprecated.

Creates an object which describes part of an ASElementDeclaration's content model.

Specified by:

createASContentModel in interface ASModel

Parameters:

minOccurs - The minimum occurrence for the subModels of this ASContentModel.

maxOccurs - The maximum occurrence for the subModels of this ASContentModel.

operator - operator of type AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE.

Returns:

A new ASContentModel object.

Throws:

DOMASException - A DOMASException, e.g., minOccurs > maxOccurs.

getGrammar

public SchemaGrammar getGrammar()

Deprecated.

setGrammar

public void setGrammar(SchemaGrammar grammar)

Deprecated.

getInternalASModels

public Vector getInternalASModels()

Deprecated.