File Doc Category Size Date Package
ASModelImpl.java API Doc Apache Xerces 3.0.1 21254 Fri Sep 14 20:33:56 BST 2007 org.apache.xerces.dom

ASModelImpl

java.lang.Object

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.

deprecated
author: Pavani Mukthipudi
author: Neil Graham
version: $Id: ASModelImpl.java 447266 2006-09-18 05:57:49Z mrglavas $

Fields Summary
boolean
fNamespaceAware
protected Vector
fASModels
protected org.apache.xerces.impl.xs.SchemaGrammar
fGrammar
Constructors Summary
public ASModelImpl()
// // Constructors // fASModels = new Vector();
public ASModelImpl(boolean isNamespaceAware)
fASModels = new Vector(); fNamespaceAware = isNamespaceAware;
Methods Summary
public void addASModel(ASModel abstractSchema)
This method will allow the nesting or "importation" of ASModels.
param
abstractSchema ASModel to be set. Subsequent calls will nest the ASModels within the specified ownerASModel.
fASModels.addElement(abstractSchema);
public ASObject cloneASObject(boolean deep)
Creates a copy of this ASObject. See text for cloneNode off of Node but substitute AS functionality.
param
deep Setting the deep flag on, causes the whole subtree to be duplicated. Setting it to false only duplicates its immediate child nodes.
return
Cloned ASObject.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASAttributeDeclaration createASAttributeDeclaration(java.lang.String namespaceURI, java.lang.String name)
Creates an attribute declaration.
param
namespaceURI The namespace URI of the attribute being declared.
param
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.
return
A new ASAttributeDeclaration object with appropriate attributes set by input parameters.
exception
DOMException INVALID_CHARACTER_ERR: Raised if the input name parameter contains an illegal character.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASContentModel createASContentModel(int minOccurs, int maxOccurs, short operator)
Creates an object which describes part of an ASElementDeclaration's content model.
param
minOccurs The minimum occurrence for the subModels of this ASContentModel.
param
maxOccurs The maximum occurrence for the subModels of this ASContentModel.
param
operator operator of type AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE.
return
A new ASContentModel object.
exception
DOMASException A DOMASException, e.g., minOccurs > maxOccurs.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASElementDeclaration createASElementDeclaration(java.lang.String namespaceURI, java.lang.String name)
Creates an element declaration for the element type specified.
param
namespaceURI The namespace URI of the element type being declared.
param
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.
return
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.
exception
DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASEntityDeclaration createASEntityDeclaration(java.lang.String name)
Creates an ASEntityDeclaration.
param
name The name of the entity being declared.
return
A new ASEntityDeclaration object with entityName attribute set to name.
exception
DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASNotationDeclaration createASNotationDeclaration(java.lang.String namespaceURI, java.lang.String name, java.lang.String systemId, java.lang.String publicId)
Creates a new notation declaration.
param
namespaceURI The namespace URI of the notation being declared.
param
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.
param
systemId The system identifier for the notation declaration.
param
publicId The public identifier for the notation declaration.
return
A new ASNotationDeclaration object with notationName attribute set to name and publicId and systemId set to the corresponding fields.
exception
DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASObjectList getASModels()
To retrieve a list of nested ASModels without reference to names.
return
A list of ASModels.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public java.lang.String getAsHint()
The hint to locating an ASModel.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public java.lang.String getAsLocation()
The URI reference.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public short getAsNodeType()
A code representing the underlying object as defined above.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASNamedObjectMap getAttributeDeclarations()
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).
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public boolean getContainer()
If usage is EXTERNAL_SUBSET or NOT_USED, and the ASModel is simply a container of other ASModels.
return (fGrammar != null);
public ASNamedObjectMap getContentModelDeclarations()
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).
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASNamedObjectMap getElementDeclarations()
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).
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASNamedObjectMap getEntityDeclarations()
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).
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public org.apache.xerces.impl.xs.SchemaGrammar getGrammar()
return fGrammar;
public java.util.Vector getInternalASModels()
return fASModels;
public boolean getIsNamespaceAware()
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.
return fNamespaceAware;
public java.lang.String getLocalName()
Returns the local part of the qualified name of this ASObject.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public java.lang.String getNamespaceURI()
The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public java.lang.String getNodeName()
The name of this ASObject depending on the ASObject type.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASNamedObjectMap getNotationDeclarations()
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).
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public ASModel getOwnerASModel()
The ASModel object associated with this ASObject. For a node of type AS_MODEL, this is null.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public java.lang.String getPrefix()
The namespace prefix of this node, or null if it is unspecified.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public short getUsageLocation()
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.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void importASObject(ASObject asobject)
Imports ASObject into ASModel.
param
asobject ASObject to be imported.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void insertASObject(ASObject asobject)
Inserts ASObject into ASModel.
param
asobject ASObject to be inserted.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void removeAS(ASModel as)
Removes only the specified ASModel from the list of ASModels.
param
as AS to be removed.
fASModels.removeElement(as);
public void setAsHint(java.lang.String asHint)
The hint to locating an ASModel.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void setAsLocation(java.lang.String asLocation)
The URI reference.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void setGrammar(org.apache.xerces.impl.xs.SchemaGrammar grammar)
fGrammar = grammar;
public void setLocalName(java.lang.String localName)
Returns the local part of the qualified name of this ASObject.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void setNamespaceURI(java.lang.String namespaceURI)
The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void setNodeName(java.lang.String nodeName)
The name of this ASObject depending on the ASObject type.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void setOwnerASModel(ASModel ownerASModel)
The ASModel object associated with this ASObject. For a node of type AS_MODEL, this is null.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public void setPrefix(java.lang.String prefix)
The namespace prefix of this node, or null if it is unspecified.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);
public boolean validate()
Determines if an ASModel itself is valid, i.e., confirming that it's well-formed and valid per its own formal grammar.
return
true if the ASModel is valid, false otherwise.
String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NOT_SUPPORTED_ERR", null); throw new DOMException(DOMException.NOT_SUPPORTED_ERR, msg);