Work in progress with functions/procedures input/output metadata.

Author: asfernandes

src/fbjava-tests/src/main/java/example/Functions.java

@@ -30,6 +30,7 @@
 import java.sql.SQLException;
 import java.sql.Statement;
 
+import org.firebirdsql.fbjava.CallableRoutineContext;
 import org.firebirdsql.fbjava.Context;
 import org.firebirdsql.fbjava.FunctionContext;
 
@@ -259,4 +260,10 @@ public static String f27()
 		Context context = Context.get();
 		return context.getBody();
 	}
+
+	public static String f28(int i1, int i2)
+	{
+		CallableRoutineContext context = CallableRoutineContext.get();
+		return context.getInputMetadata().getCount() + ", " + context.getOutputMetadata().getCount();
+	}
 }

src/fbjava-tests/src/main/java/example/Procedures.java

@@ -18,7 +18,9 @@
  */
 package example;
 
+import org.firebirdsql.fbjava.CallableRoutineContext;
 import org.firebirdsql.fbjava.ExternalResultSet;
+import org.firebirdsql.fbjava.ValuesMetadata;
 
 
 public class Procedures
@@ -117,4 +119,20 @@ public void close()
 			}
 		};
 	}
+
+	public static void p8(int i1, int i2, String[] o1, int[] o2, int[] o3)
+	{
+		CallableRoutineContext context = CallableRoutineContext.get();
+		o1[0] = context.getInputMetadata().getCount() + ", " + context.getOutputMetadata().getCount();
+	}
+
+	public static void p9(int i1, Integer i2, String[] o1)
+	{
+		CallableRoutineContext context = CallableRoutineContext.get();
+		ValuesMetadata input = context.getInputMetadata();
+		ValuesMetadata output = context.getOutputMetadata();
+
+		o1[0] = input.getJavaClass(0).toString() + ", " + input.getJavaClass(1).toString() + ", " +
+			output.getJavaClass(0).toString();
+	}
 }

src/fbjava/src/main/java/org/firebirdsql/fbjava/CallableRoutineContext.java

@@ -39,4 +39,15 @@ public static CallableRoutineContext get()
 	 * For unpackaged routines, return null.
 	 */
 	public String getPackageName();
+
+	/**
+	 * Gets the input values metadata.
+	 */
+	public ValuesMetadata getInputMetadata();
+
+	/**
+	 * Gets the output values metadata.
+	 * For functions, it always returns a ValuesMetadata with a single entry.
+	 */
+	public ValuesMetadata getOutputMetadata();
 }

src/fbjava/src/main/java/org/firebirdsql/fbjava/ValuesMetadata.java

@@ -0,0 +1,40 @@
+/*
+ * FB/Java plugin
+ *
+ * Distributable under LGPL license.
+ * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
+ *
+ * This program 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
+ * LGPL License for more details.
+ *
+ * This file was created by members of the Firebird development team.
+ * All individual contributions remain the Copyright (C) of those
+ * individuals.  Contributors to this file are either listed here or
+ * can be obtained from a git log command.
+ *
+ * All rights reserved.
+ */
+package org.firebirdsql.fbjava;
+
+
+/**
+ * This interface represents a Firebird Values (set of input/output parameters or trigger's old/new fields) metadata.
+ *
+ * @author <a href="mailto:adrianosf@gmail.com">Adriano dos Santos Fernandes</a>
+ */
+public interface ValuesMetadata
+{
+	/**
+	 * Gets the number of values.
+	 */
+	public int getCount();
+
+	/**
+	 * Gets the Java Class for a given value index.
+	 */
+	public Class<?> getJavaClass(int index);
+
+	//// TODO: more methods
+}

src/fbjava/src/main/java/org/firebirdsql/fbjava/impl/CallableRoutineContextImpl.java

@@ -19,6 +19,7 @@
 package org.firebirdsql.fbjava.impl;
 
 import org.firebirdsql.fbjava.CallableRoutineContext;
+import org.firebirdsql.fbjava.ValuesMetadata;
 
 
 abstract class CallableRoutineContextImpl extends ContextImpl implements CallableRoutineContext
@@ -35,4 +36,16 @@ public String getPackageName()
 	{
 		return internalContext.getRoutine().packageName;
 	}
+
+	@Override
+	public ValuesMetadata getInputMetadata()
+	{
+		return internalContext.getRoutine().inputMetadata;
+	}
+
+	@Override
+	public ValuesMetadata getOutputMetadata()
+	{
+		return internalContext.getRoutine().outputMetadata;
+	}
 }

src/fbjava/src/main/java/org/firebirdsql/fbjava/impl/ExternalEngine.java

@@ -1155,8 +1155,7 @@ private Routine getRoutine(IStatus status, IExternalContext context, IRoutineMet
 			Class<?> clazz = runInClassLoader(status, context, className, methodName,
 				() -> Class.forName(className, true, sharedData.classLoader));
 
-			Routine routine = new Routine(type, this, metadata.getName(status), metadata.getPackage(status),
-				metadata.getBody(status));
+			Routine routine = new Routine(status, metadata, this, type);
 			ArrayList<Class<?>> paramTypes = new ArrayList<>();
 
 			int[] pos = {paramsStart + 1};
@@ -1279,8 +1278,11 @@ else if (pos[0] != entryPoint.length())
 							break;
 					}
 
-					routine.setupParameters(status, routine.inputParameters, inMetadata, inBuilder);
-					routine.setupParameters(status, routine.outputParameters, outMetadata, outBuilder);
+					routine.setupParameters(status, routine.inputParameters, routine.inputMetadata,
+						inMetadata, inBuilder);
+
+					routine.setupParameters(status, routine.outputParameters, routine.outputMetadata,
+						outMetadata, outBuilder);
 				}
 				finally
 				{

src/fbjava/src/main/java/org/firebirdsql/fbjava/impl/Routine.java

@@ -25,6 +25,7 @@
 import org.firebirdsql.fbjava.impl.FbClientLibrary.IExternalContext;
 import org.firebirdsql.fbjava.impl.FbClientLibrary.IMessageMetadata;
 import org.firebirdsql.fbjava.impl.FbClientLibrary.IMetadataBuilder;
+import org.firebirdsql.fbjava.impl.FbClientLibrary.IRoutineMetadata;
 import org.firebirdsql.fbjava.impl.FbClientLibrary.IStatus;
 
 import com.sun.jna.Pointer;
@@ -48,18 +49,21 @@ static enum Type
 	Method method;
 	final List<Parameter> inputParameters = new ArrayList<>();
 	final List<Parameter> outputParameters = new ArrayList<>();
+	final ValuesMetadataImpl inputMetadata = new ValuesMetadataImpl();
+	final ValuesMetadataImpl outputMetadata = new ValuesMetadataImpl();
 
-	Routine(Type type, ExternalEngine engine, String objectName, String packageName, String body)
+	Routine(IStatus status, IRoutineMetadata metadata, ExternalEngine engine, Type type) throws FbException
 	{
-		this.type = type;
 		this.engine = engine;
-		this.objectName = objectName;
-		this.packageName = packageName;
-		this.body = body;
+		this.type = type;
+
+		objectName = metadata.getName(status);
+		packageName = metadata.getPackage(status);
+		body = metadata.getBody(status);
 	}
 
-	void setupParameters(IStatus status, List<Parameter> parameters, IMessageMetadata metadata,
-		IMetadataBuilder builder) throws FbException
+	void setupParameters(IStatus status, List<Parameter> parameters, ValuesMetadataImpl valuesMetadata,
+		IMessageMetadata metadata, IMetadataBuilder builder) throws FbException
 	{
 		for (int i = 0; i < parameters.size(); ++i)
 		{
@@ -78,6 +82,8 @@ void setupParameters(IStatus status, List<Parameter> parameters, IMessageMetadat
 				parameter.offset = builtMetadata.getOffset(status, i);
 				parameter.length = builtMetadata.getLength(status, i);
 			}
+
+			valuesMetadata.setup(parameters);
 		}
 		finally
 		{

src/fbjava/src/main/java/org/firebirdsql/fbjava/impl/ValuesMetadataImpl.java

@@ -0,0 +1,58 @@
+/*
+ * FB/Java plugin
+ *
+ * Distributable under LGPL license.
+ * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
+ *
+ * This program 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
+ * LGPL License for more details.
+ *
+ * This file was created by members of the Firebird development team.
+ * All individual contributions remain the Copyright (C) of those
+ * individuals.  Contributors to this file are either listed here or
+ * can be obtained from a git log command.
+ *
+ * All rights reserved.
+ */
+package org.firebirdsql.fbjava.impl;
+
+import java.util.List;
+
+import org.firebirdsql.fbjava.ValuesMetadata;
+
+
+final class ValuesMetadataImpl implements ValuesMetadata
+{
+	private List<Parameter> parameters;
+	private int count;
+
+	void setup(List<Parameter> parameters)
+	{
+		this.parameters = parameters;
+		count = parameters.size();
+	}
+
+	@Override
+	public int getCount()
+	{
+		return count;
+	}
+
+	@Override
+	public Class<?> getJavaClass(int index)
+	{
+		checkIndex(index);
+		return parameters.get(index).javaClass;
+	}
+
+	private void checkIndex(int index)
+	{
+		if (index < 0 || index >= count)
+		{
+			throw new IndexOutOfBoundsException(
+				String.format("ValuesMetadata index out of bounds: Index: %d, Size: %d", index, count));
+		}
+	}
+}