public interface

XMLDTDContentModelHandler

org.apache.xerces.xni.XMLDTDContentModelHandler
Known Indirect Subclasses

Class Overview

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 Also

Summary

Constants
short OCCURS_ONE_OR_MORE This occurrence count limits the element, choice, or sequence in a children content model to one or more.
short OCCURS_ZERO_OR_MORE This occurrence count limits the element, choice, or sequence in a children content model to zero or more.
short OCCURS_ZERO_OR_ONE This occurrence count limits the element, choice, or sequence in a children content model to zero or one.
short SEPARATOR_CHOICE A choice separator for children and mixed content models.
short SEPARATOR_SEQUENCE A sequence separator for children content models.
Public Methods
abstract void any(Augmentations augmentations)
A content model of ANY.
abstract void element(String elementName, Augmentations augmentations)
A referenced element in a mixed or children content model.
abstract void empty(Augmentations augmentations)
A content model of EMPTY.
abstract void endContentModel(Augmentations augmentations)
The end of a content model.
abstract void endGroup(Augmentations augmentations)
The end of a group for mixed or children content models.
abstract XMLDTDContentModelSource getDTDContentModelSource()
abstract void occurrence(short occurrence, Augmentations augmentations)
The occurrence count for a child in a children content model or for the mixed content model group.
abstract void pcdata(Augmentations augmentations)
The appearance of "#PCDATA" within a group signifying a mixed content model.
abstract void separator(short separator, Augmentations augmentations)
The separator between choices or sequences of a mixed or children content model.
abstract void setDTDContentModelSource(XMLDTDContentModelSource source)
abstract void startContentModel(String elementName, Augmentations augmentations)
The start of a content model.
abstract void startGroup(Augmentations augmentations)
A start of either a mixed or children content model.

Constants

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+)>

See Also
Constant Value: 4 (0x00000004)

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)*>

See Also
Constant Value: 3 (0x00000003)

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?)>

See Also
Constant Value: 2 (0x00000002)

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)*>

See Also
Constant Value: 0 (0x00000000)

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)>

See Also
Constant Value: 1 (0x00000001)

Public Methods

public abstract void any (Augmentations augmentations)

A content model of ANY.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.
See Also

public abstract void element (String elementName, Augmentations augmentations)

A referenced element in a mixed or children content model.

Parameters
elementName The name of the referenced element.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.

public abstract void empty (Augmentations augmentations)

A content model of EMPTY.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.
See Also

public abstract void endContentModel (Augmentations augmentations)

The end of a content model.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.

public abstract void endGroup (Augmentations augmentations)

The end of a group for mixed or children content models.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.

public abstract XMLDTDContentModelSource getDTDContentModelSource ()

public abstract void occurrence (short occurrence, Augmentations augmentations)

The occurrence count for a child in a children content model or for the mixed content model group.

Parameters
occurrence The occurrence count for the last element or group.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.
See Also

public abstract 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().

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.
See Also

public abstract void separator (short separator, Augmentations augmentations)

The separator between choices or sequences of a mixed or children content model.

Parameters
separator The type of children separator.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.
See Also

public abstract void setDTDContentModelSource (XMLDTDContentModelSource source)

public abstract void startContentModel (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.

Parameters
elementName The name of the element.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.

public abstract 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.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException Thrown by handler to signal an error.
See Also