oracle.spatial.hadoop.vector.data.cmd

Interface InputDataSetCmdArgsParser

All Known Implementing Classes:

FileInputDataSetCmdArgsParser, MultiInputDataSetCmdArgsParser, NoSQLInputCmdArgsParser, SimpleInputDataSetCmdArgsParser, SpatialIndexInputDataSetCmdArgsParser

public interface InputDataSetCmdArgsParser

Defines a common interface for a command line argument parser for an instance of AbstractInputDataSet.
An implementation of this interface can create an instance of a subclass of AbstractInputDataSet given some parameters.

Author:

hsaucedo

Method Summary

Modifier and Type	Method and Description
boolean	acceptsCmdArgs(CmdArgsParser argsp, Configuration conf) Returns true if the implementation can create an instance of AbstractInputDataSet given the command line arguments encapsulated by argsp
void	getCmdArgs(AbstractInputDataSet dataSet, java.util.Map<java.lang.String,java.lang.Object> cmdArgs) Converts the current input data set properties to command line parameters which are added to the passed cmdArgs map.
java.lang.String	getCmdOptions() Gets a descriptive text about the parameters expected
java.lang.String	getInputDataSetDescription() Gets a description of the input data set created by the current parser implementation
AbstractInputDataSet	parseCmdArgs(CmdArgsParser argsp, Configuration conf) Processes the command line arguments and creates an instance of AbstractInputDataSet

Method Detail

acceptsCmdArgs

boolean acceptsCmdArgs(CmdArgsParser argsp,
                       Configuration conf)

Returns true if the implementation can create an instance of AbstractInputDataSet given the command line arguments encapsulated by argsp

Parameters:

argsp - an instance of CmdArgsParser which contains the command line parameters

conf - a job configuration

Returns:

true if the implementation can create an instance of AbstractInputDataSet given the command line arguments

getCmdArgs

void getCmdArgs(AbstractInputDataSet dataSet,
                java.util.Map<java.lang.String,java.lang.Object> cmdArgs)

Converts the current input data set properties to command line parameters which are added to the passed cmdArgs map.
If the given data set contains nested data sets (which is the case of MultiInputDataSet), a new map can be added to cmdArgs with the key defined by CmdArgs.INPUT_LIST

Parameters:

dataSet - an input data set

cmdArgs - a map which key value pairs represent command line parameters.

getCmdOptions

java.lang.String getCmdOptions()

Gets a descriptive text about the parameters expected

Returns:

a text containing the parameters and values expected

getInputDataSetDescription

java.lang.String getInputDataSetDescription()

Gets a description of the input data set created by the current parser implementation

Returns:

a textual description

parseCmdArgs

AbstractInputDataSet parseCmdArgs(CmdArgsParser argsp,
                                  Configuration conf)

Processes the command line arguments and creates an instance of AbstractInputDataSet

Parameters:

argsp - an instance of CmdArgsParser which contains the command line parameters

conf - a job configuration

Returns:

an instance of AbstractInputDataSet