|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ctc.wstx.io.WstxInputData
com.ctc.wstx.sr.StreamScanner
com.ctc.wstx.dtd.MinimalDTDReader
com.ctc.wstx.dtd.FullDTDReader
public class FullDTDReader
Reader that reads in DTD information from internal or external subset.
There are 2 main modes for DTDReader, depending on whether it is parsing internal or external subset. Parsing of internal subset is somewhat simpler, since no dependency checking is needed. For external subset, handling of parameter entities is bit more complicated, as care has to be taken to distinguish between using PEs defined in int. subset, and ones defined in ext. subset itself. This determines cachability of external subsets.
Reader also implements simple stand-alone functionality for flattening DTD files (expanding all references to their eventual textual form); this is sometimes useful when optimizing modularized DTDs (which are more maintainable) into single monolithic DTDs (which in general can be more performant).
Field Summary |
---|
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, mCfgNormalizeLFs, mCfgNsEnabled, mCfgReplaceEntities, mConfig, mCurrDepth, mCurrName, mDocXmlVersion, mInput, mInputTopDepth, mNameBuffer, mRootInput, mTokenInputCol, mTokenInputRow, mTokenInputTotal, SAX_COMPAT_MODE |
Fields inherited from class com.ctc.wstx.io.WstxInputData |
---|
CHAR_NULL, CHAR_SPACE, INT_NULL, INT_SPACE, MAX_UNICODE_CHAR, mCurrInputProcessed, mCurrInputRow, mCurrInputRowStart, mInputBuffer, mInputLen, mInputPtr, mXml11 |
Method Summary | |
---|---|
protected java.lang.String |
checkDTDKeyword(java.lang.String exp)
Method called to verify whether input has specified keyword; if it has, returns null and points to char after the keyword; if not, returns whatever constitutes a keyword matched, for error reporting purposes. |
protected void |
checkXmlIdAttr(int type)
|
protected void |
checkXmlSpaceAttr(int type,
WordResolver enumValues)
|
protected boolean |
ensureInput(int minAmount)
Method called to make sure current main-level input buffer has at least specified number of characters available consequtively, without having to call StreamScanner.loadMore() . |
EntityDecl |
findEntity(java.lang.String entName)
Method that may need to be called by attribute default value validation code, during parsing.... |
protected EntityDecl |
findEntity(java.lang.String id,
java.lang.Object arg)
Abstract method for sub-classes to implement, for finding a declared general or parsed entity. |
static DTDSubset |
flattenExternalSubset(WstxInputSource src,
java.io.Writer flattenWriter,
boolean inclComments,
boolean inclConditionals,
boolean inclPEs)
Method that will parse, process and output contents of an external DTD subset. |
protected char |
handleExpandedSurrogate(char first,
char second)
In most cases, surrogate pair can be expanded in-situ (like done with regular xml reader), but there are cases where this can not be done. |
protected void |
handleGreedyEntityProblem(WstxInputSource input)
|
protected void |
handleIncompleteEntityProblem(WstxInputSource closing)
Handling of PE matching problems is actually intricate; one type will be a WFC ("PE Between Declarations", which refers to PEs that start from outside declarations), and another just a VC ("Proper Declaration/PE Nesting", when PE is contained within declaration) |
protected void |
handleUndeclaredEntity(java.lang.String id)
Undeclared parameter entity is a VC, not WFC... |
protected void |
initInputSource(WstxInputSource newInput,
boolean isExt)
Method called when an entity has been expanded (new input source has been created). |
protected boolean |
loadMore()
Need to override this method, to check couple of things: first, that nested input sources are balanced, when expanding parameter entities inside entity value definitions (as per XML specs), and secondly, to handle (optional) flattening output. |
protected boolean |
loadMoreFromCurrent()
|
protected void |
parseDirective()
|
protected void |
parseDirectiveFlattened()
Method similar to parseDirective() , but one that takes care
to properly output dtd contents via DTDWriter
as necessary. |
protected DTDSubset |
parseDTD()
|
protected void |
readComment(DTDEventListener l)
Method similar to MinimalDTDReader.skipComment() , but that has to collect
contents, to be reported for a SAX handler. |
protected java.lang.String |
readDTDKeyword(java.lang.String prefix)
Method called usually to indicate an error condition; will read rest of specified keyword (including characters that can be part of XML identifiers), append that to passed prefix (which is optional), and return resulting String. |
static DTDSubset |
readExternalSubset(WstxInputSource src,
ReaderConfig cfg,
DTDSubset intSubset,
boolean constructFully,
int xmlVersion)
Method called to read in the external subset definition. |
static DTDSubset |
readInternalSubset(WstxInputData srcData,
WstxInputSource input,
ReaderConfig cfg,
boolean constructFully,
int xmlVersion)
Method called to read in the internal subset definition. |
protected void |
readPI()
Method similar to MinimalDTDReader.skipPI() , but one that does basic
well-formedness checks. |
void |
setFlattenWriter(java.io.Writer w,
boolean inclComments,
boolean inclConditionals,
boolean inclPEs)
Method that will set specified Writer as the 'flattening writer'; writer used to output flattened version of DTD read in. |
Methods inherited from class com.ctc.wstx.dtd.MinimalDTDReader |
---|
dtdNextChar, dtdNextFromCurr, getErrorMsg, getLocation, getNextSkippingPEs, skipComment, skipCommentContent, skipInternalSubset, skipInternalSubset, skipPI |
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 |
Method Detail |
---|
public static DTDSubset readInternalSubset(WstxInputData srcData, WstxInputSource input, ReaderConfig cfg, boolean constructFully, int xmlVersion) throws java.io.IOException, javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
public static DTDSubset readExternalSubset(WstxInputSource src, ReaderConfig cfg, DTDSubset intSubset, boolean constructFully, int xmlVersion) throws java.io.IOException, javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
public static DTDSubset flattenExternalSubset(WstxInputSource src, java.io.Writer flattenWriter, boolean inclComments, boolean inclConditionals, boolean inclPEs) throws java.io.IOException, javax.xml.stream.XMLStreamException
readExternalSubset(com.ctc.wstx.io.WstxInputSource, com.ctc.wstx.api.ReaderConfig, com.ctc.wstx.dtd.DTDSubset, boolean, int)
, but additionally will copy its processed
("flattened") input to specified writer.
src
- Input source used to read the main external subsetflattenWriter
- Writer to output processed DTD content toinclComments
- If true, will pass comments to the writer; if false,
will strip comments outinclConditionals
- If true, will include conditional block markers,
as well as intervening content; if false, will strip out both markers
and ignorable sections.inclPEs
- If true, will output parameter entity declarations; if
false will parse and use them, but not output.
java.io.IOException
javax.xml.stream.XMLStreamException
public void setFlattenWriter(java.io.Writer w, boolean inclComments, boolean inclConditionals, boolean inclPEs)
public EntityDecl findEntity(java.lang.String entName)
Note: see base class for some additional remarks about this method.
findEntity
in class MinimalDTDReader
protected DTDSubset parseDTD() throws java.io.IOException, javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
protected void parseDirective() throws java.io.IOException, javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
protected void parseDirectiveFlattened() throws java.io.IOException, javax.xml.stream.XMLStreamException
parseDirective()
, but one that takes care
to properly output dtd contents via DTDWriter
as necessary.
Separated to simplify both methods; otherwise would end up with
'if (... flatten...) ... else ...' spaghetti code.
java.io.IOException
javax.xml.stream.XMLStreamException
protected void initInputSource(WstxInputSource newInput, boolean isExt) throws java.io.IOException, javax.xml.stream.XMLStreamException
StreamScanner
initInputSource
in class StreamScanner
java.io.IOException
javax.xml.stream.XMLStreamException
protected boolean loadMore() throws java.io.IOException, javax.xml.stream.XMLStreamException
loadMore
in class StreamScanner
java.io.IOException
javax.xml.stream.XMLStreamException
protected boolean loadMoreFromCurrent() throws java.io.IOException, javax.xml.stream.XMLStreamException
loadMoreFromCurrent
in class StreamScanner
java.io.IOException
javax.xml.stream.XMLStreamException
protected boolean ensureInput(int minAmount) throws java.io.IOException
StreamScanner
StreamScanner.loadMore()
. It can only be called
when input comes from main-level buffer; further, call can shift
content in input buffer, so caller has to flush any data still
pending. In short, caller has to know exactly what it's doing. :-)
Note: method does not check for any other input sources than the current one -- if current source can not fulfill the request, a failure is indicated.
ensureInput
in class StreamScanner
java.io.IOException
protected java.lang.String checkDTDKeyword(java.lang.String exp) throws java.io.IOException, javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
protected java.lang.String readDTDKeyword(java.lang.String prefix) throws java.io.IOException, javax.xml.stream.XMLStreamException
prefix
- Part of keyword already read in.
java.io.IOException
javax.xml.stream.XMLStreamException
protected void readPI() throws java.io.IOException, javax.xml.stream.XMLStreamException
MinimalDTDReader.skipPI()
, but one that does basic
well-formedness checks.
java.io.IOException
javax.xml.stream.XMLStreamException
protected void readComment(DTDEventListener l) throws java.io.IOException, javax.xml.stream.XMLStreamException
MinimalDTDReader.skipComment()
, but that has to collect
contents, to be reported for a SAX handler.
java.io.IOException
javax.xml.stream.XMLStreamException
protected EntityDecl findEntity(java.lang.String id, java.lang.Object arg)
StreamScanner
findEntity
in class MinimalDTDReader
arg
- If Boolean.TRUE, we are expanding a general entityid
- Identifier of the entity to findprotected void handleUndeclaredEntity(java.lang.String id) throws javax.xml.stream.XMLStreamException
handleUndeclaredEntity
in class MinimalDTDReader
javax.xml.stream.XMLStreamException
protected void handleIncompleteEntityProblem(WstxInputSource closing) throws javax.xml.stream.XMLStreamException
handleIncompleteEntityProblem
in class MinimalDTDReader
javax.xml.stream.XMLStreamException
protected void handleGreedyEntityProblem(WstxInputSource input) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
protected char handleExpandedSurrogate(char first, char second)
handleExpandedSurrogate
in class MinimalDTDReader
protected void checkXmlSpaceAttr(int type, WordResolver enumValues) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
protected void checkXmlIdAttr(int type) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |