decodes.consumer.NullFormatter 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$
*
*  $Log$
*  Revision 1.2  2014/05/28 13:09:27  mmaloney
*  dev
*
*  Revision 1.1.1.1  2014/05/19 15:28:59  mmaloney
*  OPENDCS 6.0 Initial Checkin
*
*  Revision 1.1  2008/04/04 18:20:59  cvs
*  Added legacy code to repository
*
*  Revision 1.3  2004/08/24 21:01:37  mjmaloney
*  added javadocs
*
*  Revision 1.2  2004/02/29 20:48:52  mjmaloney
*  Working implementation of DCP Monitor Server
*
*  Revision 1.1  2004/02/19 01:46:43  mjmaloney
*  Added NullFormatter to this package. Used by DCP Monitor app.
*
*/
package decodes.consumer;

import java.util.Properties;

import ilex.util.Logger;

import decodes.db.*;
import decodes.decoder.DecodedMessage;

/**
  NullFormatter is used for consumers that don't want formatted
  data. Rather, they take the DecodedMessage structure in the
  startMessage call directly. The formatter essentially does nothing.
*/
public class NullFormatter extends OutputFormatter
{
	/** default constructor */
	public NullFormatter()
	{
		super();
	}

	/** The NullFormatter requires no initialization and ignores all args.  */
	protected void initFormatter(String type, java.util.TimeZone tz,
		PresentationGroup presGrp, Properties rsProps)
		throws OutputFormatterException
	{
		Logger.instance().info("NullFormatter initializing.");
	}

	/** Does nothing. */
	public void shutdown()
	{
	}

	/**
	  Passes the DecodedMessage to the passed consumer via
	  the startMessage call. No formatting is done.
	 
	  @param msg The message to output.
	  @param consumer The DataConsumer to output to.
	  @throws DataConsumerException, passed through from consumer methods.
	*/
	public void formatMessage(DecodedMessage msg, DataConsumer consumer)
		throws DataConsumerException, OutputFormatterException
	{
		consumer.startMessage(msg);
		consumer.endMessage();
	}

	/**
	  NullFormatter makes no assumptions about what kind of message is
	  requred.
	  @return false to allow any type of message to be processed.
	*/
	public boolean acceptRealDcpMessagesOnly() { return false; }

	/**
	  NullFormatter allows un-decoded, raw messages to pass.
	  @return false to allow un-decoded messages to pass.
	*/
	public boolean requiresDecodedMessage() { return false; }

	@Override
	public boolean usesTZ() { return false; }


}