com.ats.generator.variables.Variable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ats-automated-testing Show documentation
Code generator library to create and execute GUI automated tests
The newest version!
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/

package com.ats.generator.variables;

import java.util.ArrayList;

import com.ats.executor.ActionTestScript;
import com.ats.generator.variables.transform.Transformer;

public class Variable implements Comparable{

	public static final String SCRIPT_LABEL = "var";
	public static final String VAR_FIXED = "var-x";
	public static final int SCRIPT_LABEL_LENGTH = SCRIPT_LABEL.length();

	private boolean calculation = true;
	private String name = "";

	private CalculatedValue value;
	private Transformer transformation;
	private String data = null;
	private boolean fixed = false;

	public Variable() {}

	public Variable(String name, CalculatedValue value) {
		this.setName(name);
		this.setValue(value);
	}

	public Variable(ActionTestScript script, String variablePath) {
		this.setName(name);
		this.setValue(new CalculatedValue(script, ""));
	}
	
	public Variable(String name, CalculatedValue value, Transformer transformer) {
		this.setName(name);
		this.setValue(value);
		this.setTransformation(transformer);
	}

	public Variable(String name, CalculatedValue value, Transformer transformer, boolean fixed) {
		this.setName(name);
		this.setValue(value);
		this.setTransformation(transformer);
		this.setFixed(fixed);
	}

	@Override
	public String toString() {
		return getCalculatedValue();
	}

	public String getCalculatedValue() {
		String result = data;
		if(result == null) {
			result = value.getCalculated();
		}
		return getTransformation().format(result);
	}
	
	public void setCalculatedValue(String value) {
		//Read only property
	}

	public void setData(String value) {
		data = value;
	}

	public ArrayList getKeywords() {
		final ArrayList keywords = new ArrayList<>();
		keywords.add(name);
		keywords.add(value.getKeywords());
		return keywords;
	}
	
	public void clean() {
		value.setCalculated("");
	}

	//----------------------------------------------------------------------------------------------------------------------------

	@Override
	public int compareTo(Variable variable) {
		return Boolean.valueOf(isCalculation()).compareTo(Boolean.valueOf(variable.isCalculation()));
	}

	public boolean equals(CalculatedValue clv) {
		return clv.getCalculated().equals(getCalculatedValue());
	}

	//---------------------------------------------------------------------------------------------------------------------------------
	// Code Generator
	//---------------------------------------------------------------------------------------------------------------------------------

	public String getJavaCode(){

		final String varName = getName();
		final StringBuilder codeBuilder = new StringBuilder(this.getClass().getName());
		codeBuilder.append(" ");
		codeBuilder.append(varName);
		codeBuilder.append(" = ");
		codeBuilder.append(ActionTestScript.JAVA_VAR_FUNCTION_NAME);
		codeBuilder.append("(\"");
		codeBuilder.append(varName);
		codeBuilder.append("\"");

		if(isCalculation()) {
			codeBuilder.append(", ");
			codeBuilder.append(value.getJavaCode());
		}

		//if(transformation != null) {
			//codeBuilder.append(", ");
			codeBuilder.append(getTransformation().getJavaCode());
		//}
		codeBuilder.append(")");

		return codeBuilder.toString();
	}

	//--------------------------------------------------------
	// getters and setters for serialization
	//--------------------------------------------------------

	public String getName() {
		return name;
	}

	public void setName(String value) {
		this.name = value;
	}

	public CalculatedValue getValue() {
		return value;
	}

	public void setValue(CalculatedValue value) {
		this.value = value;
	}

	public Transformer getTransformation() {
		if(transformation == null) {
			transformation = new Transformer();
		}
		return transformation;
	}

	public void setTransformation(Transformer value) {
		this.transformation = value;
	}

	public boolean isCalculation() {
		return calculation;
	}

	public void setCalculation(boolean value) {
		this.calculation = value;
	}
		
	public boolean isFixed() {
		return fixed;
	}

	public void setFixed(boolean fixed) {
		this.fixed = fixed;
	}

}