io.cdap.cdap.api.dataset.lib

Class FileSetArguments

java.lang.Object

io.cdap.cdap.api.dataset.lib.FileSetArguments

public class FileSetArguments
extends Object

Constants and helper methods to configure runtime arguments for a file dataset.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INPUT_PATHS The paths of the files to be read.
static String	OUTPUT_PATH The path of the file to write.

Constructor Summary

Constructors

Constructor and Description
FileSetArguments()

Method Summary

Modifier and Type	Method and Description
static void	addInputPath(Map<String,String> arguments, String path) Add an input path in the runtime arguments for a file dataset.
static Collection<String>	getInputPaths(Map<String,String> arguments)
static String	getOutputPath(Map<String,String> arguments)
static boolean	isBaseOutputPath(Map<String,String> arguments)
static void	setBaseOutputPath(Map<String,String> arguments) Sets the baseLocation of the file dataset as the output location in the runtime arguments for a file dataset.
static void	setInputPath(Map<String,String> arguments, String path) Sets the input path in the runtime arguments for a file dataset.
static void	setInputPaths(Map<String,String> arguments, Collection<String> paths) Sets multiple input paths in the runtime arguments for a file dataset.
static void	setInputPaths(Map<String,String> arguments, String paths) Sets multiple input paths in the runtime arguments for a file dataset.
static void	setOutputPath(Map<String,String> arguments, String path) Sets the output path in the runtime arguments for a file dataset.

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_PATHS

public static final String INPUT_PATHS

The paths of the files to be read. Specified as a runtime argument for the dataset. Each path is relative to the dataset's base path, and multiple paths can be given, separated by commas.

See Also:

Constant Field Values

OUTPUT_PATH

public static final String OUTPUT_PATH

The path of the file to write. Specified as a runtime argument for the dataset. The path is relative to the dataset's base path.

See Also:

Constant Field Values

Constructor Detail

FileSetArguments

public FileSetArguments()

Method Detail

setInputPath

public static void setInputPath(Map<String,String> arguments,
                                String path)

Sets the input path in the runtime arguments for a file dataset.

setInputPaths

public static void setInputPaths(Map<String,String> arguments,
                                 String paths)

Sets multiple input paths in the runtime arguments for a file dataset.

Parameters:

paths - A comma-separated sequence of paths

setInputPaths

public static void setInputPaths(Map<String,String> arguments,
                                 Collection<String> paths)

Sets multiple input paths in the runtime arguments for a file dataset.

addInputPath

public static void addInputPath(Map<String,String> arguments,
                                String path)

Add an input path in the runtime arguments for a file dataset.

setBaseOutputPath

public static void setBaseOutputPath(Map<String,String> arguments)

Sets the baseLocation of the file dataset as the output location in the runtime arguments for a file dataset.

isBaseOutputPath

public static boolean isBaseOutputPath(Map<String,String> arguments)

Returns:

whether to use the base location of the file dataset as the output location.

setOutputPath

public static void setOutputPath(Map<String,String> arguments,
                                 String path)

Sets the output path in the runtime arguments for a file dataset.

getOutputPath

public static String getOutputPath(Map<String,String> arguments)

Returns:

the output path in the runtime arguments for a file dataset.

getInputPaths

public static Collection<String> getInputPaths(Map<String,String> arguments)

Returns:

the output path in the runtime arguments for a file dataset.