com.ctc.wstx.sr

Class ValidatingStreamReader

java.lang.Object

com.ctc.wstx.io.WstxInputData

com.ctc.wstx.sr.StreamScanner

com.ctc.wstx.sr.BasicStreamReader

com.ctc.wstx.sr.TypedStreamReader

com.ctc.wstx.sr.ValidatingStreamReader

All Implemented Interfaces:

InputConfigFlags, ParsingErrorMsgs, InputProblemReporter, StreamReaderImpl, XMLStreamConstants, XMLStreamReader, org.codehaus.stax2.DTDInfo, org.codehaus.stax2.LocationInfo, org.codehaus.stax2.typed.TypedXMLStreamReader, org.codehaus.stax2.validation.Validatable, org.codehaus.stax2.XMLStreamReader2

public class ValidatingStreamReader
extends TypedStreamReader

Implementation of XMLStreamReader2 that builds on TypedStreamReader and adds full DTD-handling including DTD validation

Author:

Tatu Saloranta, Benson Margulies

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.stax2.validation.ValidationProblemHandler	mVldProbHandler Custom validation problem handler, if any.

Fields inherited from class com.ctc.wstx.sr.TypedStreamReader

_base64Decoder, _decoderFactory, MASK_TYPED_ACCESS_ARRAY, MASK_TYPED_ACCESS_BINARY

Fields inherited from class com.ctc.wstx.sr.BasicStreamReader

MASK_GET_ELEMENT_TEXT, MASK_GET_TEXT, MASK_GET_TEXT_WITH_WRITER, MASK_GET_TEXT_XXX, mAttrCollector, mCfgCoalesceText, mCfgLazyParsing, mCfgReportTextAsChars, mCheckIndentation, mConfigFlags, mCurrTextLength, mCurrToken, mDocStandalone, mDtdPublicId, mDtdSystemId, mElementStack, mGeneralEntities, mOwner, mParseState, mPendingException, mReturnNullForDefaultNamespace, mRootLName, mRootPrefix, mSecondaryToken, mShortestTextSegment, mStDoctypeFound, mStEmptyElem, mStTextThreshold, mTextBuffer, mTokenState, mValidateText, mVldContent, mWsStatus, sPrefixXml, sPrefixXmlns

Fields inherited from class com.ctc.wstx.sr.StreamScanner

CHAR_CR_LF_OR_NULL, CHAR_FIRST_PURE_TEXT, CHAR_LOWEST_LEGAL_LOCALNAME_CHAR, INT_CR_LF_OR_NULL, mAllowXml11EscapedCharsInXml10, mCachedEntities, mCfgNsEnabled, mCfgReplaceEntities, mCfgTreatCharRefsAsEntities, mConfig, mCurrDepth, mCurrEntity, mCurrName, mDocInputEncoding, mDocXmlEncoding, mDocXmlVersion, mEntityExpansionCount, mEntityResolver, mInput, mInputTopDepth, mNameBuffer, mNormalizeLFs, mRootInput, mTokenInputCol, mTokenInputRow, mTokenInputTotal

Fields inherited from class com.ctc.wstx.io.WstxInputData

CHAR_NULL, CHAR_SPACE, INT_NULL, INT_SPACE, MAX_UNICODE_CHAR, mCurrInputProcessed, mCurrInputRow, mCurrInputRowStart, mInputBuffer, mInputEnd, mInputPtr, mXml11

Fields inherited from interface org.codehaus.stax2.XMLStreamReader2

FEATURE_DTD_OVERRIDE

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Fields inherited from interface com.ctc.wstx.cfg.InputConfigFlags

CFG_ALLOW_XML11_ESCAPED_CHARS_IN_XML10, CFG_AUTO_CLOSE_INPUT, CFG_CACHE_DTDS, CFG_CACHE_DTDS_BY_PUBLIC_ID, CFG_COALESCE_TEXT, CFG_INTERN_NAMES, CFG_INTERN_NS_URIS, CFG_LAZY_PARSING, CFG_NAMESPACE_AWARE, CFG_NORMALIZE_LFS, CFG_PRESERVE_LOCATION, CFG_REPLACE_ENTITY_REFS, CFG_REPORT_CDATA, CFG_REPORT_PROLOG_WS, CFG_SUPPORT_DTD, CFG_SUPPORT_DTDPP, CFG_SUPPORT_EXTERNAL_ENTITIES, CFG_TREAT_CHAR_REFS_AS_ENTS, CFG_VALIDATE_AGAINST_DTD, CFG_XMLID_TYPING, CFG_XMLID_UNIQ_CHECKS

Fields inherited from interface com.ctc.wstx.cfg.ParsingErrorMsgs

SUFFIX_EOF_EXP_NAME, SUFFIX_IN_ATTR_VALUE, SUFFIX_IN_CDATA, SUFFIX_IN_CLOSE_ELEMENT, SUFFIX_IN_COMMENT, SUFFIX_IN_DEF_ATTR_VALUE, SUFFIX_IN_DOC, SUFFIX_IN_DTD, SUFFIX_IN_DTD_EXTERNAL, SUFFIX_IN_DTD_INTERNAL, SUFFIX_IN_ELEMENT, SUFFIX_IN_ENTITY_REF, SUFFIX_IN_EPILOG, SUFFIX_IN_NAME, SUFFIX_IN_PROC_INSTR, SUFFIX_IN_PROLOG, SUFFIX_IN_TEXT, SUFFIX_IN_XML_DECL

Method Summary

Methods

Modifier and Type	Method and Description
protected DTDId	constructDtdId(String pubId, String sysId)
protected DTDId	constructDtdId(URI sysId)
static ValidatingStreamReader	createValidatingStreamReader(BranchingReaderSource input, ReaderCreator owner, ReaderConfig cfg, InputBootstrapper bs, boolean forER) Factory method for constructing readers.
protected void	finishDTD(boolean copyContents) This method gets called to handle remainder of DOCTYPE declaration, essentially the optional internal subset.
Object	getProcessedDTD() Note: DTD-handling sub-classes need to override this method.
org.codehaus.stax2.validation.DTDValidationSchema	getProcessedDTDSchema() Sub-class will override this method
Object	getProperty(String name)
protected void	initValidation() Method called right before handling the root element, by the base class.
protected void	reportInvalidContent(int evtType) Method called by lower-level parsing code when invalid content (anything inside element with 'empty' content spec; text inside non-mixed element etc) is found during basic scanning.
void	reportValidationProblem(org.codehaus.stax2.validation.XMLValidationProblem prob) If there is an error handler established, call it.
org.codehaus.stax2.validation.ValidationProblemHandler	setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h)
org.codehaus.stax2.validation.XMLValidator	stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
org.codehaus.stax2.validation.XMLValidator	stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator)
org.codehaus.stax2.validation.XMLValidator	validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)

Methods inherited from class com.ctc.wstx.sr.TypedStreamReader

_base64Decoder, _constructTypeException, _decoderFactory, _verifyQName, createStreamReader, getAttributeAs, getAttributeAsArray, getAttributeAsBinary, getAttributeAsBinary, getAttributeAsBoolean, getAttributeAsDecimal, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsInteger, getAttributeAsLong, getAttributeAsLongArray, getAttributeAsQName, getAttributeIndex, getElementAs, getElementAsBinary, getElementAsBinary, getElementAsBoolean, getElementAsDecimal, getElementAsDouble, getElementAsFloat, getElementAsInt, getElementAsInteger, getElementAsLong, getElementAsQName, readElementAsArray, readElementAsBinary, readElementAsBinary, readElementAsDoubleArray, readElementAsFloatArray, readElementAsIntArray, readElementAsLongArray

Methods inherited from class com.ctc.wstx.sr.BasicStreamReader

_constructTypeException, _constructUnexpectedInTyped, checkCData, checkKeyword, close, closeCompletely, createElementStack, ensureFinishToken, findEntity, finishToken, fireSaxCharacterEvents, fireSaxCommentEvent, fireSaxEndElement, fireSaxPIEvent, fireSaxSpaceEvents, fireSaxStartElement, getAttributeCollector, getAttributeCount, getAttributeInfo, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getCurrentEntityDecl, getDepth, getDTDInfo, getDTDInternalSubset, getDTDPublicId, getDTDRootName, getDTDSystemId, getElementText, getEncoding, getEndingByteOffset, getEndingCharOffset, getEndLocation, getEventType, getFeature, getInputElementStack, getLocalName, getLocation, getLocationInfo, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getNonTransientNamespaceContext, getPIData, getPITarget, getPrefix, getPrefixedName, getStartingByteOffset, getStartingCharOffset, getText, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, handleEOF, handleGreedyEntityProblem, handleIncompleteEntityProblem, handleMultiDocStart, handleMultiDocXmlDecl, handleRootElem, handleUndeclaredEntity, hasConfigFlags, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEmptyElement, isEndElement, isNamespaceAware, isPropertySupported, isStandalone, isStartElement, isWhiteSpace, next, nextTag, parseQuoted, readCDataSecondary, readCoalescedText, readEndElem, readTextSecondary, require, safeEnsureFinishToken, safeFinishToken, setFeature, setProperty, skipElement, skipEquals, skipWS, standaloneSet, throwNotTextualOrElem, throwUnexpectedEOF, withStartElement

Methods inherited from class com.ctc.wstx.sr.StreamScanner

_reportProblem, _reportProblem, closeAllInput, constructFromIOE, constructLimitViolation, constructNullCharException, constructWfcException, ensureInput, expandBy50Pct, expandEntity, fullyResolveEntity, getConfig, getCurrentInput, getCurrentLocation, getIntEntity, getLastCharLocation, getNameBuffer, getNext, getNextAfterWS, getNextChar, getNextCharAfterWS, getNextCharFromCurrent, getNextInCurrAfterWS, getNextInCurrAfterWS, getSource, getStartLocation, getSystemId, initInputSource, inputInBuffer, loadMore, loadMore, loadMoreFromCurrent, loadMoreFromCurrent, markLF, markLF, parseEntityName, parseFNameForError, parseFullName, parseFullName, parseFullName2, parseLocalName, parseLocalName2, parsePublicId, parseSystemId, parseUntil, peekNext, pushback, reportProblem, reportProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, resolveCharOnlyEntity, resolveNonCharEntity, resolveSimpleEntity, skipCRLF, skipFullName, throwFromIOE, throwFromStrE, throwInvalidSpace, throwInvalidSpace, throwLazyError, throwNullChar, throwNullParent, throwParseError, throwParseError, throwUnexpectedChar, throwUnexpectedEOB, throwUnexpectedEOF, throwWfcException, tokenTypeDesc, verifyLimit

Methods inherited from class com.ctc.wstx.io.WstxInputData

copyBufferStateFrom, findIllegalNameChar, findIllegalNmtokenChar, getCharDesc, isNameChar, isNameChar, isNameStartChar, isNameStartChar, isSpaceChar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.stax2.LocationInfo

getCurrentLocation, getStartLocation

Field Detail

mVldProbHandler

protected org.codehaus.stax2.validation.ValidationProblemHandler mVldProbHandler

Custom validation problem handler, if any.

Method Detail

createValidatingStreamReader

public static ValidatingStreamReader createValidatingStreamReader(BranchingReaderSource input,
                                                  ReaderCreator owner,
                                                  ReaderConfig cfg,
                                                  InputBootstrapper bs,
                                                  boolean forER)
                                                           throws XMLStreamException

Factory method for constructing readers.

Parameters:

owner - "Owner" of this reader, factory that created the reader; needed for returning updated symbol table information after parsing.

input - Input source used to read the XML document.

cfg - Object that contains reader configuration info.

bs - Bootstrapper to use, for reading xml declaration etc.

forER - True if this reader is to be (configured to be) used by an event reader. Will cause some changes to default settings, as required by contracts Woodstox XMLEventReader implementation has (with respect to lazy parsing, short text segments etc)

Throws:

XMLStreamException

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface XMLStreamReader

Overrides:

getProperty in class BasicStreamReader

getProcessedDTD

public Object getProcessedDTD()

Description copied from class: BasicStreamReader

Note: DTD-handling sub-classes need to override this method.

Specified by:

getProcessedDTD in interface org.codehaus.stax2.DTDInfo

Overrides:

getProcessedDTD in class BasicStreamReader

getProcessedDTDSchema

public org.codehaus.stax2.validation.DTDValidationSchema getProcessedDTDSchema()

Description copied from class: BasicStreamReader

Sub-class will override this method

Specified by:

getProcessedDTDSchema in interface org.codehaus.stax2.DTDInfo

Overrides:

getProcessedDTDSchema in class BasicStreamReader

validateAgainst

public org.codehaus.stax2.validation.XMLValidator validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
                                                           throws XMLStreamException

Specified by:

validateAgainst in interface org.codehaus.stax2.validation.Validatable

Overrides:

validateAgainst in class BasicStreamReader

Throws:

XMLStreamException

stopValidatingAgainst

public org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
                                                                 throws XMLStreamException

Specified by:

stopValidatingAgainst in interface org.codehaus.stax2.validation.Validatable

Overrides:

stopValidatingAgainst in class BasicStreamReader

Throws:

XMLStreamException

stopValidatingAgainst

public org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator)
                                                                 throws XMLStreamException

Specified by:

stopValidatingAgainst in interface org.codehaus.stax2.validation.Validatable

Overrides:

stopValidatingAgainst in class BasicStreamReader

Throws:

XMLStreamException

setValidationProblemHandler

public org.codehaus.stax2.validation.ValidationProblemHandler setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h)

Specified by:

setValidationProblemHandler in interface org.codehaus.stax2.validation.Validatable

Overrides:

setValidationProblemHandler in class BasicStreamReader

finishDTD

protected void finishDTD(boolean copyContents)
                  throws XMLStreamException

This method gets called to handle remainder of DOCTYPE declaration, essentially the optional internal subset. Internal subset, if such exists, is always read, but whether its contents are added to the read buffer depend on passed-in argument.

NOTE: Since this method overrides the default implementation, make sure you do NOT change the method signature.

Overrides:

finishDTD in class BasicStreamReader

Parameters:

copyContents - If true, will copy contents of the internal subset of DOCTYPE declaration in the text buffer (in addition to parsing it for actual use); if false, will only do parsing.

Throws:

XMLStreamException

reportValidationProblem

public void reportValidationProblem(org.codehaus.stax2.validation.XMLValidationProblem prob)
                             throws XMLStreamException

If there is an error handler established, call it.

Specified by:

reportValidationProblem in interface InputProblemReporter

Overrides:

reportValidationProblem in class StreamScanner

Throws:

XMLStreamException

initValidation

protected void initValidation()
                       throws XMLStreamException

Method called right before handling the root element, by the base class. This allows for some initialization and checks to be done (not including ones that need access to actual element name)

Overrides:

initValidation in class BasicStreamReader

Throws:

XMLStreamException

constructDtdId

protected DTDId constructDtdId(String pubId,
                   String sysId)
                        throws IOException

Throws:

IOException

constructDtdId

protected DTDId constructDtdId(URI sysId)
                        throws IOException

Throws:

IOException

reportInvalidContent

protected void reportInvalidContent(int evtType)
                             throws XMLStreamException

Method called by lower-level parsing code when invalid content (anything inside element with 'empty' content spec; text inside non-mixed element etc) is found during basic scanning. Note that actual DTD element structure problems are not reported through this method.

Overrides:

reportInvalidContent in class BasicStreamReader

Parameters:

evtType - Type of event that contained unexpected content

Throws:

XMLStreamException