plugins/org.eclipse.gendoc.tags.handlers/src/org/eclipse/gendoc/tags/handlers/impl/context/ContextService.java

/*****************************************************************************
 * Copyright (c) 2010 Atos Origin.
 *
 *    
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *  Caroline Bourdeu d'Aguerre (Atos Origin) caroline.bourdeudaguerre@atosorigin.com - Initial API and implementation
 *  Antonio Campesino (Ericsson) - Bug 530839.
 *
 *****************************************************************************/

package org.eclipse.gendoc.tags.handlers.impl.context;

import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.ContentHandler;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.URIConverter;
import org.eclipse.emf.ecore.resource.URIHandler;
import org.eclipse.emf.ecore.resource.impl.ExtensibleURIConverterImpl;
import org.eclipse.emf.ecore.resource.impl.URIHandlerImpl;
import org.eclipse.gendoc.services.AbstractService;
import org.eclipse.gendoc.services.GendocServices;
import org.eclipse.gendoc.services.exception.ElementNotFoundException;
import org.eclipse.gendoc.services.exception.ModelNotFoundException;
import org.eclipse.gendoc.tags.handlers.IContextService;
import org.eclipse.gendoc.tags.handlers.IEMFModelLoaderService;

/**
 * Description of the class Context.
 */
public class ContextService extends AbstractService implements IContextService
{

	protected static List<URIHandler> getURIHandlers() {
		ArrayList<URIHandler> l = new ArrayList<URIHandler>();
		for (URIHandler uriHandler : URIHandler.DEFAULT_HANDLERS) {
			if (uriHandler.getClass() != URIHandlerImpl.class) {
				l.add(uriHandler);
			}
		}
		return l;
	}

	protected static URIConverter uriConverter = new ExtensibleURIConverterImpl(getURIHandlers(), ContentHandler.Registry.INSTANCE.contentHandlers());

    private static final String ELEMENT_DEFAULT_PATH = "{0}";

	/** Delimiter use to separate bundles in bundles declaration. */
    private static String delimiter = "\\s*;\\s*";

    /** The current model (absolute path) used for the next generations. */
    private URI model;

    /** The current element path in the model used for the next generations. */
    private String elementPath = ELEMENT_DEFAULT_PATH;

    /** The current element used for the next generations. */
    private EObject element;

    /** List of the imported bundles used for the next generations. */
    private final List<String> importedBundles;

    /** The label feature of the model elements. */
    private String featureLabel = "name";
    
    /** Defines if the potential multiple metamodels associated to model elements must be searched or not (false by default)*/
    private boolean searchMetamodels = false;

    /**
     * Constructor.
     */
    public ContextService()
    {
        super();
        importedBundles = new LinkedList<String>();
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IService#clear()
     */
    public void clear()
    {
        importedBundles.clear();

    }

    // ////// Getters and setters /////////

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#getModel()
     */
    public EObject getModel() throws ModelNotFoundException
    {
        IEMFModelLoaderService modelLoader = GendocServices.getDefault().getService(IEMFModelLoaderService.class);
        return modelLoader.getModel(model);
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#getModelPath()
     */
    public String getModelPath()
    {
        return model.toString();
    }
    
    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#isSearchMetamodels()
     */
    public boolean isSearchMetamodels()
    {
        return searchMetamodels;
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#setModel(java.lang.String)
     */
    public void setModel(String modelPath) throws ModelNotFoundException
    {
    	modelPath = normalizePath(modelPath);
    	try
        {
            try 
            {
            	model = URI.createURI(modelPath);
            }
            catch (IllegalArgumentException e)
            {
            }
			if (!isValid(model))
			{
				model = URI.createFileURI(modelPath);
			}
			
            // new model = element must be clean
            element = null;
            elementPath = ELEMENT_DEFAULT_PATH;
        }
        catch (IllegalArgumentException e)
        {
            throw new ModelNotFoundException(modelPath);
        }
    }
    
    protected String normalizePath(String path) {
    	path = path.replaceAll("/[^/]+/\\.\\.", "");
    	path = path.replaceAll("/\\./", "");
    	return path;
    }
    
    protected boolean isValid(URI uri) {
    	if (uri != null) {
    		if (uri.scheme() == null || "".equals(uri.scheme())) {
    			return false;
    		}
    		// verify if this is a known scheme
    		for (URIHandler handler : uriConverter.getURIHandlers()) {
    			if (handler.canHandle(uri)) {
    				return true;
    			}
    		}
    		// verify if a protocol is know for this scheme 
    		if (uri.scheme() != null){
    			Object f = Resource.Factory.Registry.INSTANCE.getProtocolToFactoryMap().get(uri.scheme());
    			if (f != null){
    				return true ;
    			}
    		}
    	}
    	return false;
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#getElement()
     */
    public EObject getElement() throws ModelNotFoundException, ElementNotFoundException
    {
        // Load the current element
        if (element == null)
        {
            // Load the current element from the model from the element path
            IEMFModelLoaderService modelLoader = GendocServices.getDefault().getService(IEMFModelLoaderService.class);
            element = modelLoader.getCurrentElement(elementPath, getModel(), 1, featureLabel);
        }
        return element;
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#setElementPath(java.lang.String)
     */
    public void setElementPath(String elementPath)
    {
        this.elementPath = elementPath;
        this.element = null;
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#getImportedBundles()
     */
    public List<String> getImportedBundles()
    {
        return importedBundles;
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#setFeatureLabel(java.lang.String)
     */
    public void setFeatureLabel(String featureLabel)
    {
        this.featureLabel = featureLabel;
    }

    /* (non-Javadoc)
     * @see org.eclipse.gendoc.services.IContextService#setSearchMetamodels(boolean)
     */
    public void setSearchMetamodels(boolean searchMetamodels){
    	this.searchMetamodels = searchMetamodels;
    }
    
    /**
     * The bundles parameters are given as "bundleName1;bundleName2".
     * 
     * @param attributesBundles the attributes bundles
     */
    public void setImportedBundles(String attributesBundles)
    {
        // Old bundles are erased
        importedBundles.clear();

        // Add the new bundles
        String[] bundles = attributesBundles.trim().split(delimiter);
        for (String bundle : bundles)
        {
            importedBundles.add(bundle);
        }
    }

}