decodes.hdb.algo.CallProcAlg Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendcs Show documentation
A collection of software for aggregatting and processing environmental data such as from NOAA GOES satellites.
The newest version!
package decodes.hdb.algo;

import java.util.Date;

import ilex.var.NamedVariableList;
import ilex.var.NamedVariable;
import decodes.tsdb.DbAlgorithmExecutive;
import decodes.tsdb.DbCompException;
import decodes.tsdb.DbIoException;
import decodes.tsdb.VarFlags;
// this new import was added by M. Bogner Aug 2012 for the 3.0 CP upgrade project
import decodes.tsdb.algo.AWAlgoType;


//AW:IMPORTS
import decodes.hdb.dbutils.*;
import decodes.hdb.HdbFlags;
import java.sql.Connection;
import java.text.SimpleDateFormat;

//AW:IMPORTS_END

//AW:JAVADOC
/**
Takes up to 5 input values labeled input1 ... input5.
the callproc property will have all the proper procedure call elements already established
so all this program has to do is call the procedure
the <>... <> and <<,tsbt>> can be used if you want to use the procedure call dynamic
 */
//AW:JAVADOC_END
public class CallProcAlg extends decodes.tsdb.algo.AW_AlgorithmBase
{
//AW:INPUTS
	public double input1;	//AW:TYPECODE=i
	public double input2;	//AW:TYPECODE=i
	public double input3;	//AW:TYPECODE=i
	public double input4;	//AW:TYPECODE=i
	public double input5;	//AW:TYPECODE=i
	String _inputNames[] = { "input1", "input2", "input3", "input4", "input5" };
//AW:INPUTS_END

//AW:LOCALVARS
        Connection conn = null;
        boolean do_setoutput = true;

//AW:LOCALVARS_END

//AW:OUTPUTS
	public NamedVariable output = new NamedVariable("output", 0);
	String _outputNames[] = { "output" };
//AW:OUTPUTS_END

//AW:PROPERTIES
	public String input1_MISSING = "ignore";
	public String input2_MISSING = "ignore";
	public String input3_MISSING = "ignore";
	public String input4_MISSING = "ignore";
	public String input5_MISSING = "ignore";
        public String proccall = "";
 
	String _propertyNames[] = { "proccall", "input1_MISSING", "input2_MISSING", "input3_MISSING", "input4_MISSING", "input5_MISSING" };
//AW:PROPERTIES_END

	// Allow javac to generate a no-args constructor.

	/**
	 * Algorithm-specific initialization provided by the subclass.
	 */
	protected void initAWAlgorithm( )
	{
//AW:INIT
		_awAlgoType = AWAlgoType.TIME_SLICE;
//AW:INIT_END

//AW:USERINIT
//AW:USERINIT_END
	}
	
	/**
	 * This method is called once before iterating all time slices.
	 */
	protected void beforeTimeSlices()
	{
//AW:BEFORE_TIMESLICES
//AW:BEFORE_TIMESLICES_END
	}

	/**
	 * Do the algorithm for a single time slice.
	 * AW will fill in user-supplied code here.
	 * Base class will set inputs prior to calling this method.
	 * User code should call one of the setOutput methods for a time-slice
	 * output variable.
	 *
	 * @throw DbCompException (or subclass thereof) if execution of this
	 *        algorithm is to be aborted.
	 */
	protected void doAWTimeSlice()
		throws DbCompException
	{
//AW:TIMESLICE
	   SimpleDateFormat sdf = new SimpleDateFormat("dd-MMM-yyyy HH:mm");
           String new_proccall = proccall.replaceAll("<>",tsbt_time);
		if (!isMissing(input1))
		{
			new_proccall = new_proccall.replaceAll("<>",(Double.valueOf(input1)).toString());
		}
		if (!isMissing(input2))
		{
			new_proccall = new_proccall.replaceAll("<>",(Double.valueOf(input2)).toString());
		}
		if (!isMissing(input3))
		{
			new_proccall = new_proccall.replaceAll("<>",(Double.valueOf(input3)).toString());
		}
		if (!isMissing(input4))
		{
			new_proccall = new_proccall.replaceAll("<>",(Double.valueOf(input4)).toString());
		}
		if (!isMissing(input5))
		{
			new_proccall = new_proccall.replaceAll("<>",(Double.valueOf(input5)).toString());
		}
		debug3("doAWTimeSlice input1=" + input1 +", input2=" + input2);

		do_setoutput = true;
		if (do_setoutput)
		//           Then continue with the calling of the Procedure
        {
             // get the connection and a few other classes so we can do some sql
             conn = tsdb.getConnection();
             DBAccess db = new DBAccess(conn);
             DataObject dbobj = new DataObject();
             String dt_fmt = "dd-MMM-yyyy HH:mm";
             // now do the procedure call with all the needed data
             db.callProc(new_proccall,dbobj);
             debug3(" Proc Call  STRING:" + new_proccall + "   DBOBJ: " + dbobj.toString() );
	    }

// 	    procedure call is expected to do everything so just return
            return;
//
//AW:TIMESLICE_END
	}

	/**
	 * This method is called once after iterating all time slices.
	 */
	protected void afterTimeSlices()
	{
//AW:AFTER_TIMESLICES
//AW:AFTER_TIMESLICES_END
	}

	/**
	 * Required method returns a list of all input time series names.
	 */
	public String[] getInputNames()
	{
		return _inputNames;
	}

	/**
	 * Required method returns a list of all output time series names.
	 */
	public String[] getOutputNames()
	{
		return _outputNames;
	}

	/**
	 * Required method returns a list of properties that have meaning to
	 * this algorithm.
	 */
	public String[] getPropertyNames()
	{
		return _propertyNames;
	}
}