Module io.xlate.staedi

Package io.xlate.edi.internal.stream

Class StaEDIStreamWriter

java.lang.Object

io.xlate.edi.internal.stream.StaEDIStreamWriter

All Implemented Interfaces:

ElementDataHandler, ValidationEventHandler, EDIStreamWriter

public class StaEDIStreamWriter
extends Object
implements EDIStreamWriter, ElementDataHandler, ValidationEventHandler

Constructor Summary

Constructors

Constructor	Description
StaEDIStreamWriter(OutputStream stream, String encoding, Map<String,Object> properties)

Method Summary

Modifier and Type	Method	Description
boolean	binaryData(InputStream binary)
void	close()	Close this writer and free any resources associated with the writer.
boolean	elementData(char[] text, int start, int length)
void	elementError(EDIStreamEvent event, EDIStreamValidationError error, CharSequence referenceCode, int element, int component, int repetition)
EDIStreamWriter	endComponent()
EDIStreamWriter	endElement()
EDIStreamWriter	endInterchange()
void	flush()	Write any cached data to the underlying output mechanism.
Location	getLocation()	Return the current location of the writer.
Object	getProperty(String name)	Get the value of a feature/property from the underlying implementation
void	loopBegin(CharSequence id)
void	loopEnd(CharSequence id)
void	segmentError(CharSequence token, EDIStreamValidationError error)
void	setControlSchema(Schema controlSchema)	Sets the schema to be used for validation of the control structure for this stream writer.
void	setTransactionSchema(Schema transactionSchema)	Sets the schema to be used for validation of the business transaction for this stream writer.
EDIStreamWriter	startComponent()
EDIStreamWriter	startInterchange()
EDIStreamWriter	writeBinaryData(byte[] binary, int start, int end)
EDIStreamWriter	writeBinaryData(InputStream binaryStream)
EDIStreamWriter	writeBinaryData(ByteBuffer binary)
EDIStreamWriter	writeComponent(char[] text, int start, int end)
EDIStreamWriter	writeComponent(CharSequence text)
EDIStreamWriter	writeElement(char[] text, int start, int end)
EDIStreamWriter	writeElement(CharSequence text)
EDIStreamWriter	writeElementData(char[] text, int start, int end)
EDIStreamWriter	writeElementData(CharSequence text)
EDIStreamWriter	writeEmptyComponent()
EDIStreamWriter	writeEmptyElement()
EDIStreamWriter	writeEndSegment()
EDIStreamWriter	writeRepeatElement()
EDIStreamWriter	writeStartElement()
EDIStreamWriter	writeStartElementBinary()
EDIStreamWriter	writeStartSegment(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

StaEDIStreamWriter

public StaEDIStreamWriter(OutputStream stream,
                          String encoding,
                          Map<String,Object> properties)

Method Detail

getProperty

public Object getProperty(String name)

Description copied from interface: EDIStreamWriter

Get the value of a feature/property from the underlying implementation

Specified by:

getProperty in interface EDIStreamWriter

Parameters:

name - - The name of the property, may not be null

Returns:

The value of the property

close

public void close()
           throws EDIStreamException

Description copied from interface: EDIStreamWriter

Close this writer and free any resources associated with the writer. This must not close the underlying output stream.

Specified by:

close in interface EDIStreamWriter

Throws:

EDIStreamException - if there are errors freeing associated resources

flush

public void flush()
           throws EDIStreamException

Description copied from interface: EDIStreamWriter

Write any cached data to the underlying output mechanism.

Specified by:

flush in interface EDIStreamWriter

Throws:

EDIStreamException - if there are errors flushing the cache

setControlSchema

public void setControlSchema(Schema controlSchema)

Description copied from interface: EDIStreamWriter

Sets the schema to be used for validation of the control structure for this stream writer. This schema will be used to validate interchange, group, and transaction/message envelopes.

Calls to this method are only valid before the interchange is started.

Specified by:

setControlSchema in interface EDIStreamWriter

Parameters:

controlSchema - the schema instance to use for validation of control structures

setTransactionSchema

public void setTransactionSchema(Schema transactionSchema)

Description copied from interface: EDIStreamWriter

Sets the schema to be used for validation of the business transaction for this stream writer. This schema will be used to validate only the contents of a transaction/message, not including the begin/end control structures.

This method may be called at any time. However, when non-null, the writer will make use of the transaction schema for output validation. It is the responsibility of the caller to set the transaction schema to null at the end of the business transaction.

Specified by:

setTransactionSchema in interface EDIStreamWriter

Parameters:

transactionSchema - the schema instance to use for validation of business transaction structures

getLocation

public Location getLocation()

Description copied from interface: EDIStreamWriter

Return the current location of the writer. If the Location is unknown the processor should return an implementation of Location that returns -1 for the location values. The location information is only valid until the next item is written to the output.

Specified by:

getLocation in interface EDIStreamWriter

Returns:

current location of the writer

startInterchange

public EDIStreamWriter startInterchange()
                                 throws EDIStreamException

Specified by:

startInterchange in interface EDIStreamWriter

Throws:

EDIStreamException

endInterchange

public EDIStreamWriter endInterchange()
                               throws EDIStreamException

Specified by:

endInterchange in interface EDIStreamWriter

Throws:

EDIStreamException

writeStartSegment

public EDIStreamWriter writeStartSegment(String name)
                                  throws EDIStreamException

Specified by:

writeStartSegment in interface EDIStreamWriter

Throws:

EDIStreamException

writeEndSegment

public EDIStreamWriter writeEndSegment()
                                throws EDIStreamException

Specified by:

writeEndSegment in interface EDIStreamWriter

Throws:

EDIStreamException

writeStartElement

public EDIStreamWriter writeStartElement()
                                  throws EDIStreamException

Specified by:

writeStartElement in interface EDIStreamWriter

Throws:

EDIStreamException

writeStartElementBinary

public EDIStreamWriter writeStartElementBinary()
                                        throws EDIStreamException

Specified by:

writeStartElementBinary in interface EDIStreamWriter

Throws:

EDIStreamException

writeRepeatElement

public EDIStreamWriter writeRepeatElement()
                                   throws EDIStreamException

Specified by:

writeRepeatElement in interface EDIStreamWriter

Throws:

EDIStreamException

endElement

public EDIStreamWriter endElement()
                           throws EDIStreamException

Specified by:

endElement in interface EDIStreamWriter

Throws:

EDIStreamException

startComponent

public EDIStreamWriter startComponent()
                               throws EDIStreamException

Specified by:

startComponent in interface EDIStreamWriter

Throws:

EDIStreamException

endComponent

public EDIStreamWriter endComponent()
                             throws EDIStreamException

Specified by:

endComponent in interface EDIStreamWriter

Throws:

EDIStreamException

writeElement

public EDIStreamWriter writeElement(CharSequence text)
                             throws EDIStreamException

Specified by:

writeElement in interface EDIStreamWriter

Throws:

EDIStreamException

writeElement

public EDIStreamWriter writeElement(char[] text,
                                    int start,
                                    int end)
                             throws EDIStreamException

Specified by:

writeElement in interface EDIStreamWriter

Throws:

EDIStreamException

writeEmptyElement

public EDIStreamWriter writeEmptyElement()
                                  throws EDIStreamException

Specified by:

writeEmptyElement in interface EDIStreamWriter

Throws:

EDIStreamException

writeComponent

public EDIStreamWriter writeComponent(CharSequence text)
                               throws EDIStreamException

Specified by:

writeComponent in interface EDIStreamWriter

Throws:

EDIStreamException

writeComponent

public EDIStreamWriter writeComponent(char[] text,
                                      int start,
                                      int end)
                               throws EDIStreamException

Specified by:

writeComponent in interface EDIStreamWriter

Throws:

EDIStreamException

writeEmptyComponent

public EDIStreamWriter writeEmptyComponent()
                                    throws EDIStreamException

Specified by:

writeEmptyComponent in interface EDIStreamWriter

Throws:

EDIStreamException

writeElementData

public EDIStreamWriter writeElementData(CharSequence text)
                                 throws EDIStreamException

Specified by:

writeElementData in interface EDIStreamWriter

Throws:

EDIStreamException

writeElementData

public EDIStreamWriter writeElementData(char[] text,
                                        int start,
                                        int end)
                                 throws EDIStreamException

Specified by:

writeElementData in interface EDIStreamWriter

Throws:

EDIStreamException

writeBinaryData

public EDIStreamWriter writeBinaryData(InputStream binaryStream)
                                throws EDIStreamException

Specified by:

writeBinaryData in interface EDIStreamWriter

Throws:

EDIStreamException

writeBinaryData

public EDIStreamWriter writeBinaryData(byte[] binary,
                                       int start,
                                       int end)
                                throws EDIStreamException

Specified by:

writeBinaryData in interface EDIStreamWriter

Throws:

EDIStreamException

writeBinaryData

public EDIStreamWriter writeBinaryData(ByteBuffer binary)
                                throws EDIStreamException

Specified by:

writeBinaryData in interface EDIStreamWriter

Throws:

EDIStreamException

binaryData

public boolean binaryData(InputStream binary)

Specified by:

binaryData in interface ElementDataHandler

elementData

public boolean elementData(char[] text,
                           int start,
                           int length)

Specified by:

elementData in interface ElementDataHandler

loopBegin

public void loopBegin(CharSequence id)

Specified by:

loopBegin in interface ValidationEventHandler

loopEnd

public void loopEnd(CharSequence id)

Specified by:

loopEnd in interface ValidationEventHandler

elementError

public void elementError(EDIStreamEvent event,
                         EDIStreamValidationError error,
                         CharSequence referenceCode,
                         int element,
                         int component,
                         int repetition)

Specified by:

elementError in interface ValidationEventHandler

segmentError

public void segmentError(CharSequence token,
                         EDIStreamValidationError error)

Specified by:

segmentError in interface ValidationEventHandler