decodes.decoder.TimeTruncateOperation 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!
/*
*  $Id$
*/
package decodes.decoder;

import java.util.Calendar;
import java.util.Date;
import java.util.StringTokenizer;

import ilex.util.ArrayUtil;
import ilex.util.Logger;
import ilex.var.Variable;

import decodes.db.*;

/**
TimeTruncateOperation operation:
t(m) means to truncate to previous minute.
t(m30) means to truncate to previous 30-minute interval
t(m15) means to truncate to previous 15-minute, interval, etc.
t(h) means to truncate to the previous hour.
*/
class TimeTruncateOperation extends DecodesOperation
{
	private char truncArg = 'm';     // Truncate minutes by default.
	private int count = 1;

	public char getType() { return 't'; }

	/**
	  Constructor.
	  @param  args complete string inside the parens
	  @throws ScriptFormatException if syntax error detected in arguments
	*/
	public TimeTruncateOperation(String args)
		throws ScriptFormatException
	{
		super(1);

		if (args == null || args.trim().length() == 0)
			truncArg = 'm';
		else
		{
			args = args.toLowerCase().trim();
			char c = args.charAt(0);
			if (c == 'm' || c == 'h')
				truncArg = c;
			else
				throw new ScriptFormatException(
					"Unrecognized argument time-truncate operation '"
					+ args + "'");
			if (args.length() > 1 && Character.isDigit(args.charAt(1)))
			{
				try { count = Integer.parseInt(args.substring(1)); }
				catch(NumberFormatException ex)
				{
					Logger.instance().warning("Bad count in time-truncate operator arg '" + args + "' -- ignored.");
					count = 1;
				}
			}
		}
	}

	/**
	  Truncates the current time in the decoded message by the specified
	  amount.
	  The very first call within a given message will truncate both the
	  message time and the current data-time stamp. Subsequent calls will
	  only truncate the data time.
	  @param dd holds the raw data and context.
	  @param msg store decoded values here.
	  @throws DecoderException or subclass if error detected.
	*/
	public void execute(DataOperations dd, DecodedMessage msg) 
		throws DecoderException
	{
		Date messageTime = msg.getMessageTime();
		RecordedTimeStamp rts = msg.getTimer();
		Logger.instance().debug3("Executing Time Trunc(" + truncArg +
			(count==1?"":""+count) + ") messageTime=" + messageTime
			+ ", dataTime=" + new Date(rts.getMsec()));
		if (!msg.timeWasTruncated)
		{
			long mmsec = messageTime.getTime();
			long sub = (truncArg == 'h')
				? (mmsec % 3600000L) : (mmsec % (60000L*count));
			mmsec -= sub;
			msg.truncateTime(new Date(mmsec));
			Logger.instance().debug3("   Message time truncated to " + messageTime);
		}
		rts.setSecond(0);
		if (truncArg == 'h')
			rts.setMinute(0);
		else if (count > 1)
			rts.setMinute(rts.getMinute() - (rts.getMinute()%count));
		Logger.instance().debug3("   Data Time Stamp truncated to " + new Date(rts.getMsec()));
	}
}