org.mbari.jddac
Class CoallateByMeasurementNameFunction

java.lang.Object
  org.mbari.jddac.CoallateByMeasurementNameFunction

All Implemented Interfaces:

IFunction

public class CoallateByMeasurementNameFunction
extends java.lang.Object
implements IFunction

Takes a ArgArray of Records and coallates by Measurement Name.

Field Summary

Fields inherited from interface org.mbari.jddac.IFunction

KEY, OPID_IN, OPID_OUT

Constructor Summary

CoallateByMeasurementNameFunction()

Method Summary

net.java.jddac.common.type.ArgArray

execute(net.java.jddac.common.type.ArgArray argArray) The

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoallateByMeasurementNameFunction

public CoallateByMeasurementNameFunction()

Method Detail

execute

public net.java.jddac.common.type.ArgArray execute(net.java.jddac.common.type.ArgArray argArray)

The

Specified by:

execute in interface IFunction

Parameters:

argArray -

a ArgArray of JDDAC Records containing Measurements. An values that are not Measurements are ignored.

   ArgArray {
      "RecordKey-1": Record {
      "RecordKey-2": Record
   }
 

Returns:

An ArgArray with the measurements coallated by MeasurementName. e.g.

   ArgArray {
      "MeasurementName-1" : ArgArray {
         "RecordKey-1" : Measurement
         "RecordKey-2" : Measurement
      }
      "MeasurementName-2" : ArgArray {
         "RecordKey-1" : Measurement
         "RecordKey-2" : Measurement
      }
   }
 

Where: MeasurementName = the common name that a bunch of Measurements share. This name is used to coallate the Measurements RecordKey = The Key used to store the Record the Measurement was contained in.