org.apache.daffodil.japi.infoset

Class InfosetOutputter

java.lang.Object

org.apache.daffodil.japi.infoset.InfosetOutputter

All Implemented Interfaces:

org.apache.daffodil.runtime1.infoset.BlobMethodsMixin, org.apache.daffodil.runtime1.infoset.InfosetOutputter

Direct Known Subclasses:

InfosetOutputterProxy

public abstract class InfosetOutputter
extends java.lang.Object
implements org.apache.daffodil.runtime1.infoset.InfosetOutputter

Abstract class used to determine how the infoset representation should be output from a call to DataProcessor#parse. The Daffodil core will call the various methods of this class in an order appropriate to create an infoset representation.

Classes that extend InfosetOutputter are not guaranteed to be thread-safe.

Constructor Summary

Constructors

Constructor and Description
InfosetOutputter()

Method Summary

Modifier and Type	Method and Description
abstract void	endArray(org.apache.daffodil.runtime1.api.InfosetArray array) Called by Daffodil internals to signify the end of an array of elements.
abstract void	endComplex(org.apache.daffodil.runtime1.api.InfosetComplexElement complex) Called by Daffodil internals to signify the end of a complex element.
abstract void	endDocument() Called by Daffodil internals to signify the end of the infoset.
abstract void	endSimple(org.apache.daffodil.runtime1.api.InfosetSimpleElement simple) Called by Daffodil internals to signify the end of a simple element.
abstract void	reset() Reset the internal state of this InfosetOutputter.
abstract void	startArray(org.apache.daffodil.runtime1.api.InfosetArray array) Called by Daffodil internals to signify the beginning of an array of elements.
abstract void	startComplex(org.apache.daffodil.runtime1.api.InfosetComplexElement complex) Called by Daffodil internals to signify the beginning of a complex element.
abstract void	startDocument() Called by Daffodil internals to signify the beginning of the infoset.
abstract void	startSimple(org.apache.daffodil.runtime1.api.InfosetSimpleElement simple) Called by Daffodil internals to signify the beginning of a simple element.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.daffodil.runtime1.infoset.BlobMethodsMixin

$init$, getBlobDirectory, getBlobPaths, getBlobPrefix, getBlobSuffix, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobDirectory_$eq, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobDirectory, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobPaths_$eq, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobPaths, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobPrefix_$eq, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobPrefix, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobSuffix_$eq, org$apache$daffodil$runtime1$infoset$BlobMethodsMixin$$blobSuffix, setBlobAttributes, setBlobPaths

Constructor Detail

InfosetOutputter

public InfosetOutputter()

Method Detail

endArray

public abstract void endArray(org.apache.daffodil.runtime1.api.InfosetArray array)
                       throws java.lang.Exception

Called by Daffodil internals to signify the end of an array of elements.

Specified by:

endArray in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Parameters:

array - the array that is ended. Various fields of DIArray can be accessed to determine things like the name, namespace, etc.

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

endComplex

public abstract void endComplex(org.apache.daffodil.runtime1.api.InfosetComplexElement complex)
                         throws java.lang.Exception

Called by Daffodil internals to signify the end of a complex element.

Specified by:

endComplex in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Parameters:

complex - the complex element that is ended. Various fields of DIComplex can be accessed to determine things like the nil, name, namespace, etc.

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

endDocument

public abstract void endDocument()
                          throws java.lang.Exception

Called by Daffodil internals to signify the end of the infoset.

Specified by:

endDocument in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

endSimple

public abstract void endSimple(org.apache.daffodil.runtime1.api.InfosetSimpleElement simple)
                        throws java.lang.Exception

Called by Daffodil internals to signify the end of a simple element.

Specified by:

endSimple in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Parameters:

simple - the simple element that is ended. Various fields of DISimple can be accessed to determine things like the value, nil, name, namespace, etc.

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

reset

public abstract void reset()

Reset the internal state of this InfosetOutputter. This should be called inbetween calls to the parse method.

Specified by:

reset in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

startArray

public abstract void startArray(org.apache.daffodil.runtime1.api.InfosetArray array)
                         throws java.lang.Exception

Called by Daffodil internals to signify the beginning of an array of elements.

Specified by:

startArray in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Parameters:

array - the array that is started. Various fields of DIArray can be accessed to determine things like the name, namespace, etc.

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

startComplex

public abstract void startComplex(org.apache.daffodil.runtime1.api.InfosetComplexElement complex)
                           throws java.lang.Exception

Called by Daffodil internals to signify the beginning of a complex element.

Specified by:

startComplex in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Parameters:

complex - the complex element that is started. Various fields of DIComplex can be accessed to determine things like the nil, name, namespace, etc.

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

startDocument

public abstract void startDocument()
                            throws java.lang.Exception

Called by Daffodil internals to signify the beginning of the infoset.

Specified by:

startDocument in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing

startSimple

public abstract void startSimple(org.apache.daffodil.runtime1.api.InfosetSimpleElement simple)
                          throws java.lang.Exception

Called by Daffodil internals to signify the beginning of a simple element.

Specified by:

startSimple in interface org.apache.daffodil.runtime1.infoset.InfosetOutputter

Parameters:

simple - the simple element that is started. Various fields of DISimple can be accessed to determine things like the value, nil, name, namespace, etc.

Throws:

java.lang.Exception - if there was an error and Daffodil should stop parsing