Package org.apache.daffodil.api

Interface DaffodilParseXMLReader

All Superinterfaces:

XMLReader

public interface DaffodilParseXMLReader
extends XMLReader

SAX Method of parsing schema and getting the DFDL Infoset via designated org.xml.sax.ContentHandler, based on the org.xml.sax.XMLReader interface

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DAFFODIL_SAX_URN_BLOBDIRECTORY	Property name to get/set blob directory as String from the DaffodilParseXMLReader
static final String	DAFFODIL_SAX_URN_BLOBPREFIX	Property name to get/set blob prefix as String from the DaffodilParseXMLReader
static final String	DAFFODIL_SAX_URN_BLOBSUFFIX	Property name to get/set blob suffix as String from the DaffodilParseXMLReader
static final String	DAFFODIL_SAX_URN_PARSERESULT	Property name to get the ParseResult from the DaffodilParseXMLReader.

Method Summary

Modifier and Type	Method	Description
ContentHandler	getContentHandler()	Retrieve registered content handler
DTDHandler	getDTDHandler()	Retrieve registered DTD Handler
EntityResolver	getEntityResolver()	Return the registered entity resolver
ErrorHandler	getErrorHandler()	Retrieve registered error handler
boolean	getFeature(String name)	Get the value of the feature flag
Object	getProperty(String name)	Get the value of the property
void	parse(byte[] arr)	Parse input data from an array of bytes.
void	parse(InputStream stream)	Parse input data from an InputStream.
void	parse(String systemId)	Parse data from a system identifier/URI.
void	parse(InputSourceDataInputStream isdis)	Parse input data from an InputSourceDataInputStream.
void	parse(InputSource input)	Parse input data from an InputSource.
void	setContentHandler(ContentHandler handler)	Register a content handler
void	setDTDHandler(DTDHandler handler)	Register a DTD Handler
void	setEntityResolver(EntityResolver resolver)	Register an entity resolver
void	setErrorHandler(ErrorHandler handler)	Register an error handler
void	setFeature(String name, boolean value)	Set the value of the feature flag
void	setProperty(String name, Object value)	Set the value of the property

Field Details

DAFFODIL_SAX_URN_PARSERESULT

static final String DAFFODIL_SAX_URN_PARSERESULT

Property name to get the ParseResult from the DaffodilParseXMLReader. This property is read only.

DAFFODIL_SAX_URN_BLOBDIRECTORY

static final String DAFFODIL_SAX_URN_BLOBDIRECTORY

Property name to get/set blob directory as String from the DaffodilParseXMLReader

DAFFODIL_SAX_URN_BLOBPREFIX

static final String DAFFODIL_SAX_URN_BLOBPREFIX

Property name to get/set blob prefix as String from the DaffodilParseXMLReader

DAFFODIL_SAX_URN_BLOBSUFFIX

static final String DAFFODIL_SAX_URN_BLOBSUFFIX

Property name to get/set blob suffix as String from the DaffodilParseXMLReader

Method Details

getFeature

boolean getFeature(String name)
            throws SAXNotRecognizedException,
SAXNotSupportedException

Get the value of the feature flag

Specified by:

getFeature in interface XMLReader

Parameters:

name - feature flag whose value is to be retrieved

Returns:

value of the feature flag

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setFeature

void setFeature(String name,
 boolean value)
         throws SAXNotRecognizedException,
SAXNotSupportedException

Set the value of the feature flag

Specified by:

setFeature in interface XMLReader

Parameters:

name - feature flag to be set

value - value to be assigned to feature flag

Throws:

SAXNotRecognizedException

SAXNotSupportedException

getProperty

Object getProperty(String name)
            throws SAXNotRecognizedException,
SAXNotSupportedException

Get the value of the property

Specified by:

getProperty in interface XMLReader

Parameters:

name - property whose value is to be retrieved

Returns:

value of the property

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setProperty

void setProperty(String name,
 Object value)
          throws SAXNotRecognizedException,
SAXNotSupportedException

Set the value of the property

Specified by:

setProperty in interface XMLReader

Parameters:

name - property whose value is to be set

value - value to be assigned to the property

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setEntityResolver

void setEntityResolver(EntityResolver resolver)

Register an entity resolver

Specified by:

setEntityResolver in interface XMLReader

Parameters:

resolver - entity resolver to be registered

getEntityResolver

EntityResolver getEntityResolver()

Return the registered entity resolver

Specified by:

getEntityResolver in interface XMLReader

Returns:

registered entity resolver or null

setDTDHandler

void setDTDHandler(DTDHandler handler)

Register a DTD Handler

Specified by:

setDTDHandler in interface XMLReader

Parameters:

handler - DTD Handler to be registered

getDTDHandler

DTDHandler getDTDHandler()

Retrieve registered DTD Handler

Specified by:

getDTDHandler in interface XMLReader

Returns:

registered DTD Handler or null

setContentHandler

void setContentHandler(ContentHandler handler)

Register a content handler

Specified by:

setContentHandler in interface XMLReader

Parameters:

handler - content handler to be registered

getContentHandler

ContentHandler getContentHandler()

Retrieve registered content handler

Specified by:

getContentHandler in interface XMLReader

Returns:

registered content handler or null

setErrorHandler

void setErrorHandler(ErrorHandler handler)

Register an error handler

Specified by:

setErrorHandler in interface XMLReader

Parameters:

handler - error handler to be registered

getErrorHandler

ErrorHandler getErrorHandler()

Retrieve registered error handler

Specified by:

getErrorHandler in interface XMLReader

Returns:

registered error handler or null

parse

void parse(InputSource input)
    throws IOException,
SAXException

Parse input data from an InputSource. Infoset can be retrieved via the registered contentHandler and diagnostics via the registered errorHandler

Specified by:

parse in interface XMLReader

Parameters:

input - data to be parsed

Throws:

IOException

SAXException

parse

void parse(String systemId)
    throws IOException,
SAXException

Parse data from a system identifier/URI. This method is not supported by the API.

Specified by:

parse in interface XMLReader

Parameters:

systemId - URI for data to be parsed

Throws:

IOException

SAXException

parse

void parse(InputSourceDataInputStream isdis)
    throws IOException,
SAXException

Parse input data from an InputSourceDataInputStream. Infoset can retrieved via the registered contentHandler and diagnostics via the registered errorHandler

Parameters:

isdis - data to be parsed

Throws:

IOException

SAXException

parse

void parse(InputStream stream)
    throws IOException,
SAXException

Parse input data from an InputStream. Infoset can retrieved via the registered contentHandler and diagnostics via the registered errorHandler

Parameters:

stream - data to be parsed

Throws:

IOException

SAXException

parse

void parse(byte[] arr)
    throws IOException,
SAXException

Parse input data from an array of bytes. Infoset can be retrieved via the registered contentHandler and diagnostics via the registered errorHandler

Parameters:

arr - data to be parsed

Throws:

IOException

SAXException