public abstract class DTDValidatorBase extends org.codehaus.stax2.validation.XMLValidator implements NsDefaultProvider
XMLValidator
for DTD validation.
Since there are 2 sub-types -- full actual DTD validator, and a dummy
one that only adds type information and default values, with no actual
validation -- common functionality was refactored into this base
class.Modifier and Type | Field and Description |
---|---|
(package private) static int |
DEFAULT_STACK_SIZE
Estimated maximum depth of typical documents; used to allocate
the array for element stack
|
protected static java.util.HashMap<java.lang.String,EntityDecl> |
EMPTY_MAP
Let's actually just reuse a local Map...
|
(package private) static int |
EXP_MAX_ATTRS
Estimated maximum number of attributes for a single element
|
protected int |
mAttrCount
Number of attribute specification Objects in
mAttrSpecs ; needed to store in case type information
is requested later on. |
protected DTDAttribute[] |
mAttrSpecs
List of attribute declarations/specifications, one for each
attribute of the current element, for which there is a matching
value (either explicitly defined, or assigned via defaulting).
|
(package private) org.codehaus.stax2.validation.ValidationContext |
mContext
Validation context (owner) for this validator.
|
protected java.util.HashMap<PrefixedName,DTDAttribute> |
mCurrAttrDefs
Attribute definitions for attributes the current element may have
|
protected DTDElement |
mCurrElem
This is the element that is currently being validated; valid
during
validateElementStart ,
validateAttribute ,
validateElementAndAttributes calls. |
protected int |
mElemCount
Number of elements in
mElems . |
protected DTDElement[] |
mElems
Stack of element definitions matching the current active element stack.
|
(package private) java.util.Map<PrefixedName,DTDElement> |
mElemSpecs
Map that contains element specifications from DTD; null if no
DOCTYPE declaration found.
|
(package private) java.util.Map<java.lang.String,EntityDecl> |
mGeneralEntities
General entities defined in DTD subsets; needed for validating
ENTITY/ENTITIES attributes.
|
(package private) boolean |
mHasNsDefaults
Flag that indicates whether any of the elements declared has default
attribute values for namespace declaration pseudo-attributes.
|
protected int |
mIdAttrIndex
Index of the attribute of type ID, within current element's
attribute list.
|
protected boolean |
mNormAttrs
Flag that indicates whether parser wants the attribute values
to be normalized (according to XML specs) or not (which may be
more efficient, although not compliant with the specs)
|
(package private) DTDSubset |
mSchema
DTD schema (
DTDSubsetImpl ) object that created this validator
instance. |
(package private) char[] |
mTmpAttrValueBuffer
Temporary buffer attribute instances can share for validation
purposes
|
protected PrefixedName |
mTmpKey |
protected static java.util.HashMap<PrefixedName,DTDAttribute> |
NO_ATTRS |
Constructor and Description |
---|
DTDValidatorBase(DTDSubset schema,
org.codehaus.stax2.validation.ValidationContext ctxt,
boolean hasNsDefaults,
java.util.Map<PrefixedName,DTDElement> elemSpecs,
java.util.Map<java.lang.String,EntityDecl> genEntities) |
Modifier and Type | Method and Description |
---|---|
void |
checkNsDefaults(InputElementStack nsStack)
Method called by the input element stack to indicate that
it has just added local namespace declarations from the
current element, and is about to start resolving element
and attribute namespace bindings.
|
protected void |
doAddDefaultValue(DTDAttribute attr) |
protected void |
doReportValidationProblem(java.lang.String msg,
javax.xml.stream.Location loc) |
java.lang.String |
getAttributeType(int index) |
(package private) PrefixedName |
getElemName()
Name of current element on the top of the element stack.
|
(package private) java.util.Map<java.lang.String,EntityDecl> |
getEntityMap() |
int |
getIdAttrIndex()
Method for finding out the index of the attribute (collected using
the attribute collector; having DTD-derived info in same order)
that is of type ID.
|
protected abstract ElementIdMap |
getIdMap() |
(package private) javax.xml.stream.Location |
getLocation() |
int |
getNotationAttrIndex()
Method for finding out the index of the attribute (collected using
the attribute collector; having DTD-derived info in same order)
that is of type NOTATION.
|
org.codehaus.stax2.validation.XMLValidationSchema |
getSchema() |
(package private) char[] |
getTempAttrValueBuffer(int neededLength) |
boolean |
hasNsDefaults() |
boolean |
mayHaveNsDefaults(java.lang.String elemPrefix,
java.lang.String elemLN)
Calling this method before
checkNsDefaults(com.ctc.wstx.sr.InputElementStack) is necessary
to pass information regarding the current element; although
it will become available later on (via normal XMLValidator interface),
that's too late (after namespace binding and resolving). |
abstract boolean |
reallyValidating() |
(package private) void |
reportValidationProblem(java.lang.String msg)
Method called to report validity problems; depending on mode, will
either throw an exception, or add a problem notification to the
list of problems.
|
(package private) void |
reportValidationProblem(java.lang.String msg,
javax.xml.stream.Location loc) |
(package private) void |
reportValidationProblem(java.lang.String format,
java.lang.Object arg) |
(package private) void |
reportValidationProblem(java.lang.String format,
java.lang.Object arg1,
java.lang.Object arg2) |
void |
setAttrValueNormalization(boolean state)
Method that allows enabling/disabling attribute value normalization.
|
abstract java.lang.String |
validateAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
char[] valueChars,
int valueStart,
int valueEnd) |
abstract java.lang.String |
validateAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
java.lang.String value) |
abstract int |
validateElementAndAttributes() |
abstract int |
validateElementEnd(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix) |
abstract void |
validateElementStart(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix)
Method called to update information about the newly encountered (start)
element.
|
void |
validateText(char[] cbuf,
int textStart,
int textEnd,
boolean lastTextSegment) |
void |
validateText(java.lang.String text,
boolean lastTextSegment) |
abstract void |
validationCompleted(boolean eod) |
protected static final java.util.HashMap<PrefixedName,DTDAttribute> NO_ATTRS
static final int DEFAULT_STACK_SIZE
static final int EXP_MAX_ATTRS
protected static final java.util.HashMap<java.lang.String,EntityDecl> EMPTY_MAP
final boolean mHasNsDefaults
final DTDSubset mSchema
DTDSubsetImpl
) object that created this validator
instance.final org.codehaus.stax2.validation.ValidationContext mContext
final java.util.Map<PrefixedName,DTDElement> mElemSpecs
final java.util.Map<java.lang.String,EntityDecl> mGeneralEntities
protected boolean mNormAttrs
protected DTDElement mCurrElem
validateElementStart
,
validateAttribute
,
validateElementAndAttributes
calls.protected DTDElement[] mElems
protected int mElemCount
mElems
.protected java.util.HashMap<PrefixedName,DTDAttribute> mCurrAttrDefs
protected DTDAttribute[] mAttrSpecs
protected int mAttrCount
mAttrSpecs
; needed to store in case type information
is requested later on.protected int mIdAttrIndex
protected final transient PrefixedName mTmpKey
char[] mTmpAttrValueBuffer
public DTDValidatorBase(DTDSubset schema, org.codehaus.stax2.validation.ValidationContext ctxt, boolean hasNsDefaults, java.util.Map<PrefixedName,DTDElement> elemSpecs, java.util.Map<java.lang.String,EntityDecl> genEntities)
public void setAttrValueNormalization(boolean state)
public abstract boolean reallyValidating()
public final org.codehaus.stax2.validation.XMLValidationSchema getSchema()
getSchema
in class org.codehaus.stax2.validation.XMLValidator
public abstract void validateElementStart(java.lang.String localName, java.lang.String uri, java.lang.String prefix) throws javax.xml.stream.XMLStreamException
validateElementStart
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public abstract java.lang.String validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, java.lang.String value) throws javax.xml.stream.XMLStreamException
validateAttribute
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public abstract java.lang.String validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, char[] valueChars, int valueStart, int valueEnd) throws javax.xml.stream.XMLStreamException
validateAttribute
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public abstract int validateElementAndAttributes() throws javax.xml.stream.XMLStreamException
validateElementAndAttributes
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public abstract int validateElementEnd(java.lang.String localName, java.lang.String uri, java.lang.String prefix) throws javax.xml.stream.XMLStreamException
validateElementEnd
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public void validateText(java.lang.String text, boolean lastTextSegment) throws javax.xml.stream.XMLStreamException
validateText
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public void validateText(char[] cbuf, int textStart, int textEnd, boolean lastTextSegment) throws javax.xml.stream.XMLStreamException
validateText
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public abstract void validationCompleted(boolean eod) throws javax.xml.stream.XMLStreamException
validationCompleted
in class org.codehaus.stax2.validation.XMLValidator
javax.xml.stream.XMLStreamException
public java.lang.String getAttributeType(int index)
getAttributeType
in class org.codehaus.stax2.validation.XMLValidator
public int getIdAttrIndex()
getIdAttrIndex
in class org.codehaus.stax2.validation.XMLValidator
public int getNotationAttrIndex()
getNotationAttrIndex
in class org.codehaus.stax2.validation.XMLValidator
public boolean mayHaveNsDefaults(java.lang.String elemPrefix, java.lang.String elemLN)
checkNsDefaults(com.ctc.wstx.sr.InputElementStack)
is necessary
to pass information regarding the current element; although
it will become available later on (via normal XMLValidator interface),
that's too late (after namespace binding and resolving).mayHaveNsDefaults
in interface NsDefaultProvider
public void checkNsDefaults(InputElementStack nsStack) throws javax.xml.stream.XMLStreamException
NsDefaultProvider
checkNsDefaults
in interface NsDefaultProvider
javax.xml.stream.XMLStreamException
PrefixedName getElemName()
javax.xml.stream.Location getLocation()
protected abstract ElementIdMap getIdMap()
java.util.Map<java.lang.String,EntityDecl> getEntityMap()
char[] getTempAttrValueBuffer(int neededLength)
public boolean hasNsDefaults()
void reportValidationProblem(java.lang.String msg) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
void reportValidationProblem(java.lang.String msg, javax.xml.stream.Location loc) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
void reportValidationProblem(java.lang.String format, java.lang.Object arg) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
void reportValidationProblem(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
protected void doReportValidationProblem(java.lang.String msg, javax.xml.stream.Location loc) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
protected void doAddDefaultValue(DTDAttribute attr) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException