QVTEvaluationOptions.java

/*******************************************************************************
 * Copyright (c) 2008, 2014 Borland Software Corporation and others.
 * 
 * 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:
 *     Borland Software Corporation - initial API and implementation
 *     Christine Gerpheide - bug 432969
 *******************************************************************************/
package org.eclipse.m2m.internal.qvt.oml.evaluator;

import java.util.Collections;
import java.util.List;

import org.eclipse.m2m.qvt.oml.util.ISessionData;
import org.eclipse.m2m.qvt.oml.util.Trace;

public class QVTEvaluationOptions {

	public static final ISessionData.SimpleEntry<Boolean> FLAG_READONLY_GUARD_ENABLED = new ISessionData.SimpleEntry<Boolean>();

	/**
	 * QVTo evaluator's maximum stack depth. Default maximum depth is 1000.
	 */
	public static final ISessionData.SimpleEntry<Integer> EVALUATION_MAX_STACK_DEPTH = new ISessionData.SimpleEntry<Integer>(1000);

	/**
	 * Decorator classes to be used when constructing a QVTo evaluation visitor.
	 * 
	 * <p> Visitor decorators should extend QvtGenericVisitorDecorator. They can be contributed by third parties
	 * by setting this value on the transformation context before executing:
	 * 
	 * <p> <blockquote><pre>
	 * public static class TestQvtGenericVisitorDecorator extends QvtGenericVisitorDecorator {
	 * 
	 *   public TestQvtGenericVisitorDecorator(InternalEvaluator qvtExtVisitor) {
	 *     super(qvtExtVisitor);
	 *   }
	 * 
	 *   public Object visitModule(Module module) {
	 *     //...
	 *     return super.visitModule(module);
	 *   }
	 *   // ...
	 * }
	 * </pre></blockquote>
	 * 
	 * Usage example:
	 * 
	 * <p> <blockquote><pre>
	 * ExecutionContextImpl context = new ExecutionContextImpl();
	 * context.getSessionData().setValue(QVTEvaluationOptions.VISITOR_DECORATORS, Collections.singletonList(TestQvtGenericVisitorDecorator.class));
	 * TransformationExecutor executor = new TransformationExecutor(uri);
	 * ExecutionDiagnostic result = executor.execute(context);
	 * </pre></blockquote>
	 * 
	 * @see org.eclipse.m2m.internal.qvt.oml.ast.env.QvtOperationalEnvFactory#createEvaluationVisitor()
	 */
	public static final ISessionData.SimpleEntry<List<Class<? extends QvtGenericVisitorDecorator>>> VISITOR_DECORATORS = 
			new ISessionData.SimpleEntry<List<Class<? extends QvtGenericVisitorDecorator>>>(
					Collections.<Class<? extends QvtGenericVisitorDecorator>>emptyList());
	
	/**
	 * Traces container which is used for incremental update execution mode. 
	 * <p>When specified the content (returned by Trace.getTraceContent()) is used to find the existing 
	 * relationship between input and output models.
	 * Upon the end of execution the content is replaced with the new traces established during the execution.
	 * 
	 * <p>Usage example:
	 * 
	 * <p> <blockquote><pre>
	 * // Initialize execution context with an empty trace so that upon the first execution it will be filled 
	 * // with the traces information established during the execution.
	 *
	 * ExecutionContextImpl context = new ExecutionContextImpl();
	 * context.getSessionData().setValue(QVTEvaluationOptions.INCREMENTAL_UPDATE_TRACE, Trace.createEmptyTrace());
	 * </pre></blockquote>
	 * 
	 * Usage example:
	 * 
	 * <p> <blockquote><pre>
	 * // Initialize execution context with the existing trace so that execution will be performed in incremental update mode.
	 * // Upon the end of execution the content is replaced with the new traces established during the execution.
	 *
	 * ExecutionContextImpl context = new ExecutionContextImpl();
	 * ResourceSet rs = ..;
	 * Resource traceResource = rs.getResource(traceUri, true);
	 * context.getSessionData().setValue(QVTEvaluationOptions.INCREMENTAL_UPDATE_TRACE, new Trace(traceResource.getContents()));
	 * </pre></blockquote>
	 * 
	 */
	public static final ISessionData.SimpleEntry<Trace> INCREMENTAL_UPDATE_TRACE = new ISessionData.SimpleEntry<Trace>();

	/**
	 * This flag controls the capability to save a QVTO Operational transformation model in textual concrete syntax.
	 * <p>
	 * There are three possible syntaxes for QVTo model interchange (created for example by QVTo transformation):
	 * <ul>
	 * <li/>
	 *  .xmi - model is stored in XMI syntax (by means of org.eclipse.emf.ecore.xmi.XMIResourceImpl)
	 * <li/>
	 *  .qvtox - model is stored in XMI syntax with addition annotations (by means of 
	 *           org.eclipse.m2m.internal.qvt.oml.compiler.ExeXMIResource). 
	 *           These annotations contain compile-time details for the model.
	 * <li>
	 *  .qvto - model is stored in textual concrete syntax (by means of 
	 *          org.eclipse.m2m.internal.qvt.oml.runtime.resource.QvtOperationalResourceImpl).
	 *          This opportunity is enabled by default. In order to disable it one should set FLAG_QVTO_UNPARSE_ENABLED option 
	 *          like:
	 * <p> <blockquote><pre>
	 * ExecutionContextImpl context = new ExecutionContextImpl();
	 * context.getSessionData().setValue(QVTEvaluationOptions.FLAG_QVTO_UNPARSE_ENABLED, Boolean.FALSE);
	 * </pre></blockquote>
	 * 
	 * </ul>
	 * 
	 */
	public static final ISessionData.SimpleEntry<Boolean> FLAG_QVTO_UNPARSE_ENABLED = new ISessionData.SimpleEntry<Boolean>();
	
}