Package adams.data.multireportfilter

Class PullUpFields

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.multireportfilter.AbstractMultiSpectrumReportFilter

adams.data.multireportfilter.PullUpFields

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<AbstractMultiSpectrumReportFilter>, adams.core.SizeOfHandler, Serializable, Comparable

public class PullUpFields
extends AbstractMultiSpectrumReportFilter

Distributes the sample data among all the sub-spectra, never overwrites already existing values.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-field <knir.data.sampledata.Field> [-field ...] (property: fields)
    The fields to pull up from the sub-reports and store in the top-level one.
    default: 
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.data.report.Field[]	m_Fields	the fields to pull up from the sub-spectra and place in the top-level report.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
PullUpFields()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	fieldsTipText()	Returns the tip text for this property.
adams.data.report.Field[]	getFields()	Returns the fields to pull up.
String	globalInfo()	Returns a string describing the object.
protected MultiSpectrum	processData(MultiSpectrum data)	Performs the actual filtering.
void	setFields(adams.data.report.Field[] value)	Sets the fields to pull up.

Methods inherited from class adams.data.multireportfilter.AbstractMultiSpectrumReportFilter

checkData, cleanUp, compareTo, destroy, equals, filter, forCommandLine, forName, getFilters, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Fields

protected adams.data.report.Field[] m_Fields

the fields to pull up from the sub-spectra and place in the top-level report.

Constructor Detail

PullUpFields

public PullUpFields()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setFields

public void setFields(adams.data.report.Field[] value)

Sets the fields to pull up.

Parameters:

value - the fields

getFields

public adams.data.report.Field[] getFields()

Returns the fields to pull up.

Returns:

the fields

fieldsTipText

public String fieldsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

processData

protected MultiSpectrum processData(MultiSpectrum data)

Performs the actual filtering.

Specified by:

processData in class AbstractMultiSpectrumReportFilter

Parameters:

data - the data to filter

Returns:

the filtered data, null if failed to generate output