svn commit: r513807 - in /jakarta/jmeter/branches/rel-2-2: src/functions/org/apache/jmeter/functions/Variable.java xdocs/usermanual/functions.xml

[se...@apache.org]

Author: sebb
Date: Fri Mar  2 07:26:11 2007
New Revision: 513807

URL: http://svn.apache.org/viewvc?view=rev&rev=513807
Log:
Added __V variable function to resolve nested variable names
[Forgot to add new file last time; added example]

Added:
    jakarta/jmeter/branches/rel-2-2/src/functions/org/apache/jmeter/functions/Variable.java
Modified:
    jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/functions.xml

Added: jakarta/jmeter/branches/rel-2-2/src/functions/org/apache/jmeter/functions/Variable.java
URL: http://svn.apache.org/viewvc/jakarta/jmeter/branches/rel-2-2/src/functions/org/apache/jmeter/functions/Variable.java?view=auto&rev=513807
==============================================================================
--- jakarta/jmeter/branches/rel-2-2/src/functions/org/apache/jmeter/functions/Variable.java (added)
+++ jakarta/jmeter/branches/rel-2-2/src/functions/org/apache/jmeter/functions/Variable.java Fri Mar  2 07:26:11 2007
@@ -0,0 +1,93 @@
+/*
+ * 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 org.apache.jmeter.functions;
+
+import java.io.Serializable;
+import java.util.Collection;
+import java.util.LinkedList;
+import java.util.List;
+
+import org.apache.jmeter.engine.util.CompoundVariable;
+import org.apache.jmeter.samplers.SampleResult;
+import org.apache.jmeter.samplers.Sampler;
+import org.apache.jmeter.util.JMeterUtils;
+
+/**
+ * Function to get a JMeter Variable
+ * 
+ * Parameters: 
+ * - variable name
+ * 
+ * Returns: 
+ * - the variable value, but if not found 
+ * - the variable name itself
+ * 
+ * @version $Revision: 493781 $ Updated: $Date: 2007-01-07 17:52:05 +0000 (Sun, 07 Jan 2007) $
+ */
+public class Variable extends AbstractFunction implements Serializable {
+
+	private static final List desc = new LinkedList();
+
+	private static final String KEY = "__V";
+
+	// Number of parameters expected - used to reject invalid calls
+	private static final int MIN_PARAMETER_COUNT = 1;
+	private static final int MAX_PARAMETER_COUNT = 1;
+	
+	static {
+		desc.add(JMeterUtils.getResString("variable_name_param"));
+	}
+
+	private Object[] values;
+
+	public Variable() {
+	}
+
+	public Object clone() {
+		return new Variable();
+	}
+
+	public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
+			throws InvalidVariableException {
+		String variableName = ((CompoundVariable) values[0]).execute();
+		String variableValue = getVariables().get(variableName);
+		return variableValue == null? variableName : variableValue;
+
+	}
+
+	public void setParameters(Collection parameters) throws InvalidVariableException {
+
+		values = parameters.toArray();
+
+		if ((values.length < MIN_PARAMETER_COUNT) || (values.length > MAX_PARAMETER_COUNT)) {
+			throw new InvalidVariableException("Parameter Count not between " + MIN_PARAMETER_COUNT + " & "
+					+ MAX_PARAMETER_COUNT);
+		}
+
+	}
+
+	public String getReferenceKey() {
+		return KEY;
+	}
+
+	public List getArgumentDesc() {
+		return desc;
+	}
+
+}
\ No newline at end of file

Modified: jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/functions.xml
URL: http://svn.apache.org/viewvc/jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/functions.xml?view=diff&rev=513807&r1=513806&r2=513807
==============================================================================
--- jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/functions.xml (original)
+++ jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/functions.xml Fri Mar  2 07:26:11 2007
@@ -703,7 +703,14 @@
 <component index="&sect-num;.5.19" name="__V">
 <description>
 	<p>The V (variable) function returns the result of evaluating a variable name expression.
+	This can be used to evaluate nested variable references (which are not currently supported).
 	</p>
+	<p>For example, if one has variables A1,A2 and N=1:</p>
+	<ul>
+	<li>${A1} - works OK</li>
+	<li>${A${N}} - does not work (nested variable reference)</li>
+	<li>${__V(A${N})} - works OK. A${N} becomes A1, and the __V function returns the value of A1</li>
+	</ul>
 	</description>
 
 <properties>



---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org