EasySOAProcessingContext.java

/**
 * EasySOA
 * Copyright 2011 Open Wide
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact : easysoa-dev@googlegroups.com
 */
package org.easysoa.frascati.processor;

import java.io.File;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.stp.sca.Composite;
import org.ow2.frascati.assembly.factory.api.ProcessingContext;
import org.ow2.frascati.assembly.factory.api.ProcessingMode;
import org.ow2.frascati.parser.api.ParsingContext;
import org.ow2.frascati.util.AbstractLoggeable;
import org.ow2.frascati.util.FrascatiClassLoader;
import org.ow2.frascati.util.context.ContextualProperties;
import org.ow2.frascati.util.context.ContextualPropertiesImpl;

public class EasySOAProcessingContext extends AbstractLoggeable implements
        ProcessingContext, ParsingContext {

    // ---------------------------------------------------------------------------
    // Internal state.
    // --------------------------------------------------------------------------

    /** the class loader of this parsing context. */
    private ClassLoader classLoader;

    /** structure to store data of this parsing context. */
    private Map<Object, Map<Class<?>, Object>> data = new HashMap<Object, Map<Class<?>, Object>>();

    /** the number of warnings. */
    private int nbWarnings;

    /** the warning messages */
    private List<String> warningMessages = new ArrayList<String>();

    /** the number of errors. */
    private int nbErrors;

    /** the error messages */
    private List<String> errorMessages = new ArrayList<String>();

    /** The current processing mode */
    private ProcessingMode processingMode = ProcessingMode.all;

    /** The processed root SCA composite */
    private Composite rootComposite;

    /** The processed composites **/
    private HashMap<String, Composite> processedComposites = new HashMap<String, Composite>();

    /** Contextual properties **/
    private ContextualProperties contextualProperties = new ContextualPropertiesImpl();

    /** output directory for class compilation **/
    private String outputDirectory;

    /** List of Java source directories to compile **/
    private List<String> javaSourceDirectoryToCompile = new ArrayList<String>();

    /** List of membranes to generate **/
    private List<MembraneDescription> membranesToGenerate = new ArrayList<MembraneDescription>();

    // ---------------------------------------------------------------------------
    // Public methods.
    // --------------------------------------------------------------------------

    /**
     * Construct with the current thread context class loader.
     */
    public EasySOAProcessingContext()
    {
        this.classLoader = new FrascatiClassLoader();
    }

    /**
     * Construct with an array of URLs used to create the ClassLoader.
     *
     * @param classLoader
     *            the urls array for class loader of the parser context.
     */
    public EasySOAProcessingContext(URL[] urls)
    {
        this.classLoader = new FrascatiClassLoader(urls);
    }

    /**
     * Construct with a class loader.
     *
     * @param classLoader
     *            the class loader of the parser context.
     */
    public EasySOAProcessingContext(ClassLoader classLoader)
    {
        this.classLoader = new FrascatiClassLoader(classLoader);
    }

    /**
     * {@inheritDoc}
     *
     * @see org.ow2.frascati.parser.api.ParsingContext#
     *      loadClass(java.lang.String)
     */
    @SuppressWarnings("unchecked")
    public final <T> Class<T> loadClass(String className)
    {
        try
        {
            Class<T> clazz = (Class<T>) this.classLoader.loadClass(className);
            return clazz;
        } catch (ClassNotFoundException cnfe)
        {
            if (getResource(className.replace(".", File.separator) + ".java") != null)
            {
                return null;
            }
            // throw cnfe;
        }
        return null;
    }

    /**
     * {@inheritDoc}
     *
     * @see ProcessingContext#getProcessingMode()
     */
    public ProcessingMode getProcessingMode()
    {
        return this.processingMode;
    }

    /**
     * {@inheritDoc}
     *
     * @see ProcessingContext#setProcessingMode(ProcessingMode)
     */
    public final void setProcessingMode(ProcessingMode processingMode)
    {
        this.processingMode = processingMode;
    }

    /**
     * {@inheritDoc}
     *
     * @see ProcessingContext#getRootComposite()
     */
    public final Composite getRootComposite()
    {
        return this.rootComposite;
    }

    /**
     * {@inheritDoc}
     *
     * @see ProcessingContext#setRootComposite(Composite)
     */
    public final void setRootComposite(Composite composite)
    {
        this.rootComposite = composite;
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#getClassLoader()
     */
    public final ClassLoader getClassLoader()
    {
        return this.classLoader;
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#getResource(String)
     */
    public final URL getResource(String name)
    {
        return this.classLoader.getResource(name);
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#putData(Object, Class, T)
     */
    public final <T> void putData(Object key, Class<T> type, T data)
    {
        Map<Class<?>, Object> data4key = this.data.get(key);
        if (data4key == null)
        {
            data4key = new HashMap<Class<?>, Object>();
            this.data.put(key, data4key);
        }
        data4key.put(type, data);
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#getData(Object, Class)
     */
    @SuppressWarnings("unchecked")
    public final <T> T getData(Object key, Class<T> type)
    {
        Map<Class<?>, Object> data4key = this.data.get(key);
        if (data4key == null)
        {
            return null;
        }
        return (T) data4key.get(type);
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#warning(String)
     */
    public void warning(String message)
    {
        warningMessages.add(message);
        log.warning(message);
        this.nbWarnings++;
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#getWarnings()
     */
    public final int getWarnings()
    {
        return this.nbWarnings;
    }

    /**
     * {@inheritDoc}
     *
     * @see org.ow2.frascati.parser.api.ParsingContext#error(java.lang.String)
     */
    public void error(String message)
    {
        errorMessages.add(message);
        log.severe(message);
        this.nbErrors++;
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#getErrors()
     */
    public final int getErrors()
    {
        return this.nbErrors;
    }

    /**
     * {@inheritDoc}
     *
     * @see ParsingContext#getLocationURI(EObject)
     */
    public String getLocationURI(EObject eObject)
    {
        URI uri = getData(eObject, URI.class);
        return uri == null ? null : uri.toString();
    }

    // ////////////////////////////////////////////
    // additional methods

    /**
     * Return the list of warning messages thrown during the last
     * processing process
     *
     * @return
     *          the list of warning messages
     */
    public List<String> getWarningMessages()
    {
        return warningMessages;
    }


    /**
     * Return the list of error messages thrown during the last
     * processing process
     *
     * @return
     *          the list of error messages
     */
    public List<String> getErrorMessages()
    {
        return errorMessages;
    }

    public void addProcessedComposite(Composite processedComposite) {
        this.processedComposites.put(processedComposite.getName(), processedComposite);
    }

    public List<Composite> getProcessedComposite() {
        return new ArrayList<Composite>(processedComposites.values());
    }

    public Composite getProcessedComposite(String compositeName) {
        return this.processedComposites.get(compositeName);
    }

    public Object getContextualProperty(String path) {
        return this.contextualProperties.getContextualProperty(path);
    }

    public void setContextualProperty(String path, Object value) {
        if(value != null){
            this.contextualProperties.setContextualProperty(path, value);
        }
    }

    public String getOutputDirectory() {
        return this.outputDirectory;
    }

    public void setOutputDirectory(String path) {
        this.outputDirectory = path;
    }

    public void addJavaSourceDirectoryToCompile(String path) {
      // Only store Java source path not already registered.
      if(!this.javaSourceDirectoryToCompile.contains(path)) {
        this.javaSourceDirectoryToCompile.add(path);
      }
    }

    public String[] getJavaSourceDirectoryToCompile() {
        return this.javaSourceDirectoryToCompile.toArray(new String[this.javaSourceDirectoryToCompile.size()]);
    }

    public void addMembraneToGenerate(MembraneDescription md) {
        this.membranesToGenerate.add(md);
    }

    public MembraneDescription[] getMembraneToGenerate() {
        return this.membranesToGenerate.toArray(new MembraneDescription[this.membranesToGenerate.size()]);
    }

}