org.cip4.jdflib.core
Class JDFParser

java.lang.Object
  org.apache.xerces.parsers.XMLParser
      org.apache.xerces.parsers.AbstractXMLDocumentParser
          org.apache.xerces.parsers.AbstractDOMParser
              org.apache.xerces.parsers.DOMParser
                  org.cip4.jdflib.core.XMLParser
                      org.cip4.jdflib.core.JDFParser

All Implemented Interfaces:

org.apache.xerces.xni.XMLDocumentHandler, org.apache.xerces.xni.XMLDTDContentModelHandler, org.apache.xerces.xni.XMLDTDHandler

public class JDFParser
extends XMLParser

Author:

matternk

Field Summary

boolean	bKElementOnly set bKElementOnly=true if you want the output ojects all to be instatnces of KElement rather than instantiated JDF instances
boolean	ignoreNSDefault set ignoreNSDefault=true if you do not want any heuristics to be performed regarding DOM level 1 / 2 namespace associations

Fields inherited from class org.cip4.jdflib.core.XMLParser

log, m_eraseEmpty, m_ErrorHandler, m_lastExcept, m_SchemaLocation, m_searchStream

Fields inherited from class org.apache.xerces.parsers.DOMParser

fUseEntityResolver2, SYMBOL_TABLE, USE_ENTITY_RESOLVER2, XMLGRAMMAR_POOL

Fields inherited from class org.apache.xerces.parsers.AbstractDOMParser

ABORT, CORE_DOCUMENT_CLASS_NAME, CREATE_CDATA_NODES_FEATURE, CREATE_ENTITY_REF_NODES, CURRENT_ELEMENT_NODE, DEFAULT_DOCUMENT_CLASS_NAME, DEFER_NODE_EXPANSION, DOCUMENT_CLASS_NAME, fBaseURIStack, fCreateCDATANodes, fCreateEntityRefNodes, fCurrentCDATASection, fCurrentCDATASectionIndex, fCurrentEntityDecl, fCurrentNode, fCurrentNodeIndex, fDeferNodeExpansion, fDeferredDocumentImpl, fDeferredEntityDecl, fDocument, fDocumentClassName, fDocumentImpl, fDocumentIndex, fDocumentType, fDocumentTypeIndex, fDOMFilter, fErrorHandler, fFilterReject, fFirstChunk, fInCDATASection, fIncludeComments, fIncludeIgnorableWhitespace, fInDTD, fInDTDExternalSubset, fInEntityRef, fInternalSubset, fNamespaceAware, fRejectedElement, fRoot, fSkippedElemStack, fStorePSVI, fStringBuffer, INCLUDE_COMMENTS_FEATURE, INCLUDE_IGNORABLE_WHITESPACE, NAMESPACES, PSVI_DOCUMENT_CLASS_NAME

Fields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser

fDocumentSource, fDTDContentModelSource, fDTDSource

Fields inherited from class org.apache.xerces.parsers.XMLParser

ENTITY_RESOLVER, ERROR_HANDLER, fConfiguration

Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler

CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE

Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler

OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE

Constructor Summary

JDFParser()
default constructor

JDFParser(JDFParser parser)

JDFParser(String strDocType)
Deprecated. - use default constructor

Method Summary

void	cleanup() (non-Javadoc) reset all internal variables to a reasonable default
Element	createElementNode(org.apache.xerces.xni.QName element)
String	getDocumentClass()
protected XMLDoc	getXMLDoc()
JDFDoc	parseFile(File file)
JDFDoc	parseFile(String strFile) parseFile - parse a file specified by strFile
JDFDoc	parseFile(String strFile, String schemaLocation) Deprecated. set the parser members instead
JDFDoc	parseInputSource(InputSource inSource, String schemaLocation, String documentClassName, ErrorHandler errorHandler, boolean bEraseEmpty, boolean bDoNamespaces) Deprecated. set the parser members instead
JDFDoc	parseStream(InputStream inStream) parseStream - parse a stream specified by inStream
JDFDoc	parseString(String stringInput) parseString - parse a string specified by stringInput
protected XMLDoc	runParser(InputSource inSource, boolean bEraseEmpty)
protected void	setDocumentProperties(KElement root, DocumentXMLImpl memberDocument, String namespaceURI)
void	setErrorHandler(ErrorHandler handler)
void	setJDFSchemaLocation(File _schemaLocation)
void	startDocument(org.apache.xerces.xni.XMLLocator locator, String encoding, org.apache.xerces.xni.NamespaceContext namespaceContext, org.apache.xerces.xni.Augmentations augs)

Methods inherited from class org.cip4.jdflib.core.XMLParser

initParser, parse, parseInputSource, setSchemaLocation

Methods inherited from class org.apache.xerces.parsers.DOMParser

getEntityResolver, getErrorHandler, getFeature, getProperty, getXMLParserConfiguration, parse, setEntityResolver, setFeature, setProperty

Methods inherited from class org.apache.xerces.parsers.AbstractDOMParser

abort, attributeDecl, characters, comment, createAttrNode, doctypeDecl, dropDocumentReferences, elementDecl, emptyElement, endAttlist, endCDATA, endConditional, endDocument, endDTD, endElement, endExternalSubset, endGeneralEntity, endParameterEntity, externalEntityDecl, getDocument, getDocumentClassName, handleBaseURI, handleBaseURI, ignorableWhitespace, ignoredCharacters, internalEntityDecl, notationDecl, processingInstruction, reset, setCharacterData, setDocumentClassName, setLocale, startAttlist, startCDATA, startConditional, startDTD, startElement, startExternalSubset, startGeneralEntity, startParameterEntity, textDecl, unparsedEntityDecl, xmlDecl

Methods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser

any, element, empty, endContentModel, endGroup, getDocumentSource, getDTDContentModelSource, getDTDSource, occurrence, pcdata, separator, setDocumentSource, setDTDContentModelSource, setDTDSource, startContentModel, startGroup

Methods inherited from class org.apache.xerces.parsers.XMLParser

parse

Methods inherited from class java.lang.Object

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

Field Detail

bKElementOnly

public boolean bKElementOnly

set bKElementOnly=true if you want the output ojects all to be instatnces of KElement rather than instantiated JDF instances

ignoreNSDefault

public boolean ignoreNSDefault

set ignoreNSDefault=true if you do not want any heuristics to be performed regarding DOM level 1 / 2 namespace associations

Constructor Detail

JDFParser

public JDFParser()

default constructor

JDFParser

@Deprecated
public JDFParser(String strDocType)

Deprecated. - use default constructor

Parameters:

strDocType -

JDFParser

public JDFParser(JDFParser parser)

Parameters:

parser -

Method Detail

cleanup

public void cleanup()

(non-Javadoc) reset all internal variables to a reasonable default

Overrides:

cleanup in class XMLParser

See Also:

AbstractDOMParser.reset()

parseFile

public JDFDoc parseFile(String strFile)

parseFile - parse a file specified by strFile

Overrides:

parseFile in class XMLParser

Parameters:

strFile - link to the document to parse, may be either a file path or a url

Returns:

JDFDoc or null if File not found

parseFile

public JDFDoc parseFile(File file)

Overrides:

parseFile in class XMLParser

Parameters:

file -

Returns:

parseFile

@Deprecated
public JDFDoc parseFile(String strFile,
                                   String schemaLocation)

Deprecated. set the parser members instead

parseFile - parse a file specified by strFile

Parameters:

strFile - link to the document to parse

schemaLocation - link to the schema to use, null if no validation required

Returns:

JDFDoc or null if File not found default: parseFile(strFile,null)

parseString

public JDFDoc parseString(String stringInput)

parseString - parse a string specified by stringInput

Overrides:

parseString in class XMLParser

Parameters:

stringInput - string to parse

Returns:

JDFDoc or null if parse failed default: parseString(stringInput)

parseStream

public JDFDoc parseStream(InputStream inStream)

parseStream - parse a stream specified by inStream

Overrides:

parseStream in class XMLParser

Parameters:

inStream - stream to parse

Returns:

JDFDoc or null if parse failed default: parseStream(inStream)

parseInputSource

@Deprecated
public JDFDoc parseInputSource(InputSource inSource,
                                          String schemaLocation,
                                          String documentClassName,
                                          ErrorHandler errorHandler,
                                          boolean bEraseEmpty,
                                          boolean bDoNamespaces)

Deprecated. set the parser members instead

This is the sophisticated parse function, where validation, error handlers et al. can be set

Parameters:

inSource -

schemaLocation - schema location, null if no validation required

documentClassName -

errorHandler -

bEraseEmpty - if true empty nodes are erased after parsing

bDoNamespaces - if false a second parse is done, where namespaces are ignored

Returns:

JDFDoc default: parseInputSource(inSource, null, DocumentJDFImpl.class.getName(), null, true, true);

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Overrides:

setErrorHandler in class XMLParser

See Also:

DOMParser.setErrorHandler(org.xml.sax.ErrorHandler)

getDocumentClass

public String getDocumentClass()

Overrides:

getDocumentClass in class XMLParser

Returns:

the class name

createElementNode

public Element createElementNode(org.apache.xerces.xni.QName element)

Overrides:

createElementNode in class org.apache.xerces.parsers.AbstractDOMParser

See Also:

AbstractDOMParser.createElementNode(org.apache.xerces.xni.QName)

getXMLDoc

protected XMLDoc getXMLDoc()

Overrides:

getXMLDoc in class XMLParser

setJDFSchemaLocation

public void setJDFSchemaLocation(File _schemaLocation)

Parameters:

_schemaLocation - the schema location

startDocument

public void startDocument(org.apache.xerces.xni.XMLLocator locator,
                          String encoding,
                          org.apache.xerces.xni.NamespaceContext namespaceContext,
                          org.apache.xerces.xni.Augmentations augs)
                   throws org.apache.xerces.xni.XNIException

Specified by:

startDocument in interface org.apache.xerces.xni.XMLDocumentHandler

Overrides:

startDocument in class XMLParser

Throws:

org.apache.xerces.xni.XNIException

See Also:

AbstractDOMParser.startDocument(org.apache.xerces.xni.XMLLocator, java.lang.String, org.apache.xerces.xni.NamespaceContext, org.apache.xerces.xni.Augmentations)

setDocumentProperties

protected void setDocumentProperties(KElement root,
                                     DocumentXMLImpl memberDocument,
                                     String namespaceURI)

Overrides:

setDocumentProperties in class XMLParser

runParser

protected final XMLDoc runParser(InputSource inSource,
                                 boolean bEraseEmpty)

Overrides:

runParser in class XMLParser

Returns: