Package uk.ac.rdg.resc.edal.dataset.plugins

Class NormalisedDifferencePlugin

java.lang.Object

uk.ac.rdg.resc.edal.dataset.plugins.VariablePlugin

uk.ac.rdg.resc.edal.dataset.plugins.NormalisedDifferencePlugin

public class NormalisedDifferencePlugin
extends VariablePlugin

Field Summary

Fields inherited from class uk.ac.rdg.resc.edal.dataset.plugins.VariablePlugin

prefixLength, uses

Constructor Summary

Constructors

Constructor	Description
NormalisedDifferencePlugin(String xVar, String yVar)

Method Summary

Modifier and Type	Method	Description
protected VariableMetadata[]	doProcessVariableMetadata(VariableMetadata... metadata)	Subclasses should override this method to modify the VariableMetadata tree, and return any new objects added to it.
protected Number	generateValue(String varSuffix, HorizontalPosition pos, Number... sourceValues)	Subclasses should override this method to generate values based on source variable values

Methods inherited from class uk.ac.rdg.resc.edal.dataset.plugins.VariablePlugin

combineIds, generateArray1D, generateArray2D, getFullId, getValue, newVariableMetadataFromDomains, newVariableMetadataFromMetadata, processVariableMetadata, providesVariables, usesVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

NormalisedDifferencePlugin

public NormalisedDifferencePlugin(String xVar,
                                  String yVar)

Method Detail

doProcessVariableMetadata

protected VariableMetadata[] doProcessVariableMetadata(VariableMetadata... metadata)
                                                throws EdalException

Description copied from class: VariablePlugin

Subclasses should override this method to modify the VariableMetadata tree, and return any new objects added to it. This allows subclasses to arbitrarily restructure the metadata tree by calling the VariableMetadata.setParent(VariableMetadata, String) methods. Note that the IDs in the newly-created VariableMetadata objects should be generated by calling VariablePlugin.getFullId(String) with the variable's suffix. If the plugin is designed to group several child variables, the first child will be used to automatically estimate the scale range of the parent. This is guaranteed to only be called once.

Specified by:

doProcessVariableMetadata in class VariablePlugin

Parameters:

metadata - An array of VariableMetadata of the source variables in the order they were supplied to the constructor

Returns:

The derived VariableMetadata

Throws:

EdalException - If there is a problem generating new metadata

generateValue

protected Number generateValue(String varSuffix,
                               HorizontalPosition pos,
                               Number... sourceValues)

Description copied from class: VariablePlugin

Subclasses should override this method to generate values based on source variable values

Specified by:

generateValue in class VariablePlugin

Parameters:

varSuffix - The suffix ID of the variable to generate VariableMetadata for. This will be one of the provided suffixes in the constructor, but not the actual variable ID (which subclasses do not need to worry about)

pos - The HorizontalPosition at which the value is generated. This may affect the returned value

sourceValues - An array of Numbers representing the source values in the order they were supplied to the constructor

Returns:

The derived value