org.milyn.ect.EdiSpecificationReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of milyn-smooks-ect Show documentation
There is a newer version: 1.7.1
/*
	Milyn - Copyright (C) 2006 - 2010

	This library is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License (version 2.1) as published by the Free Software
	Foundation.

	This library is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

	See the GNU Lesser General Public License for more details:
	http://www.gnu.org/licenses/lgpl.txt
*/
package org.milyn.ect;

import org.milyn.edisax.interchange.EdiDirectory;
import org.milyn.edisax.model.internal.Edimap;

import java.io.IOException;
import java.util.Properties;
import java.util.Set;

/**
 * EDI Specification Reader.
 *
 * @author bardl
 */
public interface EdiSpecificationReader {

    /**
     * Interchange properties key for the interchange Type e.g. "UNEDIFACT".
     */
    public static final String INTERCHANGE_TYPE = "interchangeType";
    /**
     * Interchange properties key for the interchange message binding config.
     */
    public static final String MESSAGE_BINDING_CONFIG = "messageBindingConfig";
    /**
     * Interchange properties key for the top level interchange binding config.
     */
    public static final String INTERCHANGE_BINDING_CONFIG = "interchangeBindingConfig";

    /**
     * Get a list of the names of the messages defined in the EDI Specification (e.g. UN/EDIFACT
     * specification) instance.
     *
     * @return The namels of the messages.
     */
    Set getMessageNames();

    /**
     * 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.
     *
     * @param messageName The name of the message.
     * @return The messages EDI Mapping Model.
     * @throws IOException Error reading/converting the message definition to
     *                     an EDI Mapping Model.
     */
    Edimap getMappingModel(String messageName) throws IOException;

    
    
    /**
     * Get the message interchange properties for the associated EDI specification.
     * @return The message interchange properties for the associated EDI specification.
     */
    Properties getInterchangeProperties();

    /**
     * Get the {@link org.milyn.edisax.interchange.EdiDirectory} instance for specification.
     * 
     * Implementations should cache this instance.
     *
     * @param includeMessages Messages to include.
     * @return The EdiDirector instance.
     * @throws IOException Error reading specification.
     */
    EdiDirectory getEdiDirectory(String... includeMessages) throws IOException;
}