java/src/org/eclipse/persistence/tools/oracleddl/test/visit/FunctionTypeTest.java

/*******************************************************************************
 * Copyright (c) 2011 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     David McCann - July 22, 2011 - 2.4 - Initial implementation
 ******************************************************************************/
package org.eclipse.persistence.tools.oracleddl.test.visit;

//javase imports
import java.util.ArrayList;
import java.util.List;

//JUnit4 imports
import org.junit.Test;
import static org.junit.Assert.assertEquals;

//DDL parser imports
import org.eclipse.persistence.tools.oracleddl.metadata.ArgumentType;
import org.eclipse.persistence.tools.oracleddl.metadata.ArgumentTypeDirection;
import org.eclipse.persistence.tools.oracleddl.metadata.FloatType;
import org.eclipse.persistence.tools.oracleddl.metadata.FunctionType;
import org.eclipse.persistence.tools.oracleddl.metadata.VarCharType;
import org.eclipse.persistence.tools.oracleddl.metadata.visit.BaseDatabaseTypeVisitor;

/**
 * Test FunctionType visit method chain.  Ensures that all required 
 * information can be retrieved via FunctionType.accept().
 * 
 * This test covers:
 *  - FunctionType
 *  - DatabaseType
 *  - ProcedureType
 *  - ArgumentType
 *  - ArgumentTypeDirection
 *
 */
public class FunctionTypeTest {
    
    protected static String FUNCTION = "FUNCTION TLUSER.GET_EMP_SALARY (EMP_ID IN VARCHAR) RETURN FLOAT";

    @Test
	public void testFunctionType() {
        // setup FunctionType
        FunctionType function = new FunctionType("GET_EMP_SALARY");
        function.setSchema("TLUSER");
        // add arg "EMP_ID"
        ArgumentType arg = new ArgumentType("EMP_ID");
        arg.setDirection(ArgumentTypeDirection.IN);
        arg.setDataType(new VarCharType());
        function.addCompositeType(arg);
        // set return argument
        arg = new ArgumentType("");
        arg.setDirection(ArgumentTypeDirection.RETURN);
        arg.setDataType(new FloatType());
        function.setReturnArgument(arg);

        // visit
        FunctionTypeVisitor visitor = new FunctionTypeVisitor();
		function.accept(visitor);
		assertEquals("FunctionType test failed:\n" + visitor.toString(), visitor.toString(), FUNCTION);
	}
    
    static class FunctionTypeVisitor extends BaseDatabaseTypeVisitor {
        public String funcName;
        public String schema;
        public List<String> argData = new ArrayList<String>();
        public String returnArg; 
        
        public void beginVisit(FunctionType funcType) {
            funcName = funcType.getProcedureName();
            schema = funcType.getSchema();
            returnArg = funcType.getReturnArgument().getTypeName();
        }
        
        public void beginVisit(ArgumentType argType) {
            if (argType.optional()) {
                argData.add(argType.getArgumentName() + "(opt) " + argType.getDirection() + " " + argType.getDataType());
            } else {
                argData.add(argType.getArgumentName() + " " + argType.getDirection() + " " + argType.getDataType());
            }
        }
       
        public String toString() {
            StringBuilder sb = new StringBuilder("FUNCTION ");
            if (schema != null) {
                sb.append(schema);
                sb.append(".");
            }
            sb.append(funcName);
            sb.append(" (");
            for(int i=0; i<argData.size();) {
                String arg = argData.get(i);
                sb.append(arg);
                if (++i < argData.size()) {
                    sb.append(", ");
                }
            }
            sb.append(") RETURN ");
            sb.append(returnArg);
            return sb.toString();
        }
    }

}