File Doc Category Size Date Package
XMLDTDContentModelHandler.java API Doc Apache Xerces 3.0.1 9211 Fri Sep 14 20:33:52 BST 2007 org.apache.xerces.xni

XMLDTDContentModelHandler

public interface XMLDTDContentModelHandler

The DTD content model handler interface defines callback methods to report information items in DTD content models of an element declaration. Parser components interested in DTD content model information implement this interface and are registered as the DTD content model handler on the DTD content model source.

see: XMLDTDHandler
author: Andy Clark, IBM
version: $Id: XMLDTDContentModelHandler.java 447247 2006-09-18 05:23:52Z mrglavas $

Fields Summary
public static final short
SEPARATOR_CHOICE
A choice separator for children and mixed content models. This separator is used to specify that the allowed child is one of a collection.
For example:
<!ELEMENT elem (foo|bar)> <!ELEMENT elem (foo|bar+)> <!ELEMENT elem (foo|bar|baz)> <!ELEMENT elem (#PCDATA|foo|bar)*>
public static final short
SEPARATOR_SEQUENCE
A sequence separator for children content models. This separator is used to specify that the allowed children must follow in the specified sequence.

<!ELEMENT elem (foo,bar)> <!ELEMENT elem (foo,bar*)> <!ELEMENT elem (foo,bar,baz)>
public static final short
OCCURS_ZERO_OR_ONE
This occurrence count limits the element, choice, or sequence in a children content model to zero or one. In other words, the child is optional.
For example:
<!ELEMENT elem (foo?)>
public static final short
OCCURS_ZERO_OR_MORE
This occurrence count limits the element, choice, or sequence in a children content model to zero or more. In other words, the child may appear an arbitrary number of times, or not at all. This occurrence count is also used for mixed content models.
For example:
<!ELEMENT elem (foo*)> <!ELEMENT elem (#PCDATA|foo|bar)*>
public static final short
OCCURS_ONE_OR_MORE
This occurrence count limits the element, choice, or sequence in a children content model to one or more. In other words, the child may appear an arbitrary number of times, but must appear at least once.
For example:
<!ELEMENT elem (foo+)>
Constructors Summary
Methods Summary
public void any(Augmentations augmentations)
A content model of ANY.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
see
#empty
see
#startGroup
public void element(java.lang.String elementName, Augmentations augmentations)
A referenced element in a mixed or children content model.
param
elementName The name of the referenced element.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
public void empty(Augmentations augmentations)
A content model of EMPTY.
throws
XNIException Thrown by handler to signal an error.
param
augmentations Additional information that may include infoset augmentations.
see
#any
see
#startGroup
public void endContentModel(Augmentations augmentations)
The end of a content model.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
public void endGroup(Augmentations augmentations)
The end of a group for mixed or children content models.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
public org.apache.xerces.xni.parser.XMLDTDContentModelSource getDTDContentModelSource()
public void occurrence(short occurrence, Augmentations augmentations)
The occurrence count for a child in a children content model or for the mixed content model group.
param
occurrence The occurrence count for the last element or group.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
see
#OCCURS_ZERO_OR_ONE
see
#OCCURS_ZERO_OR_MORE
see
#OCCURS_ONE_OR_MORE
public void pcdata(Augmentations augmentations)
The appearance of "#PCDATA" within a group signifying a mixed content model. This method will be the first called following the content model's startGroup().
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
see
#startGroup
public void separator(short separator, Augmentations augmentations)
The separator between choices or sequences of a mixed or children content model.
param
separator The type of children separator.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
see
#SEPARATOR_CHOICE
see
#SEPARATOR_SEQUENCE
public void setDTDContentModelSource(org.apache.xerces.xni.parser.XMLDTDContentModelSource source)
public void startContentModel(java.lang.String elementName, Augmentations augmentations)
The start of a content model. Depending on the type of the content model, specific methods may be called between the call to the startContentModel method and the call to the endContentModel method.
param
elementName The name of the element.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
public void startGroup(Augmentations augmentations)
A start of either a mixed or children content model. A mixed content model will immediately be followed by a call to the pcdata() method. A children content model will contain additional groups and/or elements.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
see
#any
see
#empty