org.eclipse.ocl.expressions.operations.IterateExpOperations Maven / Gradle / Ivy

Go to download
/**
 * 
 * 
 * Copyright (c) 2008 IBM Corporation, Zeligsoft Inc., 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:
 *   IBM - Initial API and implementation
 *   Zeligsoft - Bug 207365
 * 
 * 
 *
 * $Id: IterateExpOperations.java,v 1.3 2008/10/12 01:09:49 cdamus Exp $
 */
package org.eclipse.ocl.expressions.operations;

import java.util.Map;

import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.DiagnosticChain;

import org.eclipse.ocl.Environment;
import org.eclipse.ocl.expressions.IterateExp;
import org.eclipse.ocl.expressions.OCLExpression;
import org.eclipse.ocl.expressions.Variable;

import org.eclipse.ocl.expressions.util.ExpressionsValidator;
import org.eclipse.ocl.internal.l10n.OCLMessages;
import org.eclipse.ocl.util.OCLUtil;
import org.eclipse.ocl.util.TypeUtil;

/**
 * 
 * A static utility class that provides operations related to 'Iterate Exp' model objects.
 * 
 *
 * 
 * The following operations are supported:
 * 

 *   {@link org.eclipse.ocl.expressions.IterateExp#checkIterateType(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Check Iterate Type}
 *   {@link org.eclipse.ocl.expressions.IterateExp#checkBodyType(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Check Body Type}
 *   {@link org.eclipse.ocl.expressions.IterateExp#checkResultInit(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Check Result Init}
 * 
 * 
 *
 * @generated
 */
public class IterateExpOperations
		extends LoopExpOperations {

	/**
	 * 
	 * 
	 * @generated
	 */
	protected IterateExpOperations() {
		super();
	}

	/**
	 * 
	 * 
	 * 
	 * type = result.type
	 * @param iterateExp The receiving 'Iterate Exp' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated NOT
	 */
	public static  boolean checkIterateType(
			IterateExp iterateExp, DiagnosticChain diagnostics,
			Map context) {
		boolean result = true;
		String message = null;
		Environment env = OCLUtil
			.getValidationEnvironment(iterateExp, context);

		Variable vd = iterateExp.getResult();
		C type = iterateExp.getType();

		if ((vd != null) && (type != null) && (vd.getType() != null)) {
			if (!TypeUtil.exactTypeMatch(env, type, vd.getType())) {
				result = false;
				message = OCLMessages.bind(
					OCLMessages.TypeConformanceIterateExp_ERROR_, iterateExp
						.toString());
			}
		}

		if (!result) {
			if (diagnostics != null) {
				diagnostics.add(new BasicDiagnostic(Diagnostic.ERROR,
					ExpressionsValidator.DIAGNOSTIC_SOURCE,
					ExpressionsValidator.ITERATE_EXP__ITERATE_TYPE, message,
					new Object[]{iterateExp}));
			}
		}
		return result;
	}

	/**
	 * 
	 * 
	 * 
	 * body.type.conformsTo(result.type)
	 * @param iterateExp The receiving 'Iterate Exp' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated NOT
	 */
	public static  boolean checkBodyType(IterateExp iterateExp,
			DiagnosticChain diagnostics, Map context) {
		boolean result = true;
		String message = null;
		Environment env = OCLUtil
			.getValidationEnvironment(iterateExp, context);

		Variable vd = iterateExp.getResult();
		OCLExpression body = iterateExp.getBody();

		if ((vd != null) && (body != null) && (vd.getType() != null)
			&& (body.getType() != null)) {
			if (!TypeUtil
				.compatibleTypeMatch(env, body.getType(), vd.getType())) {
				result = false;
				message = OCLMessages.bind(
					OCLMessages.TypeConformanceIterateExpBody_ERROR_,
					iterateExp.toString());
			}
		}

		if (!result) {
			if (diagnostics != null) {
				diagnostics.add(new BasicDiagnostic(Diagnostic.ERROR,
					ExpressionsValidator.DIAGNOSTIC_SOURCE,
					ExpressionsValidator.ITERATE_EXP__BODY_TYPE, message,
					new Object[]{iterateExp}));
			}
		}
		return result;
	}

	/**
	 * 
	 * 
	 * 
	 * self.result.initExpression->size() = 1
	 * @param iterateExp The receiving 'Iterate Exp' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated NOT
	 */
	public static  boolean checkResultInit(IterateExp iterateExp,
			DiagnosticChain diagnostics, Map context) {
		boolean result = true;
		String message = null;

		Variable vd = iterateExp.getResult();

		if ((vd != null) && (vd.getInitExpression() == null)) {
			result = false;
			message = OCLMessages
				.bind(OCLMessages.MissingInitIterateExp_ERROR_, iterateExp
					.toString());
		}

		if (!result) {
			if (diagnostics != null) {
				diagnostics.add(new BasicDiagnostic(Diagnostic.ERROR,
					ExpressionsValidator.DIAGNOSTIC_SOURCE,
					ExpressionsValidator.ITERATE_EXP__RESULT_INIT, message,
					new Object[]{iterateExp}));
			}
		}
		return result;
	}

} // IterateExpOperations