Top Description Fields Methods
com.sun.org.apache.xerces.internal.xni

public Interface XMLDTDContentModelHandler

Known Direct Subinterfaces
com.sun.org.apache.xerces.internal.xni.parser.XMLDTDContentModelFilter
Known Direct Implementers
com.sun.org.apache.xerces.internal.impl.dtd.DTDGrammar, com.sun.org.apache.xerces.internal.impl.xs.opti.DefaultXMLDocumentHandler, com.sun.org.apache.xerces.internal.parsers.AbstractXMLDocumentParser, com.sun.org.apache.xerces.internal.parsers.DOMParserImpl.AbortHandler, com.sun.org.apache.xerces.internal.parsers.DTDParser
Imports
com.sun.org.apache.xerces.internal.xni.parser.XMLDTDContentModelSource
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.
Author
Andy Clark, IBM
See Also
XMLDTDHandler

Field Summary

Modifier and TypeField and Description
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.

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.

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.

public static final short
SEPARATOR_CHOICE

A choice separator for children and mixed content models.

public static final short
SEPARATOR_SEQUENCE

A sequence separator for children content models.

Method Summary

Modifier and TypeMethod and Description
public void
any(Augmentations
Additional information that may include infoset augmentations.
augmentations)

A content model of ANY.

public void
element(String
The name of the referenced element.
elementName, Augmentations
Additional information that may include infoset augmentations.
augmentations)

A referenced element in a mixed or children content model.

public void
empty(Augmentations
Additional information that may include infoset augmentations.
augmentations)

A content model of EMPTY.

public void
endContentModel(Augmentations
Additional information that may include infoset augmentations.
augmentations)

The end of a content model.

public void
endGroup(Augmentations
Additional information that may include infoset augmentations.
augmentations)

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

public XMLDTDContentModelSource
getDTDContentModelSource()

public void
occurrence(short
The occurrence count for the last element or group.
occurrence, Augmentations
Additional information that may include infoset augmentations.
augmentations)

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

public void
pcdata(Augmentations
Additional information that may include infoset augmentations.
augmentations)

The appearance of "#PCDATA" within a group signifying a mixed content model.

public void
separator(short
The type of children separator.
separator, Augmentations
Additional information that may include infoset augmentations.
augmentations)

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

public void
setDTDContentModelSource(XMLDTDContentModelSource source)

public void
startContentModel(String
The name of the element.
elementName, Augmentations
Additional information that may include infoset augmentations.
augmentations)

The start of a content model.

public void
startGroup(Augmentations
Additional information that may include infoset augmentations.
augmentations)

A start of either a mixed or children content model.

Field Detail

OCCURS_ONE_OR_MOREback to summary
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
OCCURS_ZERO_OR_ONE, OCCURS_ZERO_OR_MORE
OCCURS_ZERO_OR_MOREback to summary
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
OCCURS_ZERO_OR_ONE, OCCURS_ONE_OR_MORE
OCCURS_ZERO_OR_ONEback to summary
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
OCCURS_ZERO_OR_MORE, OCCURS_ONE_OR_MORE
SEPARATOR_CHOICEback to 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)*>
See Also
SEPARATOR_SEQUENCE
SEPARATOR_SEQUENCEback to summary
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
SEPARATOR_CHOICE

Method Detail

anyback to summary
public void any(Augmentations augmentations) throws XNIException

A content model of ANY.

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
See Also
empty, startGroup
elementback to summary
public void element(String elementName, Augmentations augmentations) throws XNIException

A referenced element in a mixed or children content model.

Parameters
elementName:String

The name of the referenced element.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
emptyback to summary
public void empty(Augmentations augmentations) throws XNIException

A content model of EMPTY.

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
See Also
any, startGroup
endContentModelback to summary
public void endContentModel(Augmentations augmentations) throws XNIException

The end of a content model.

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
endGroupback to summary
public void endGroup(Augmentations augmentations) throws XNIException

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

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
getDTDContentModelSourceback to summary
public XMLDTDContentModelSource getDTDContentModelSource()
occurrenceback to summary
public void occurrence(short occurrence, Augmentations augmentations) throws XNIException

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

Parameters
occurrence:short

The occurrence count for the last element or group.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
See Also
OCCURS_ZERO_OR_ONE, OCCURS_ZERO_OR_MORE, OCCURS_ONE_OR_MORE
pcdataback to summary
public void pcdata(Augmentations augmentations) throws XNIException

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:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
See Also
startGroup
separatorback to summary
public void separator(short separator, Augmentations augmentations) throws XNIException

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

Parameters
separator:short

The type of children separator.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
See Also
SEPARATOR_CHOICE, SEPARATOR_SEQUENCE
setDTDContentModelSourceback to summary
public void setDTDContentModelSource(XMLDTDContentModelSource source)
startContentModelback to summary
public void startContentModel(String elementName, Augmentations augmentations) throws XNIException

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:String

The name of the element.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
startGroupback to summary
public void startGroup(Augmentations augmentations) throws XNIException

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:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
See Also
any, empty