uk.ac.starlink.ttools.mode

Class MocShapeMode

java.lang.Object

uk.ac.starlink.ttools.mode.MocShapeMode

All Implemented Interfaces:

ProcessingMode

public class MocShapeMode
extends Object
implements ProcessingMode

Turns a table into a multi-order coverage map by interpreting a given quantity (column or expression) as an Area specification.

Since:

30 Jan 2025

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
MocShapeMode() Constructor.

Method Summary

Modifier and Type	Method and Description
TableConsumer	createConsumer(Environment env) Creates a TableConsumer, deriving any additional required configuration from a given environment.
Parameter<?>[]	getAssociatedParameters() Returns a list of any parameters which are associated with this mode.
String	getDescription() Returns a textual description of this processing mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

MocShapeMode

public MocShapeMode()

Constructor.

Method Detail

getAssociatedParameters

public Parameter<?>[] getAssociatedParameters()

Description copied from interface: ProcessingMode

Returns a list of any parameters which are associated with this mode.

Specified by:

getAssociatedParameters in interface ProcessingMode

Returns:

parameter list

getDescription

public String getDescription()

Description copied from interface: ProcessingMode

Returns a textual description of this processing mode. This will be included in the user document so should be in XML.

Specified by:

getDescription in interface ProcessingMode

Returns:

textual description of this mode

createConsumer

public TableConsumer createConsumer(Environment env)
                             throws TaskException

Description copied from interface: ProcessingMode

Creates a TableConsumer, deriving any additional required configuration from a given environment.

Specified by:

createConsumer in interface ProcessingMode

Parameters:

env - execution environment

Throws:

TaskException