Module io.xlate.staedi

Package io.xlate.edi.stream

Class EDIInputFactory

java.lang.Object

io.xlate.edi.stream.PropertySupport

io.xlate.edi.stream.EDIInputFactory

Direct Known Subclasses:

StaEDIInputFactory

public abstract class EDIInputFactory
extends PropertySupport

Field Summary

Fields

Modifier and Type	Field	Description
static String	EDI_VALIDATE_CONTROL_STRUCTURE

Fields inherited from class io.xlate.edi.stream.PropertySupport

properties, supportedProperties

Constructor Summary

Constructors

Constructor	Description
EDIInputFactory()

Method Summary

Modifier and Type	Method	Description
abstract EDIStreamReader	createEDIStreamReader(InputStream stream)	Creates a new EDIStreamReader using the given InputStream (with default encoding).
abstract EDIStreamReader	createEDIStreamReader(InputStream stream, Schema schema)	Creates a new EDIStreamReader using the given InputStream (with default encoding) which uses the Schema for validation of the input's control structures (interchange, group, transaction).
abstract EDIStreamReader	createEDIStreamReader(InputStream stream, String encoding)	Creates a new EDIStreamReader using the given InputStream and encoding.
abstract EDIStreamReader	createEDIStreamReader(InputStream stream, String encoding, Schema schema)	Creates a new EDIStreamReader using the given InputStream and encoding which uses the Schema for validation of the input's control structures (interchange, group, transaction).
abstract EDIStreamReader	createFilteredReader(EDIStreamReader reader, EDIStreamFilter filter)	Creates a new EDIStreamReader by wrapping the given reader with the EDIStreamFilter filter.
static EDIInputFactory	newFactory()	Create a new instance of the factory.

Methods inherited from class io.xlate.edi.stream.PropertySupport

getProperty, isPropertySupported, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

EDI_VALIDATE_CONTROL_STRUCTURE

public static final String EDI_VALIDATE_CONTROL_STRUCTURE

See Also:

Constant Field Values

Constructor Detail

EDIInputFactory

public EDIInputFactory()

Method Detail

newFactory

public static EDIInputFactory newFactory()

Create a new instance of the factory. This static method creates a new factory instance. Once an application has obtained a reference to an EDIInputFactory it can use the factory to configure and obtain stream instances.

Returns:

the factory implementation

createEDIStreamReader

public abstract EDIStreamReader createEDIStreamReader(InputStream stream)

Creates a new EDIStreamReader using the given InputStream (with default encoding).

Parameters:

stream - InputStream from which the EDI data will be read

Returns:

a new EDIStreamReader which reads from the stream

createEDIStreamReader

public abstract EDIStreamReader createEDIStreamReader(InputStream stream,
                                                      String encoding)
                                               throws EDIStreamException

Creates a new EDIStreamReader using the given InputStream and encoding.

Parameters:

stream - InputStream from which the EDI data will be read

encoding - character encoding of the stream

Returns:

a new EDIStreamReader which reads from the stream

Throws:

EDIStreamException - when encoding is not supported

createEDIStreamReader

public abstract EDIStreamReader createEDIStreamReader(InputStream stream,
                                                      Schema schema)

Creates a new EDIStreamReader using the given InputStream (with default encoding) which uses the Schema for validation of the input's control structures (interchange, group, transaction). Note that a separate schema for validation of messages/transactions may be passed directly to the EDIStreamReader once the type and version of the messages is known.

Parameters:

stream - InputStream from which the EDI data will be read

schema - Schema for control structure validation

Returns:

a new EDIStreamReader which reads from the stream

createEDIStreamReader

public abstract EDIStreamReader createEDIStreamReader(InputStream stream,
                                                      String encoding,
                                                      Schema schema)
                                               throws EDIStreamException

Creates a new EDIStreamReader using the given InputStream and encoding which uses the Schema for validation of the input's control structures (interchange, group, transaction). Note that a separate schema for validation of messages/transactions may be passed directly to the EDIStreamReader once the type and version of the messages is known.

Parameters:

stream - InputStream from which the EDI data will be read

encoding - character encoding of the stream

schema - Schema for control structure validation

Returns:

a new EDIStreamReader which reads from the stream

Throws:

EDIStreamException - when encoding is not supported

createFilteredReader

public abstract EDIStreamReader createFilteredReader(EDIStreamReader reader,
                                                     EDIStreamFilter filter)

Creates a new EDIStreamReader by wrapping the given reader with the EDIStreamFilter filter.

Parameters:

reader - the reader to wrap

filter - a filter to wrap the given reader

Returns:

a new EDIStreamReader which uses filter