org.apache.gobblin.util

Class ForkOperatorUtils

java.lang.Object

org.apache.gobblin.util.ForkOperatorUtils

public class ForkOperatorUtils
extends Object

Utility class for use with the ForkOperator class.

Constructor Summary

Constructors

Constructor and Description
ForkOperatorUtils()

Method Summary

Modifier and Type	Method and Description
static String	getForkId(String taskId, int index) Get the fork branch ID of a branch of a given task.
static String	getPathForBranch(State state, String path, int numBranches, int branchId) Get a new path with the given branch name as a sub directory.
static String	getPropertyNameForBranch(String key, int branch) Get a new property key from an original one with branch index (if applicable).
static String	getPropertyNameForBranch(String key, int numBranches, int branchId) Get a new property key from an original one with branch index (if applicable).
static String	getPropertyNameForBranch(WorkUnitState workUnitState, String key) Get a new property key from an original one based on the branch id.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForkOperatorUtils

public ForkOperatorUtils()

Method Detail

getPropertyNameForBranch

public static String getPropertyNameForBranch(String key,
                                              int numBranches,
                                              int branchId)

Get a new property key from an original one with branch index (if applicable).

Parameters:

key - property key

numBranches - number of branches (non-negative)

branchId - branch id (non-negative)

Returns:

a new property key

getPropertyNameForBranch

public static String getPropertyNameForBranch(String key,
                                              int branch)

Get a new property key from an original one with branch index (if applicable).

Parameters:

key - property key

branch - branch index

Returns:

a new property key

getPropertyNameForBranch

public static String getPropertyNameForBranch(WorkUnitState workUnitState,
                                              String key)

Get a new property key from an original one based on the branch id. The method assumes the branch id specified by the ConfigurationKeys.FORK_BRANCH_ID_KEY parameter in the given WorkUnitState. The fork id key specifies which fork this parameter belongs to. Note this method will only provide the aforementioned functionality for Converters. To get the same functionality in DataWriters use the DataWriterBuilder.forBranch(int) to construct a writer with a specific branch id.

Parameters:

workUnitState - contains the fork id key

key - property key

Returns:

a new property key

getPathForBranch

public static String getPathForBranch(State state,
                                      String path,
                                      int numBranches,
                                      int branchId)

Get a new path with the given branch name as a sub directory.

Parameters:

numBranches - number of branches (non-negative)

branchId - branch id (non-negative)

Returns:

a new path

getForkId

public static String getForkId(String taskId,
                               int index)

Get the fork branch ID of a branch of a given task.

Parameters:

taskId - task ID

index - branch index

Returns:

a fork branch ID