Top Description Constructors Methods
com.ctc.wstx.dtd

public abstract Class DTDSubset

extends Object
implements DTDValidationSchema
Class Inheritance
All Implemented Interfaces
org.codehaus.stax2.validation.DTDValidationSchema, org.codehaus.stax2.validation.XMLValidationSchema
Known Direct Subclasses
com.ctc.wstx.dtd.DTDSubsetImpl
Imports
java.util.*, javax.xml.stream.XMLStreamException, javax.xml.stream.events.NotationDeclaration, org.codehaus.stax2.validation.*, com.ctc.wstx.ent.EntityDecl, com.ctc.wstx.sr.InputProblemReporter, com.ctc.wstx.util.PrefixedName
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 Summary

AccessConstructor and Description
protected
DTDSubset()

Method Summary

Modifier and TypeMethod and Description
public abstract DTDSubset
combineWithExternalSubset(InputProblemReporter rep, DTDSubset extSubset)

Method that will combine definitions from this internal subset with definitions from passed-in external subset, producing a new combined DTDSubset instance.

public abstract XMLValidator
createValidator(ValidationContext ctxt)

Redeclares org.codehaus.stax2.validation.XMLValidationSchema.createValidator.

public abstract HashMap<PrefixedName, DTDElement>
getElementMap()

public abstract int
getEntityCount()

Redeclares org.codehaus.stax2.validation.DTDValidationSchema.getEntityCount.

public abstract List<EntityDecl>
getGeneralEntityList()

public abstract HashMap<String, EntityDecl>
getGeneralEntityMap()

public abstract int
getNotationCount()

Redeclares org.codehaus.stax2.validation.DTDValidationSchema.getNotationCount.

public abstract List<NotationDeclaration>
getNotationList()

public abstract HashMap<String, NotationDeclaration>
getNotationMap()

public abstract HashMap<String, EntityDecl>
getParameterEntityMap()

public String
getSchemaType()

Implements org.codehaus.stax2.validation.XMLValidationSchema.getSchemaType.

Returns type of this schema.

public abstract boolean
isCachable()

public abstract boolean

Returns:

True if this (external) subset refers to a parameter entity defined in passed-in internal subset.
isReusableWith(DTDSubset intSubset)

Method used in determining whether cached external subset instance can be used with specified internal subset.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DTDSubsetback to summary
protected DTDSubset()

Method Detail

combineWithExternalSubsetback to summary
public abstract DTDSubset combineWithExternalSubset(InputProblemReporter rep, DTDSubset extSubset) throws XMLStreamException

Method that will combine definitions from this internal subset with definitions from passed-in external subset, producing a new combined DTDSubset instance.

createValidatorback to summary
public abstract XMLValidator createValidator(ValidationContext ctxt) throws XMLStreamException

Redeclares org.codehaus.stax2.validation.XMLValidationSchema.createValidator.

Annotations
@Override
getElementMapback to summary
public abstract HashMap<PrefixedName, DTDElement> getElementMap()
getEntityCountback to summary
public abstract int getEntityCount()

Redeclares org.codehaus.stax2.validation.DTDValidationSchema.getEntityCount.

Returns:int

Doc from org.codehaus.stax2.validation.DTDValidationSchema.getEntityCount.

Number of general (non-parameter) entities (of all types) declared in this DTD schema (in subsets [internal, external] included)

Annotations
@Override
getGeneralEntityListback to summary
public abstract List<EntityDecl> getGeneralEntityList()
getGeneralEntityMapback to summary
public abstract HashMap<String, EntityDecl> getGeneralEntityMap()
getNotationCountback to summary
public abstract int getNotationCount()

Redeclares org.codehaus.stax2.validation.DTDValidationSchema.getNotationCount.

Returns:int

Doc from org.codehaus.stax2.validation.DTDValidationSchema.getNotationCount.

Number of notations declared in this DTD schema (in subsets [internal, external] included)

Annotations
@Override
getNotationListback to summary
public abstract List<NotationDeclaration> getNotationList()
getNotationMapback to summary
public abstract HashMap<String, NotationDeclaration> getNotationMap()
getParameterEntityMapback to summary
public abstract HashMap<String, EntityDecl> getParameterEntityMap()
getSchemaTypeback to summary
public String getSchemaType()

Implements org.codehaus.stax2.validation.XMLValidationSchema.getSchemaType.

Doc from org.codehaus.stax2.validation.XMLValidationSchema.getSchemaType.

Returns type of this schema.

Returns:String

One of external schema identifier values (such as SCHEMA_ID_DTD).

Annotations
@Override
isCachableback to summary
public abstract boolean isCachable()
isReusableWithback to summary
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:boolean

True if this (external) subset refers to a parameter entity defined in passed-in internal subset.