org.milyn.ect

Interface EdiSpecificationReader

All Known Implementing Classes:

UnEdifactSpecificationReader

public interface EdiSpecificationReader

EDI Specification Reader.

Author:

bardl

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERCHANGE_BINDING_CONFIG Interchange properties key for the top level interchange binding config.
static String	INTERCHANGE_TYPE Interchange properties key for the interchange Type e.g.
static String	MESSAGE_BINDING_CONFIG Interchange properties key for the interchange message binding config.

Method Summary

Modifier and Type	Method and Description
org.milyn.edisax.interchange.EdiDirectory	getEdiDirectory(String... includeMessages) Get the EdiDirectory instance for specification.
Properties	getInterchangeProperties() Get the message interchange properties for the associated EDI specification.
org.milyn.edisax.model.internal.Edimap	getMappingModel(String messageName) Get the EDI Mapping Model for the named message.
Set<String>	getMessageNames() Get a list of the names of the messages defined in the EDI Specification (e.g.

Field Detail

INTERCHANGE_TYPE

static final String INTERCHANGE_TYPE

Interchange properties key for the interchange Type e.g. "UNEDIFACT".

See Also:

Constant Field Values

MESSAGE_BINDING_CONFIG

static final String MESSAGE_BINDING_CONFIG

Interchange properties key for the interchange message binding config.

See Also:

Constant Field Values

INTERCHANGE_BINDING_CONFIG

static final String INTERCHANGE_BINDING_CONFIG

Interchange properties key for the top level interchange binding config.

See Also:

Constant Field Values

Method Detail

getMessageNames

Set<String> getMessageNames()

Get a list of the names of the messages defined in the EDI Specification (e.g. UN/EDIFACT specification) instance.

Returns:

The namels of the messages.

getMappingModel

org.milyn.edisax.model.internal.Edimap getMappingModel(String messageName)
                                                throws IOException

Get the EDI Mapping Model for the named message.

The Mapping Model is constructed after converting/translating the message definition in the specification. This is the "normalized" definition of any EDI message in Smooks. From the EDI Mapping Model, EJC can be used to construct Java Bindings etc.

Parameters:

messageName - The name of the message.

Returns:

The messages EDI Mapping Model.

Throws:

IOException - Error reading/converting the message definition to an EDI Mapping Model.

getInterchangeProperties

Properties getInterchangeProperties()

Get the message interchange properties for the associated EDI specification.

Returns:

The message interchange properties for the associated EDI specification.

getEdiDirectory

org.milyn.edisax.interchange.EdiDirectory getEdiDirectory(String... includeMessages)
                                                   throws IOException

Get the EdiDirectory instance for specification.

Implementations should cache this instance.

Parameters:

includeMessages - Messages to include.

Returns:

The EdiDirector instance.

Throws:

IOException - Error reading specification.