Class DTDSubset

  • All Implemented Interfaces:
    org.codehaus.stax2.validation.DTDValidationSchema, org.codehaus.stax2.validation.XMLValidationSchema
    Direct Known Subclasses:
    DTDSubsetImpl

    public abstract class DTDSubset
    extends java.lang.Object
    implements org.codehaus.stax2.validation.DTDValidationSchema
    This is the abstract base class that implements the standard Stax2 validation schema base class (XMLValidationSchema, as well as specifies extended Woodstox-specific interface for accessing DTD-specific things like entity expansions and notation properties.

    API is separated from its implementation to reduce coupling; for example, it is possible to have DTD subset implementations that do not implement validation logics, just entity expansion.

    • Constructor Detail

      • DTDSubset

        protected DTDSubset()
    • Method Detail

      • combineWithExternalSubset

        public abstract DTDSubset combineWithExternalSubset​(InputProblemReporter rep,
                                                            DTDSubset extSubset)
                                                     throws javax.xml.stream.XMLStreamException
        Method that will combine definitions from this internal subset with definitions from passed-in external subset, producing a new combined DTDSubset instance.
        Throws:
        javax.xml.stream.XMLStreamException
      • createValidator

        public abstract org.codehaus.stax2.validation.XMLValidator createValidator​(org.codehaus.stax2.validation.ValidationContext ctxt)
                                                                            throws javax.xml.stream.XMLStreamException
        Specified by:
        createValidator in interface org.codehaus.stax2.validation.XMLValidationSchema
        Throws:
        javax.xml.stream.XMLStreamException
      • getSchemaType

        public java.lang.String getSchemaType()
        Specified by:
        getSchemaType in interface org.codehaus.stax2.validation.XMLValidationSchema
      • getEntityCount

        public abstract int getEntityCount()
        Specified by:
        getEntityCount in interface org.codehaus.stax2.validation.DTDValidationSchema
      • getNotationCount

        public abstract int getNotationCount()
        Specified by:
        getNotationCount in interface org.codehaus.stax2.validation.DTDValidationSchema
      • isCachable

        public abstract boolean isCachable()
      • isReusableWith

        public abstract boolean isReusableWith​(DTDSubset intSubset)
        Method used in determining whether cached external subset instance can be used with specified internal subset. If ext. subset references any parameter entities int subset (re-)defines, it can not; otherwise it can be used.
        Returns:
        True if this (external) subset refers to a parameter entity defined in passed-in internal subset.
      • getGeneralEntityMap

        public abstract java.util.HashMap<java.lang.String,​EntityDecl> getGeneralEntityMap()
      • getGeneralEntityList

        public abstract java.util.List<EntityDecl> getGeneralEntityList()
      • getParameterEntityMap

        public abstract java.util.HashMap<java.lang.String,​EntityDecl> getParameterEntityMap()
      • getNotationMap

        public abstract java.util.HashMap<java.lang.String,​javax.xml.stream.events.NotationDeclaration> getNotationMap()
      • getNotationList

        public abstract java.util.List<javax.xml.stream.events.NotationDeclaration> getNotationList()