uk.ac.starlink.ttools.join

Class Match2Mapper

java.lang.Object

uk.ac.starlink.ttools.join.Match2Mapper

All Implemented Interfaces:

TableMapper

public class Match2Mapper
extends Object
implements TableMapper

TableMapper which does the work for pair matching (tmatch2).

Since:

2 Sep 2005

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
Match2Mapper() 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.
Parameter<JoinType>	getJoinTypeParameter() Returns the parameter used to acquire the join type.
Parameter<PairMode>	getPairModeParameter() Returns the parameter used to acquire the pair match mode.
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

Constructor Detail

Match2Mapper

public Match2Mapper()

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

getPairModeParameter

public Parameter<PairMode> getPairModeParameter()

Returns the parameter used to acquire the pair match mode.

Returns:

pair mode parameter

getJoinTypeParameter

public Parameter<JoinType> getJoinTypeParameter()

Returns the parameter used to acquire the join type.

Returns:

join type parameter

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