uk.ac.starlink.ttools.mode

Class MetadataMode

java.lang.Object

uk.ac.starlink.ttools.mode.MetadataMode

All Implemented Interfaces:

ProcessingMode

public class MetadataMode
extends Object
implements ProcessingMode

Processing mode which summarises table metadata.

Since:

11 Feb 2005

Author:

Mark Taylor (Starlink)

Constructor Summary

Constructors

Constructor and Description
MetadataMode()

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

MetadataMode

public MetadataMode()

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)

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