decodes.consumer.TsdbFormatter 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$
 * 
 * Copyright 2017 U.S. Army Corps of Engineers, Hydrologic Engineering Center.
 * 
 * $Log$
 * Revision 1.1  2017/10/10 17:58:02  mmaloney
 * Created.
 *
 */
package decodes.consumer;

import ilex.util.Logger;
import ilex.util.PropertiesUtil;
import ilex.var.IFlags;
import ilex.var.TimedVariable;

import java.text.SimpleDateFormat;
import java.util.Iterator;
import java.util.Properties;
import java.util.TimeZone;

import decodes.db.PresentationGroup;
import decodes.decoder.DecodedMessage;
import decodes.decoder.TimeSeries;
import decodes.util.DecodesSensorCnvt;

/**
 * TsdbFormatter outputs data in the format described for the TsImport program.
 * See the header for decodes.consumer.TsImport for details.
 */
public class TsdbFormatter extends OutputFormatter
{
	private String module = "TsdbFormatter";
	private String timeFormat = "yyyy/MM/dd-HH:mm:ss";
	private TimeZone tz = null;
	private SimpleDateFormat sdf;
	
	@Override
	protected void initFormatter(String type, TimeZone tz, PresentationGroup presGrp, 
		Properties rsProps)
		throws OutputFormatterException
	{
		this.tz = tz;
		String s = PropertiesUtil.getIgnoreCase(rsProps, "timeFormat");
		if (s != null)
			timeFormat = s;
		sdf = new SimpleDateFormat(timeFormat);
		sdf.setTimeZone(tz);
	}

	@Override
	public void shutdown()
	{
	}

	@Override
	public void formatMessage(DecodedMessage msg, DataConsumer consumer)
		throws DataConsumerException,
		OutputFormatterException
	{
		consumer.startMessage(msg);
		
		consumer.println("SET:TZ=" + tz.getID());
		for(Iterator tsit = msg.getAllTimeSeries(); tsit.hasNext(); )
		{
			TimeSeries ts = tsit.next();
			if (ts.size() == 0)
				continue;
			
			ts.sort();
			
			String tsid=null;
			try
			{
				tsid = ((DecodesSensorCnvt)ts.getSensor()).getDbTsId();
			}
			catch(ClassCastException ex)
			{
				Logger.instance().failure(module + 
					" can only be used for extracting data from database.");
				continue;
			}
			
			consumer.println("SET:UNITS=" + ts.getEU().abbr);
			consumer.println("TSID:" + tsid);
			
			for(int idx = 0; idx < ts.size(); idx++)
			{
				TimedVariable tv = ts.sampleAt(idx);
				if ((tv.getFlags() & (IFlags.IS_ERROR|IFlags.IS_MISSING)) != 0)
					continue;
				
				consumer.println(sdf.format(tv.getTime()) + "," +
					ts.formattedSampleAt(idx) + ",0x" + 
					Integer.toHexString(tv.getFlags()));
			}
		}
		
		consumer.endMessage();
	}
}