CmdArgs (Oracle Big Data Spatial and Graph Vector Analysis Java API Reference)

java.lang.Object
- oracle.spatial.hadoop.vector.util.CmdArgs

```
public class CmdArgs
extends java.lang.Object
```
Contains constants for some common command line arguments

Author:

hsaucedo

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BOUNDARIES` The dimensions boundaries of the spatial data.
`static java.lang.String`	`DIMENSIONS` The number of dimensions of the spatial data
`static java.lang.String`	`GEODETIC` Whether the spatial data is geodetic or not
`static java.lang.String`	`HIERARCHY_DATA_PATHS` A comma-separated list of paths of different hierarchy level templates
`static java.lang.String`	`HIERARCHY_INDEX_PATH` The path where a hierarchy index will be stored or can be found.
`static java.lang.String`	`HIERARCHY_INFO` A `HierarchyInfo` subclass used to describe a hierarchical data set
`static java.lang.String`	`INDEX_MAP_FILE` Boolean parameter.
`static java.lang.String`	`INDEX_METADATA_DIR` The path to the directory where the spatial index metadata is stored
`static java.lang.String`	`INDEX_NAME` A spatial index name
`static java.lang.String`	`INPUT` The input data path as a path, a comma-separated list of paths or a path pattern
`static java.lang.String`	`INPUT_FORMAT` A subclass of InputFormat used to read the input data
`static java.lang.String`	`INPUT_LIST` Multiples input data sets specified in the following format: { {input_path1 inputFormatClass1 recordInfoProviderClass1} {input_path2 inputFormatClass2 recordInfoProviderClass2} ...
`static java.lang.String`	`IS_INPUT_INDEX` Whether a given input path is a spatial index or not.
`static java.lang.String`	`OUTPUT` The path where the job output will be stored
`static java.lang.String`	`OVERWRITE_INDEX_METADATA` Whether the spatial index metadata can be overwritten in case it already exists
`static java.lang.String`	`QUERY_WINDOW` A query window used in a spatial operation.
`static java.lang.String`	`RECORD_INFO_PROVIDER` A `RecordInfoProvider` subclass to be used to interpret input records.
`static java.lang.String`	`SAMPLER_CLASS`
`static java.lang.String`	`SAMPLING_RATIO` Sampling ratio
`static java.lang.String`	`SPATIAL_OPERATION` A spatial operation to be performed.
`static java.lang.String`	`SRID` The SRID of the spatial data
`static java.lang.String`	`TOLERANCE` The tolerance used with the spatial data
`static java.lang.String`	`WITHIN_DISTANCE` Distance parameter used for the within distance spatial operation

Constructor Summary

Constructors
Constructor and Description

CmdArgs()

Constructors
Constructor and Description
`CmdArgs()`

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BOUNDARIES
```
public static final java.lang.String BOUNDARIES
```
    The dimensions boundaries of the spatial data. It is expected as a comma-separated list of ordinates in the form dim1Min,dim2Min,dim1Max,dim2Max
    
    See Also:
    
    Constant Field Values
  - DIMENSIONS
```
public static final java.lang.String DIMENSIONS
```
    The number of dimensions of the spatial data
    
    See Also:
    
    Constant Field Values
  - GEODETIC
```
public static final java.lang.String GEODETIC
```
    Whether the spatial data is geodetic or not
    
    See Also:
    
    Constant Field Values
  - HIERARCHY_DATA_PATHS
```
public static final java.lang.String HIERARCHY_DATA_PATHS
```
    A comma-separated list of paths of different hierarchy level templates
    
    See Also:
    
    Constant Field Values
  - HIERARCHY_INDEX_PATH
```
public static final java.lang.String HIERARCHY_INDEX_PATH
```
    The path where a hierarchy index will be stored or can be found.
    
    See Also:
    
    Constant Field Values
  - HIERARCHY_INFO
```
public static final java.lang.String HIERARCHY_INFO
```
    A HierarchyInfo subclass used to describe a hierarchical data set
    
    See Also:
    
    Constant Field Values
  - INDEX_MAP_FILE
```
public static final java.lang.String INDEX_MAP_FILE
```
    Boolean parameter. Setting this value to false for spatial index generation, causes the index to be generated as a sequence file instead of a map file.
    
    See Also:
    
    Constant Field Values
  - INDEX_METADATA_DIR
```
public static final java.lang.String INDEX_METADATA_DIR
```
    The path to the directory where the spatial index metadata is stored
    
    See Also:
    
    Constant Field Values
  - INDEX_NAME
```
public static final java.lang.String INDEX_NAME
```
    A spatial index name
    
    See Also:
    
    Constant Field Values
  - INPUT
```
public static final java.lang.String INPUT
```
    The input data path as a path, a comma-separated list of paths or a path pattern
    
    See Also:
    
    Constant Field Values
  - INPUT_FORMAT
```
public static final java.lang.String INPUT_FORMAT
```
    A subclass of InputFormat used to read the input data
    
    See Also:
    
    Constant Field Values
  - INPUT_LIST
```
public static final java.lang.String INPUT_LIST
```
    Multiples input data sets specified in the following format: { {input_path1 inputFormatClass1 recordInfoProviderClass1} {input_path2 inputFormatClass2 recordInfoProviderClass2} ... {input_pathN inputFormatClassN recordInfoProviderClassN} }. Where: input_path is specified as in INPUT. inputFormatClass and recordInfoProviderClass are an InputFormat and RecordInfoProvider class implementations used to read the respective input_path.
    
    See Also:
    
    Constant Field Values
  - IS_INPUT_INDEX
```
public static final java.lang.String IS_INPUT_INDEX
```
    Whether a given input path is a spatial index or not. By default it is always false.
    
    See Also:
    
    Constant Field Values
  - OUTPUT
```
public static final java.lang.String OUTPUT
```
    The path where the job output will be stored
    
    See Also:
    
    Constant Field Values
  - OVERWRITE_INDEX_METADATA
```
public static final java.lang.String OVERWRITE_INDEX_METADATA
```
    Whether the spatial index metadata can be overwritten in case it already exists
    
    See Also:
    
    Constant Field Values
  - QUERY_WINDOW
```
public static final java.lang.String QUERY_WINDOW
```
    A query window used in a spatial operation. The value is expected as a GeoJSON geometry.
    
    See Also:
    
    Constant Field Values
  - RECORD_INFO_PROVIDER
```
public static final java.lang.String RECORD_INFO_PROVIDER
```
    A RecordInfoProvider subclass to be used to interpret input records.
    
    See Also:
    
    Constant Field Values
  - SAMPLER_CLASS
```
public static final java.lang.String SAMPLER_CLASS
```
    See Also:
    
    Constant Field Values
  - SAMPLING_RATIO
```
public static final java.lang.String SAMPLING_RATIO
```
    Sampling ratio
    
    See Also:
    
    Constant Field Values
  - SPATIAL_OPERATION
```
public static final java.lang.String SPATIAL_OPERATION
```
    A spatial operation to be performed. Valid values are: IsInside, AnyInteract
    
    See Also:
    
    Constant Field Values
  - SRID
```
public static final java.lang.String SRID
```
    The SRID of the spatial data
    
    See Also:
    
    Constant Field Values
  - TOLERANCE
```
public static final java.lang.String TOLERANCE
```
    The tolerance used with the spatial data
    
    See Also:
    
    Constant Field Values
  - WITHIN_DISTANCE
```
public static final java.lang.String WITHIN_DISTANCE
```
    Distance parameter used for the within distance spatial operation
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CmdArgs
```
public CmdArgs()
```

Class CmdArgs

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOUNDARIES

DIMENSIONS

GEODETIC

HIERARCHY_DATA_PATHS

HIERARCHY_INDEX_PATH

HIERARCHY_INFO

INDEX_MAP_FILE

INDEX_METADATA_DIR

INDEX_NAME

INPUT

INPUT_FORMAT

INPUT_LIST

IS_INPUT_INDEX

OUTPUT

OVERWRITE_INDEX_METADATA

QUERY_WINDOW

RECORD_INFO_PROVIDER

SAMPLER_CLASS

SAMPLING_RATIO

SPATIAL_OPERATION

SRID

TOLERANCE

WITHIN_DISTANCE

Constructor Detail

CmdArgs