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
    Description
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    createMapping(uk.ac.starlink.task.Environment env, int nin)
    Creates a new mapping object, using a given execution environment for any additional required state.
    uk.ac.starlink.task.Parameter<uk.ac.starlink.table.join.JoinType>
    Returns the parameter used to acquire the join type.
    uk.ac.starlink.task.Parameter<uk.ac.starlink.table.join.PairMode>
    Returns the parameter used to acquire the pair match mode.
    uk.ac.starlink.task.Parameter<?>[]
    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 Details

    • Match2Mapper

      public Match2Mapper()
      Constructor.
  • Method Details

    • getParameters

      public uk.ac.starlink.task.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 uk.ac.starlink.task.Parameter<uk.ac.starlink.table.join.PairMode> getPairModeParameter()
      Returns the parameter used to acquire the pair match mode.
      Returns:
      pair mode parameter
    • getJoinTypeParameter

      public uk.ac.starlink.task.Parameter<uk.ac.starlink.table.join.JoinType> getJoinTypeParameter()
      Returns the parameter used to acquire the join type.
      Returns:
      join type parameter
    • createMapping

      public TableMapping createMapping(uk.ac.starlink.task.Environment env, int nin) throws uk.ac.starlink.task.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:
      uk.ac.starlink.task.TaskException