org.cylondata.cylon.ops

Class JoinConfig

java.lang.Object

org.cylondata.cylon.ops.JoinConfig

public class JoinConfig
extends Object

This class can be used to configure the join operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JoinConfig.Algorithm Types of join algorithms
static class	JoinConfig.Type Types of Joins, analogous to SQL joins

Constructor Summary

Constructors

Constructor and Description
JoinConfig(int leftIndex, int rightIndex) Creates and instance of JoinConfig

Method Summary

Modifier and Type	Method and Description
JoinConfig	filterColumns(List<Integer> leftFilterColumns, List<Integer> rightFilterColumns) This method can be used to specify the list of columns to be included in the final join table
JoinConfig.Algorithm	getJoinAlgorithm()
JoinConfig.Type	getJoinType()
int	getLeftIndex()
int	getRightIndex()
JoinConfig	joinType(JoinConfig.Type joinType) Type of join to perform.
JoinConfig	useAlgorithm(JoinConfig.Algorithm algorithm) Algorithm to be used when joining two Tables

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinConfig

public JoinConfig(int leftIndex,
                  int rightIndex)

Creates and instance of JoinConfig

Parameters:

leftIndex - join column index of this left table

rightIndex - join column index of the right table

Method Detail

filterColumns

public JoinConfig filterColumns(List<Integer> leftFilterColumns,
                                List<Integer> rightFilterColumns)

This method can be used to specify the list of columns to be included in the final join table

Parameters:

leftFilterColumns - Columns to be included from left table

rightFilterColumns - Columns to be include from right table

Returns:

The instance of JoinConfig

useAlgorithm

public JoinConfig useAlgorithm(JoinConfig.Algorithm algorithm)

Algorithm to be used when joining two Tables

Parameters:

algorithm - the JoinConfig.Algorithm

Returns:

The instance of JoinConfig

joinType

public JoinConfig joinType(JoinConfig.Type joinType)

Type of join to perform.

Parameters:

joinType - the JoinConfig.Type

Returns:

The instance of JoinConfig

getLeftIndex

public int getLeftIndex()

getRightIndex

public int getRightIndex()

getJoinAlgorithm

public JoinConfig.Algorithm getJoinAlgorithm()

getJoinType

public JoinConfig.Type getJoinType()