IOcl2Code.java

/*
Copyright (C) 2008-2010 by Claas Wilke (claaswilke@gmx.net)

This file is part of the OCL 2 Java Code Generator of Dresden OCL2 for Eclipse.

Dresden OCL2 for Eclipse 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.

Dresden OCL2 for Eclipse 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 Dresden OCL2 for Eclipse. If not, see <http://www.gnu.org/licenses/>.
 */
package org.dresdenocl.tools.codegen;

import java.util.List;

import org.dresdenocl.model.IModel;
import org.dresdenocl.pivotmodel.Constraint;
import org.dresdenocl.tools.codegen.exception.Ocl2CodeException;

/**
 * <p>
 * An interface for a OCL2 to code generator which uses an {@link IModel} and
 * its {@link Constraint}s to generate the constraint code.
 * </p>
 * 
 * @author Claas Wilke
 */
public interface IOcl2Code<T extends IOcl2CodeSettings> {

	/**
	 * @return The {@link T} of this {@link IOcl2Code} object.
	 */
	public T getSettings();

	/**
	 * <p>
	 * Sets the {@link T} of this {@link IOcl2Code} object.
	 * </p>
	 * 
	 * @param settings
	 *          The {@link T} to be set.
	 */
	public void setSettings(T settings);

	/**
	 * <p>
	 * Transforms the code fragments for a given {@link List} of
	 * {@link Constraint}s.
	 * </p>
	 * 
	 * @param constraints
	 *          The {@link List} of the {@link Constraint}s whose code fragments
	 *          shall be transformed.
	 * @return A {@link List} containing the transformed fragment code of the
	 *         given {@link Constraint}s.
	 * @throws Ocl2CodeException
	 *           Thrown, if an error during code transformation occurs.
	 */
	public List<String> transformFragmentCode(List<Constraint> constraints)
			throws Ocl2CodeException;

	/**
	 * <p>
	 * Resets the code generators environment. The environment can be used for
	 * code generation specific information such as incremented numbers for file
	 * names or similar information.
	 * </p>
	 */
	public void resetEnvironment();
}