org.apache.xerces.dom3.as
Interface ASContentModel

All Superinterfaces:
ASObject

public interface ASContentModel
extends ASObject

The content model of a declared element.

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


Field Summary
static short AS_ALL
          All of the above.
static short AS_CHOICE
          This constant value signifies a choice operator.
static short AS_NONE
          None of the above, i.e., neither a choice nor sequence operator.
static short AS_SEQUENCE
          This constant value signifies a sequence operator.
static int AS_UNBOUNDED
          Signifies unbounded upper limit.
 
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
 
Method Summary
 int appendsubModel(ASObject newNode)
          Appends a new node to the end of the list representing the subModels.
 short getListOperator()
          One of AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE.
 int getMaxOccurs()
          maximum occurrence for this content particle.
 int getMinOccurs()
          min occurrence for this content particle.
 ASObjectList getSubModels()
          Pointers to ASObjects such as ASElementDeclarations and further ASContentModels.
 void insertsubModel(ASObject newNode)
          Inserts a new node in the submodel.
 void removesubModel(ASObject oldNode)
          Removes the ASObject in the submodel.
 void setListOperator(short listOperator)
          One of AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE.
 void setMaxOccurs(int maxOccurs)
          maximum occurrence for this content particle.
 void setMinOccurs(int minOccurs)
          min occurrence for this content particle.
 void setSubModels(ASObjectList subModels)
          Pointers to ASObjects such as ASElementDeclarations and further ASContentModels.
 
Methods inherited from interface org.apache.xerces.dom3.as.ASObject
cloneASObject, getAsNodeType, getLocalName, getNamespaceURI, getNodeName, getOwnerASModel, getPrefix, setLocalName, setNamespaceURI, setNodeName, setOwnerASModel, setPrefix
 

Field Detail

AS_UNBOUNDED

public static final int AS_UNBOUNDED
Signifies unbounded upper limit. The MAX_VALUE value is 0xFFFFFFFF FFFFFFFF. This needs to be better defined in the generated bindings.

AS_SEQUENCE

public static final short AS_SEQUENCE
This constant value signifies a sequence operator. For example, in a DTD, this would be the ',' operator.

AS_CHOICE

public static final short AS_CHOICE
This constant value signifies a choice operator. For example, in a DTD, this would be the '|' operator.

AS_ALL

public static final short AS_ALL
All of the above.

AS_NONE

public static final short AS_NONE
None of the above, i.e., neither a choice nor sequence operator.
Method Detail

getListOperator

public short getListOperator()
One of AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE. The operator is applied to all the components(ASObjects) in the subModels. For example, if the list operator is AS_CHOICE and the components in subModels are a, b and c then the abstract schema for the element being declared is (a|b|c).

setListOperator

public void setListOperator(short listOperator)
One of AS_CHOICE, AS_SEQUENCE, AS_ALL or AS_NONE. The operator is applied to all the components(ASObjects) in the subModels. For example, if the list operator is AS_CHOICE and the components in subModels are a, b and c then the abstract schema for the element being declared is (a|b|c).

getMinOccurs

public int getMinOccurs()
min occurrence for this content particle. Its value may be 0 or a positive integer.

setMinOccurs

public void setMinOccurs(int minOccurs)
min occurrence for this content particle. Its value may be 0 or a positive integer.

getMaxOccurs

public int getMaxOccurs()
maximum occurrence for this content particle. Its value may be 0, a positive integer, or AS_UNBOUNDED to indicate that no upper limit has been set.

setMaxOccurs

public void setMaxOccurs(int maxOccurs)
maximum occurrence for this content particle. Its value may be 0, a positive integer, or AS_UNBOUNDED to indicate that no upper limit has been set.

getSubModels

public ASObjectList getSubModels()
Pointers to ASObjects such as ASElementDeclarations and further ASContentModels.

setSubModels

public void setSubModels(ASObjectList subModels)
Pointers to ASObjects such as ASElementDeclarations and further ASContentModels.

removesubModel

public void removesubModel(ASObject oldNode)
Removes the ASObject in the submodel. Nodes that already exist in the list are moved as needed.
Parameters:
oldNode - The node to be removed.

insertsubModel

public void insertsubModel(ASObject newNode)
                    throws DOMASException
Inserts a new node in the submodel. Nodes that already exist in the list are moved as needed.
Parameters:
newNode - The new node to be inserted.
Throws:
DOMASException - DUPLICATE_NAME_ERR: Raised if a element declaration already exists with the same name within an AS_CHOICE operator.

appendsubModel

public int appendsubModel(ASObject newNode)
                   throws DOMASException
Appends a new node to the end of the list representing the subModels.
Parameters:
newNode - The new node to be appended.
Returns:
the length of the subModels.
Throws:
DOMASException - DUPLICATE_NAME_ERR: Raised if a element declaration already exists with the same name within an AS_CHOICE operator.
TYPE_ERR: Raised if type is neither an ASContentModel nor an ASElementDeclaration .


Copyright © 1999-2002 Apache XML Project. All Rights Reserved.