VariableAccessHelper.java

/**
 * Optimus, framework for Model Transformation
 *
 * Copyright (C) 2013 Worldline or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.
 *
 * This library 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 2.1 of the License.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
package net.atos.optimus.m2m.javaxmi.operation.accesses;

import net.atos.optimus.m2m.javaxmi.operation.variables.VariableDeclarationFragmentBuilder;

import org.eclipse.gmt.modisco.java.SingleVariableAccess;
import org.eclipse.gmt.modisco.java.VariableDeclaration;

/**
 * The purpose of such class is to help with the manipulation of variables
 * 
 * @author tnachtergaele <nachtergaele.thomas@gmail.com>
 * 
 *
 */

public class VariableAccessHelper {

	/** String constant : separator of package chunks */
	public static final String STATIC_VARIABLE_SEPARATOR = ".";

	/**
	 * Create an access to a variable with proxy set to false
	 * 
	 * @param variableName
	 *            the name of the variable which we want an access.
	 * @return an access to the variable with the specified name.
	 */
	public static SingleVariableAccess createVariableAccess(String variableName) {
		return VariableAccessHelper.createVariableAccess(variableName, false);
	}

	/**
	 * Private constructor
	 * 
	 */
	private VariableAccessHelper() {
	}

	/**
	 * Create an access to a variable
	 * 
	 * @param variableName
	 *            the name of the variable which we want an access.
	 * @param isProxy
	 *            the proxy state of the created access to the variable.
	 * @return an access to the variable with the specified name.
	 */
	public static SingleVariableAccess createVariableAccess(String variableName, boolean isProxy) {
		if (variableName.contains(VariableAccessHelper.STATIC_VARIABLE_SEPARATOR)) {
			int index = variableName.lastIndexOf(VariableAccessHelper.STATIC_VARIABLE_SEPARATOR);
			SingleVariableAccess singleVariableAccess = VariableAccessHelper.createVariableAccess(
					variableName.substring(index + 1, variableName.length()), isProxy);
			String variablePrefix = variableName.substring(0, index);
			index = variablePrefix.lastIndexOf(VariableAccessHelper.STATIC_VARIABLE_SEPARATOR) + 1;
			if (Character.isUpperCase(variablePrefix.charAt(index))) {
				singleVariableAccess.setQualifier(TypeAccessHelper.createClassTypeAccess(variablePrefix));
			} else {
				singleVariableAccess.setQualifier(VariableAccessHelper.createVariableAccess(variablePrefix, isProxy));
			}
			return singleVariableAccess;
		}
		VariableDeclaration variableDeclaration = VariableDeclarationFragmentBuilder.builder().setName(variableName)
				.setProxy(isProxy).build();
		return SingleVariableAccessBuilder.builder().setVariable(variableDeclaration).build();
	}

}