Package uk.ac.starlink.ttools.mode
Class StatsMode
java.lang.Object
uk.ac.starlink.ttools.mode.StatsMode
- All Implemented Interfaces:
ProcessingMode
Processing mode for calculating statistics on a table.
- Since:
- 16 Mar 2005
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateConsumer
(uk.ac.starlink.task.Environment env) Creates a TableConsumer, deriving any additional required configuration from a given environment.uk.ac.starlink.task.Parameter<?>[]
Returns a list of any parameters which are associated with this mode.Returns a textual description of this processing mode.
-
Constructor Details
-
StatsMode
public StatsMode()Default constructor. -
StatsMode
public StatsMode(boolean isParallel) Constructs an instance with optional parallel processing. Parallel execution can be much faster, but it depends on the underlying data; if the multithreaded execution ends up requesting simultaneous access to many different parts of a mapped file, it can end up being much slower than sequential execution.- Parameters:
isParallel
- whether statistics calculations are done using multiple threads
-
-
Method Details
-
getAssociatedParameters
public uk.ac.starlink.task.Parameter<?>[] getAssociatedParameters()Description copied from interface:ProcessingMode
Returns a list of any parameters which are associated with this mode.- Specified by:
getAssociatedParameters
in interfaceProcessingMode
- Returns:
- parameter list
-
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 interfaceProcessingMode
- Returns:
- textual description of this mode
-
createConsumer
Description copied from interface:ProcessingMode
Creates a TableConsumer, deriving any additional required configuration from a given environment.- Specified by:
createConsumer
in interfaceProcessingMode
- Parameters:
env
- execution environment
-