|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.dom.ASModelImpl
public class ASModelImpl
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.
Field Summary |
---|
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 | |
---|---|
ASModelImpl()
Deprecated. |
|
ASModelImpl(boolean isNamespaceAware)
Deprecated. |
Method Summary | |
---|---|
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(java.lang.String namespaceURI,
java.lang.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(java.lang.String namespaceURI,
java.lang.String name)
Deprecated. Creates an element declaration for the element type specified. |
ASEntityDeclaration |
createASEntityDeclaration(java.lang.String name)
Deprecated. Creates an ASEntityDeclaration. |
ASNotationDeclaration |
createASNotationDeclaration(java.lang.String namespaceURI,
java.lang.String name,
java.lang.String systemId,
java.lang.String publicId)
Deprecated. Creates a new notation declaration. |
java.lang.String |
getAsHint()
Deprecated. The hint to locating an ASModel. |
java.lang.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. |
java.util.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 . |
java.lang.String |
getLocalName()
Deprecated. Returns the local part of the qualified name of this ASObject . |
java.lang.String |
getNamespaceURI()
Deprecated. The namespace URI of this node, or null if it is
unspecified. |
java.lang.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 . |
java.lang.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
ASModel s. |
void |
setAsHint(java.lang.String asHint)
Deprecated. The hint to locating an ASModel. |
void |
setAsLocation(java.lang.String asLocation)
Deprecated. The URI reference. |
void |
setGrammar(SchemaGrammar grammar)
Deprecated. |
void |
setLocalName(java.lang.String localName)
Deprecated. Returns the local part of the qualified name of this ASObject . |
void |
setNamespaceURI(java.lang.String namespaceURI)
Deprecated. The namespace URI of this node, or null if it is
unspecified. |
void |
setNodeName(java.lang.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(java.lang.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 |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ASModelImpl()
public ASModelImpl(boolean isNamespaceAware)
Method Detail |
---|
public short getAsNodeType()
getAsNodeType
in interface ASObject
public ASModel getOwnerASModel()
ASModel
object associated with this
ASObject
. For a node of type AS_MODEL
, this
is null
.
getOwnerASModel
in interface ASObject
public void setOwnerASModel(ASModel ownerASModel)
ASModel
object associated with this
ASObject
. For a node of type AS_MODEL
, this
is null
.
setOwnerASModel
in interface ASObject
public java.lang.String getNodeName()
name
of this ASObject
depending on the
ASObject
type.
getNodeName
in interface ASObject
public void setNodeName(java.lang.String nodeName)
name
of this ASObject
depending on the
ASObject
type.
setNodeName
in interface ASObject
public java.lang.String getPrefix()
null
if it is
unspecified.
getPrefix
in interface ASObject
public void setPrefix(java.lang.String prefix)
null
if it is
unspecified.
setPrefix
in interface ASObject
public java.lang.String getLocalName()
ASObject
.
getLocalName
in interface ASObject
public void setLocalName(java.lang.String localName)
ASObject
.
setLocalName
in interface ASObject
public java.lang.String getNamespaceURI()
null
if it is
unspecified. defines how a namespace URI is attached to schema
components.
getNamespaceURI
in interface ASObject
public void setNamespaceURI(java.lang.String namespaceURI)
null
if it is
unspecified. defines how a namespace URI is attached to schema
components.
setNamespaceURI
in interface ASObject
public ASObject cloneASObject(boolean deep)
ASObject
. See text for
cloneNode
off of Node
but substitute AS
functionality.
cloneASObject
in interface ASObject
deep
- Setting the deep
flag on, causes the whole
subtree to be duplicated. Setting it to false
only
duplicates its immediate child nodes.
ASObject
.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
.
getIsNamespaceAware
in interface ASModel
public short getUsageLocation()
getUsageLocation
in interface ASModel
public java.lang.String getAsLocation()
getAsLocation
in interface ASModel
public void setAsLocation(java.lang.String asLocation)
setAsLocation
in interface ASModel
public java.lang.String getAsHint()
getAsHint
in interface ASModel
public void setAsHint(java.lang.String asHint)
setAsHint
in interface ASModel
public boolean getContainer()
usage
is EXTERNAL_SUBSET or NOT_USED, and the
ASModel
is simply a container of other ASModels.
public ASNamedObjectMap getElementDeclarations()
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).
getElementDeclarations
in interface ASModel
public ASNamedObjectMap getAttributeDeclarations()
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).
getAttributeDeclarations
in interface ASModel
public ASNamedObjectMap getNotationDeclarations()
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).
getNotationDeclarations
in interface ASModel
public ASNamedObjectMap getEntityDeclarations()
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).
getEntityDeclarations
in interface ASModel
public ASNamedObjectMap getContentModelDeclarations()
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).
getContentModelDeclarations
in interface ASModel
public void addASModel(ASModel abstractSchema)
addASModel
in interface ASModel
abstractSchema
- ASModel to be set. Subsequent calls will nest
the ASModels within the specified ownerASModel
.public ASObjectList getASModels()
getASModels
in interface ASModel
public void removeAS(ASModel as)
ASModel
from the list of
ASModel
s.
removeAS
in interface ASModel
as
- AS to be removed.public boolean validate()
ASModel
itself is valid, i.e., confirming
that it's well-formed and valid per its own formal grammar.
validate
in interface ASModel
true
if the ASModel
is valid,
false
otherwise.public void importASObject(ASObject asobject)
ASObject
into ASModel.
asobject
- ASObject
to be imported.public void insertASObject(ASObject asobject)
ASObject
into ASModel.
asobject
- ASObject
to be inserted.public ASElementDeclaration createASElementDeclaration(java.lang.String namespaceURI, java.lang.String name) throws DOMException
createASElementDeclaration
in interface ASModel
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.
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.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.public ASAttributeDeclaration createASAttributeDeclaration(java.lang.String namespaceURI, java.lang.String name) throws DOMException
createASAttributeDeclaration
in interface ASModel
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.
ASAttributeDeclaration
object with
appropriate attributes set by input parameters.
DOMException
- INVALID_CHARACTER_ERR: Raised if the input name
parameter contains an illegal character.public ASNotationDeclaration createASNotationDeclaration(java.lang.String namespaceURI, java.lang.String name, java.lang.String systemId, java.lang.String publicId) throws DOMException
createASNotationDeclaration
in interface ASModel
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.
ASNotationDeclaration
object with
notationName
attribute set to name
and
publicId
and systemId
set to the
corresponding fields.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.public ASEntityDeclaration createASEntityDeclaration(java.lang.String name) throws DOMException
createASEntityDeclaration
in interface ASModel
name
- The name of the entity being declared.
ASEntityDeclaration
object with
entityName
attribute set to name.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.public ASContentModel createASContentModel(int minOccurs, int maxOccurs, short operator) throws DOMASException
ASElementDeclaration
's content model.
createASContentModel
in interface ASModel
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
.
ASContentModel
object.
DOMASException
- A DOMASException, e.g., minOccurs > maxOccurs
.public SchemaGrammar getGrammar()
public void setGrammar(SchemaGrammar grammar)
public java.util.Vector getInternalASModels()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |