IMetamodelRegistry.java

/**
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright (C) 2007 Matthias Braeuer (braeuer.matthias@web.de).            *
 * All rights reserved.                                                      *
 *                                                                           *
 * This work was done as a project at the Chair for Software Technology,     *
 * Dresden University Of Technology, Germany (http://st.inf.tu-dresden.de).  *
 * It is understood that any modification not identified as such is not      *
 * covered by the preceding statement.                                       *
 *                                                                           *
 * This work is free software; you can redistribute it and/or modify it      *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation; either version 2 of the License, or      *
 * (at your option) any later version.                                       *
 *                                                                           *
 * This work 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 Library General Public     *
 * License for more details.                                                 *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public License *
 * along with this library; if not, you can view it online at                *
 * http://www.fsf.org/licensing/licenses/gpl.html.                           *
 *                                                                           *
 * To submit a bug report, send a comment, or get the latest news on this    *
 * project, please visit the website: http://dresden-ocl.sourceforge.net.    *
 * For more information on OCL and related projects visit the OCL Portal:    *
 * http://st.inf.tu-dresden.de/ocl                                           *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 * $Id$
 */
package org.dresdenocl.model.metamodel;


/**
 * <p>
 * The {@link IMetamodelRegistry} manages a list of {@link IMetamodel}s that are
 * currently available.
 * </p>
 * 
 * @author Matthias Braeuer
 */
public interface IMetamodelRegistry {

	/**
	 * <p>
	 * Adds a {@link IMetamodel} to this {@link IMetamodelRegistry}.
	 * </p>
	 * .
	 * 
	 * @param metamodel
	 *          The {@link IMetamodel} that shall be added.
	 */
	void addMetamodel(IMetamodel metamodel);

	/**
	 * <p>
	 * Disposes this {@link IMetamodelRegistry}.
	 * </p>
	 */
	void dispose();

	/**
	 * <p>
	 * Returns the {@link IMetamodel} with the given id or <code>null</code> if no
	 * {@link IMetamodel} with that id is registered.
	 * </p>
	 * 
	 * @param id
	 *          An identifier for a {@link IMetamodel}.
	 * 
	 * @return An {@link IMetamodel} instance or <code>null</code>.
	 */
	IMetamodel getMetamodel(String id);

	/**
	 * <p>
	 * Returns all {@link IMetamodel}s registered with this
	 * {@link IMetamodelRegistry}.
	 * </p>
	 * 
	 * @return An array of {@link IMetamodel} instances.
	 */
	IMetamodel[] getMetamodels();
}