| java.lang.Object
 org.apache.xerces.dom.ASModelImpl
| ASModelImpl | | public class ASModelImpl implements ASModel(Code) | | 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.
author:
Pavani Mukthipudi
author:
Neil Graham
version:
$Id: ASModelImpl.java 447266 2006-09-18 05:57:49Z mrglavas $ |
| Method Summary | |
| public void | addASModel(ASModel abstractSchema)
This method will allow the nesting or "importation" of ASModels. | | public ASObject | cloneASObject(boolean deep)
Creates a copy of this ASObject. | | public ASAttributeDeclaration | createASAttributeDeclaration(String namespaceURI, String name)
Creates an attribute declaration.
Parameters:
namespaceURI - The namespace URI of the attribute being declared.
Parameters:
name - The name of the attribute. | | public ASContentModel | createASContentModel(int minOccurs, int maxOccurs, short operator)
Creates an object which describes part of an
ASElementDeclaration's content model. | | public ASElementDeclaration | createASElementDeclaration(String namespaceURI, String name)
Creates an element declaration for the element type specified.
Parameters:
namespaceURI - The namespace URI of the element type being declared. | | public ASEntityDeclaration | createASEntityDeclaration(String name)
Creates an ASEntityDeclaration. | | public ASNotationDeclaration | createASNotationDeclaration(String namespaceURI, String name, String systemId, String publicId)
Creates a new notation declaration. | | public ASObjectList | getASModels()
To retrieve a list of nested ASModels without reference to names. | | public String | getAsHint()
The hint to locating an ASModel. | | public String | getAsLocation()
The URI reference. | | public short | getAsNodeType()
A code representing the underlying object as defined above. | | public ASNamedObjectMap | getAttributeDeclarations()
Instead of returning an all-in-one ASObject with
ASModel methods, have discernible top-level/"global"
attribute declarations. | | public boolean | getContainer()
If usage is EXTERNAL_SUBSET or NOT_USED, and the
ASModel is simply a container of other ASModels. | | public ASNamedObjectMap | getContentModelDeclarations()
Instead of returning an all-in-one ASObject with
ASModel methods, have discernible top-level/"global
content model declarations. | | public ASNamedObjectMap | getElementDeclarations()
Instead of returning an all-in-one ASObject with
ASModel methods, have discernible top-level/"global"
element declarations. | | public ASNamedObjectMap | getEntityDeclarations()
Instead of returning an all-in-one ASObject with
ASModel methods, have discernible top-level/"global"
entity declarations. | | public SchemaGrammar | getGrammar()
| | public Vector | getInternalASModels()
| | 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. | | public String | getLocalName()
Returns the local part of the qualified name of this
ASObject. | | public String | getNamespaceURI()
The namespace URI of this node, or null if it is
unspecified. | | public String | getNodeName()
The name of this ASObject depending on the
ASObject type. | | public ASNamedObjectMap | getNotationDeclarations()
Instead of returning an all-in-one ASObject with
ASModel methods, have discernible top-level/"global"
notation declarations. | | public ASModel | getOwnerASModel()
The ASModel object associated with this
ASObject. | | public String | getPrefix()
The namespace prefix of this node, or null if it is
unspecified. | | public short | getUsageLocation()
0 if used internally, 1 if used externally, 2 if not all. | | public void | importASObject(ASObject asobject)
Imports ASObject into ASModel. | | public void | insertASObject(ASObject asobject)
Inserts ASObject into ASModel. | | public void | removeAS(ASModel as)
Removes only the specified ASModel from the list of
ASModels. | | public void | setAsHint(String asHint)
The hint to locating an ASModel. | | public void | setAsLocation(String asLocation)
The URI reference. | | public void | setGrammar(SchemaGrammar grammar)
| | public void | setLocalName(String localName)
Returns the local part of the qualified name of this
ASObject. | | public void | setNamespaceURI(String namespaceURI)
The namespace URI of this node, or null if it is
unspecified. | | public void | setNodeName(String nodeName)
The name of this ASObject depending on the
ASObject type. | | public void | setOwnerASModel(ASModel ownerASModel)
The ASModel object associated with this
ASObject. | | public void | setPrefix(String prefix)
The namespace prefix of this node, or null if it is
unspecified. | | 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. |
| fNamespaceAware | | boolean fNamespaceAware(Code) | | |
| ASModelImpl | | public ASModelImpl()(Code) | | |
| ASModelImpl | | public ASModelImpl(boolean isNamespaceAware)(Code) | | |
| addASModel | | public void addASModel(ASModel abstractSchema)(Code) | | This method will allow the nesting or "importation" of ASModels.
Parameters:
abstractSchema - ASModel to be set. Subsequent calls will nest the ASModels within the specified ownerASModel. |
| cloneASObject | | public ASObject cloneASObject(boolean deep)(Code) | | Creates a copy of this ASObject. See text for
cloneNode off of Node but substitute AS
functionality.
Parameters:
deep - Setting the deep flag on, causes the whole subtree to be duplicated. Setting it to false only duplicates its immediate child nodes. Cloned ASObject. |
| createASAttributeDeclaration | | public ASAttributeDeclaration createASAttributeDeclaration(String namespaceURI, String name) throws DOMException(Code) | | Creates an attribute declaration.
Parameters:
namespaceURI - The namespace URI of the attribute being declared.
Parameters:
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. 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. |
| createASContentModel | | public ASContentModel createASContentModel(int minOccurs, int maxOccurs, short operator) throws DOMASException(Code) | | Creates an object which describes part of an
ASElementDeclaration's content model.
Parameters:
minOccurs - The minimum occurrence for the subModels of this ASContentModel.
Parameters:
maxOccurs - The maximum occurrence for the subModels of this ASContentModel.
Parameters:
operator - operator of type AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE. A new ASContentModel object.
exception:
DOMASException - A DOMASException, e.g., minOccurs > maxOccurs. |
| createASElementDeclaration | | public ASElementDeclaration createASElementDeclaration(String namespaceURI, String name) throws DOMException(Code) | | Creates an element declaration for the element type specified.
Parameters:
namespaceURI - The namespace URI of the element type being declared.
Parameters:
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. 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. |
| createASEntityDeclaration | | public ASEntityDeclaration createASEntityDeclaration(String name) throws DOMException(Code) | | Creates an ASEntityDeclaration.
Parameters:
name - The name of the entity being declared. A new ASEntityDeclaration object with entityName attribute set to name.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character. |
| createASNotationDeclaration | | public ASNotationDeclaration createASNotationDeclaration(String namespaceURI, String name, String systemId, String publicId) throws DOMException(Code) | | Creates a new notation declaration.
Parameters:
namespaceURI - The namespace URI of the notation being declared.
Parameters:
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.
Parameters:
systemId - The system identifier for the notation declaration.
Parameters:
publicId - The public identifier for the notation declaration. 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. |
| getASModels | | public ASObjectList getASModels()(Code) | | To retrieve a list of nested ASModels without reference to names.
A list of ASModels. |
| getAsHint | | public String getAsHint()(Code) | | The hint to locating an ASModel.
|
| getAsLocation | | public String getAsLocation()(Code) | | The URI reference.
|
| getAsNodeType | | public short getAsNodeType()(Code) | | A code representing the underlying object as defined above.
|
| getAttributeDeclarations | | public ASNamedObjectMap getAttributeDeclarations()(Code) | | 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).
|
| getContainer | | public boolean getContainer()(Code) | | If usage is EXTERNAL_SUBSET or NOT_USED, and the
ASModel is simply a container of other ASModels.
|
| getContentModelDeclarations | | public ASNamedObjectMap getContentModelDeclarations()(Code) | | 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).
|
| getElementDeclarations | | public ASNamedObjectMap getElementDeclarations()(Code) | | 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).
|
| getEntityDeclarations | | public ASNamedObjectMap getEntityDeclarations()(Code) | | 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).
|
| getInternalASModels | | public Vector getInternalASModels()(Code) | | |
| getIsNamespaceAware | | public boolean getIsNamespaceAware()(Code) | | 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.
|
| getLocalName | | public String getLocalName()(Code) | | Returns the local part of the qualified name of this
ASObject.
|
| getNamespaceURI | | public String getNamespaceURI()(Code) | | The namespace URI of this node, or null if it is
unspecified. defines how a namespace URI is attached to schema
components.
|
| getNodeName | | public String getNodeName()(Code) | | The name of this ASObject depending on the
ASObject type.
|
| getNotationDeclarations | | public ASNamedObjectMap getNotationDeclarations()(Code) | | 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).
|
| getOwnerASModel | | public ASModel getOwnerASModel()(Code) | | The ASModel object associated with this
ASObject. For a node of type AS_MODEL, this
is null.
|
| getPrefix | | public String getPrefix()(Code) | | The namespace prefix of this node, or null if it is
unspecified.
|
| getUsageLocation | | public short getUsageLocation()(Code) | | 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.
|
| importASObject | | public void importASObject(ASObject asobject)(Code) | | Imports ASObject into ASModel.
Parameters:
asobject - ASObject to be imported. |
| insertASObject | | public void insertASObject(ASObject asobject)(Code) | | Inserts ASObject into ASModel.
Parameters:
asobject - ASObject to be inserted. |
| removeAS | | public void removeAS(ASModel as)(Code) | | Removes only the specified ASModel from the list of
ASModels.
Parameters:
as - AS to be removed. |
| setAsHint | | public void setAsHint(String asHint)(Code) | | The hint to locating an ASModel.
|
| setAsLocation | | public void setAsLocation(String asLocation)(Code) | | The URI reference.
|
| setLocalName | | public void setLocalName(String localName)(Code) | | Returns the local part of the qualified name of this
ASObject.
|
| setNamespaceURI | | public void setNamespaceURI(String namespaceURI)(Code) | | The namespace URI of this node, or null if it is
unspecified. defines how a namespace URI is attached to schema
components.
|
| setNodeName | | public void setNodeName(String nodeName)(Code) | | The name of this ASObject depending on the
ASObject type.
|
| setOwnerASModel | | public void setOwnerASModel(ASModel ownerASModel)(Code) | | The ASModel object associated with this
ASObject. For a node of type AS_MODEL, this
is null.
|
| setPrefix | | public void setPrefix(String prefix)(Code) | | The namespace prefix of this node, or null if it is
unspecified.
|
| validate | | public boolean validate()(Code) | | Determines if an ASModel itself is valid, i.e., confirming
that it's well-formed and valid per its own formal grammar.
true if the ASModel is valid, false otherwise. |
|
|