uk.ac.starlink.ttools.join

Class MatchMapper

java.lang.Object

uk.ac.starlink.ttools.join.MatchMapper

All Implemented Interfaces:

TableMapper

public class MatchMapper
extends Object
implements TableMapper

TableMapper which implements multi-table crossmatches.

Since:

20 Nov 2007

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROUP_MODE MultiMode parameter value for group matching.
static String	PAIRS_MODE MultiMode parameter value for pairs matching.

Constructor Summary

Constructors

Constructor and Description
MatchMapper() Constructor.

Method Summary

Modifier and Type	Method and Description
TableMapping	createMapping(Environment env, int nin) Creates a new mapping object, using a given execution environment for any additional required state.
static Parameter<MultiJoinType>	createMultiJoinTypeParameter(String suffix) Returns the parameter used to acquire join type for an input table identified by a given suffix.
Parameter<String>	getMultiModeParameter() Returns the parameter used to acquire multi-table match type.
Parameter<?>[]	getParameters() Returns the parameters defined by this mapper.

Methods inherited from class java.lang.Object

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

Field Detail

PAIRS_MODE

public static final String PAIRS_MODE

MultiMode parameter value for pairs matching.

See Also:

Constant Field Values

GROUP_MODE

public static final String GROUP_MODE

MultiMode parameter value for group matching.

See Also:

Constant Field Values

Constructor Detail

MatchMapper

public MatchMapper()

Constructor.

Method Detail

getParameters

public Parameter<?>[] getParameters()

Description copied from interface: TableMapper

Returns the parameters defined by this mapper.

Specified by:

getParameters in interface TableMapper

Returns:

parameter array

createMapping

public TableMapping createMapping(Environment env,
                                  int nin)
                           throws TaskException

Description copied from interface: TableMapper

Creates a new mapping object, using a given execution environment for any additional required state.

Specified by:

createMapping in interface TableMapper

Parameters:

env - execution environment

nin - number of input tables that the mapping will operate on if known; -1 if not

Throws:

TaskException

getMultiModeParameter

public Parameter<String> getMultiModeParameter()

Returns the parameter used to acquire multi-table match type.

Returns:

multimode parameter

createMultiJoinTypeParameter

public static Parameter<MultiJoinType> createMultiJoinTypeParameter(String suffix)

Returns the parameter used to acquire join type for an input table identified by a given suffix.

Parameters:

suffix - input table suffix

Returns:

join type parameter for one table