xerces/xercesImpl/2.12.0 : org/apache/xerces/xni/XMLDTDContentModelHandler.java

XMLDTDContentModelHandler

https://xerces.apache.org/xerces2-j/: Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The Apache Software License, Version 2.0

Apache Software Foundation (Apache Software Foundation)

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.xni;

import org.apache.xerces.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
Version: $Id: XMLDTDContentModelHandler.java 447247 2006-09-18 05:23:52Z mrglavas $/**
 * 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 $
 */
public interface XMLDTDContentModelHandler {

    //
    // Constants
    //

    // separators

    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/** 
     * A choice separator for children and mixed content models. This
     * separator is used to specify that the allowed child is one of a
     * collection.
     * <p>
     * For example:
     * <pre>
     * &lt;!ELEMENT elem (foo|bar)&gt;
     * &lt;!ELEMENT elem (foo|bar+)&gt;
     * &lt;!ELEMENT elem (foo|bar|baz)&gt;
     * &lt;!ELEMENT elem (#PCDATA|foo|bar)*&gt;
     * </pre>
     *
     * @see #SEPARATOR_SEQUENCE
     */
    public static final short SEPARATOR_CHOICE = 0;

    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/**
     * A sequence separator for children content models. This separator 
     * is used to specify that the allowed children must follow in the
     * specified sequence.
     * <p>
     * <pre>
     * &lt;!ELEMENT elem (foo,bar)&gt;
     * &lt;!ELEMENT elem (foo,bar*)&gt;
     * &lt;!ELEMENT elem (foo,bar,baz)&gt;
     * </pre>
     *
     * @see #SEPARATOR_CHOICE
     */
    public static final short SEPARATOR_SEQUENCE = 1;

    // occurrence counts

    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/** 
     * 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.
     * <p>
     * For example:
     * <pre>
     * &lt;!ELEMENT elem (foo?)&gt;
     * </pre>
     *
     * @see #OCCURS_ZERO_OR_MORE
     * @see #OCCURS_ONE_OR_MORE
     */
    public static final short OCCURS_ZERO_OR_ONE = 2;

    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/** 
     * 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.
     * <p>
     * For example:
     * <pre>
     * &lt;!ELEMENT elem (foo*)&gt;
     * &lt;!ELEMENT elem (#PCDATA|foo|bar)*&gt;
     * </pre>
     *
     * @see #OCCURS_ZERO_OR_ONE
     * @see #OCCURS_ONE_OR_MORE
     */
    public static final short OCCURS_ZERO_OR_MORE = 3;

    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/** 
     * 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.
     * <p>
     * For example:
     * <pre>
     * &lt;!ELEMENT elem (foo+)&gt;
     * </pre>
     *
     * @see #OCCURS_ZERO_OR_ONE
     * @see #OCCURS_ZERO_OR_MORE
     */
    public static final short OCCURS_ONE_OR_MORE = 4;

    //
    // XMLDTDContentModelHandler methods
    //

    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.
Params: elementName – The name of the element.
augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error./**
     * 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 startContentModel(String elementName, Augmentations augmentations)
        throws XNIException;

    A content model of ANY. 
Params: augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error.
See Also: empty
startGroup/** 
     * 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 any(Augmentations augmentations) throws XNIException;

    A content model of EMPTY.
Params: augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error.
See Also: any
startGroup/**
     * 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 empty(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.
Params: augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error.
See Also: any
empty/**
     * A start of either a mixed or children content model. A mixed
     * content model will immediately be followed by a call to the
     * <code>pcdata()</code> 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
     */
    public void startGroup(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().
Params: augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error.
See Also: startGroup/**
     * The appearance of "#PCDATA" within a group signifying a
     * mixed content model. This method will be the first called
     * following the content model's <code>startGroup()</code>.
     *
     * @param augmentations Additional information that may include infoset
     *                      augmentations.
     *     
     * @throws XNIException Thrown by handler to signal an error.
     *
     * @see #startGroup
     */
    public void pcdata(Augmentations augmentations) throws XNIException;

    A referenced element in a mixed or children content model.
Params: elementName – The name of the referenced element.
augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error./**
     * 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 element(String elementName, Augmentations augmentations) 
        throws XNIException;

    The separator between choices or sequences of a mixed or children
content model.
Params: 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: SEPARATOR_CHOICE
SEPARATOR_SEQUENCE/**
     * 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 separator(short separator, Augmentations augmentations) 
        throws XNIException;

    The occurrence count for a child in a children content model or
for the mixed content model group.
Params: 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: OCCURS_ZERO_OR_ONE
OCCURS_ZERO_OR_MORE
OCCURS_ONE_OR_MORE/**
     * 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 occurrence(short occurrence, Augmentations augmentations) 
        throws XNIException;

    The end of a group for mixed or children content models.
Params: augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error./**
     * 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 void endGroup(Augmentations augmentations) throws XNIException;

    The end of a content model.
Params: augmentations – Additional information that may include infoset
                     augmentations.
Throws: XNIException – Thrown by handler to signal an error./**
     * 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 endContentModel(Augmentations augmentations) throws XNIException;

    // set content model source
    public void setDTDContentModelSource(XMLDTDContentModelSource source);

    // get content model source
    public XMLDTDContentModelSource getDTDContentModelSource();

} // interface XMLDTDContentModelHandler

Author:	Andy Clark, IBM
See Also:	XMLDTDHandler
Version:	$Id: XMLDTDContentModelHandler.java 447247 2006-09-18 05:23:52Z mrglavas $

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

Params:	augmentations – Additional information that may include infoset augmentations.
Throws:	XNIException – Thrown by handler to signal an error.
See Also:	empty startGroup

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

Params:	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:	SEPARATOR_CHOICE SEPARATOR_SEQUENCE

Params:	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:	OCCURS_ZERO_OR_ONE OCCURS_ZERO_OR_MORE OCCURS_ONE_OR_MORE

/

xerces/ xercesImpl/ 2.12.0/ org/apache/xerces/xni/XMLDTDContentModelHandler.java