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

java.lang.Object
- oracle.spatial.hadoop.vector.binning.BinningConfig

```
public class BinningConfig
extends java.lang.Object
```
Holds the configuration for creating spatial binning.

Author:

hsaucedo

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BinningConfig.BinShape
The shape of the cells to be generated

Nested Classes
Modifier and Type	Class and Description
`static class`	`BinningConfig.BinShape` The shape of the cells to be generated

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONF_AGGR_FIELDS` Job configuration: a comma separated list of numeric field values to be aggregated.
`static java.lang.String`	`CONF_CELL_HEIGHT` Job configuration: The height of the cells as a double value
`static java.lang.String`	`CONF_CELL_SHAPE` Job configuration: the shape of the cells.
`static java.lang.String`	`CONF_CELL_WIDTH` Job configuration: The width of the cells as a double value
`static java.lang.String`	`CONF_GRID_COLS` Job configuration: The number of columns in the grid as an integer number.
`static java.lang.String`	`CONF_GRID_MAX_X` Job configuration: The maximum x ordinate value of the grid as a double value
`static java.lang.String`	`CONF_GRID_MAX_Y` Job configuration: The maximum y ordinate value of the grid as a double value
`static java.lang.String`	`CONF_GRID_MIN_X` Job configuration: The minimum x ordinate value of the grid as a double value
`static java.lang.String`	`CONF_GRID_MIN_Y` Job configuration: The minimum y ordinate value of the grid as a double value
`static java.lang.String`	`CONF_GRID_ROWS` Job configuration: The number of rows in the grid as an integer number.

Constructor Summary

Constructors
Constructor and Description

BinningConfig()

Constructors
Constructor and Description
`BinningConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getAggrFields()` Gets the name of the fields to be aggregated
`double`	`getCellHeight()` Gets the height of the cells
`double`	`getCellWidth()` Gets the width of the cells
`int`	`getGridColumns()` Gets the number of columns in the grid
`double[]`	`getGridMbr()` Gets the minimum bounding box of the grid
`int`	`getGridRows()` Gets the number of rows in the grid
`BinningConfig.BinShape`	`getShape()` Gets the shape of the cells
`SpatialConfig`	`getSpatialConfig()` Gets the current spatial configuration
`void`	`load(Configuration conf)` Loads a binning configuration from the job configuration
`void`	`setAggrFields(java.lang.String[] aggrFields)` Sets the name of the fields to be aggregated
`void`	`setCellHeight(double cellHeight)` Sets the height of the cells
`void`	`setCellWidth(double cellWidth)` Sets the width of the cells
`void`	`setGridColumns(int gridColumns)` Sets the number of columns in the grid
`void`	`setGridMbr(double[] gridMbr)` Sets the minimum bounding box of the grid
`void`	`setGridRows(int gridRows)` Sets the number of rows in the grid
`void`	`setShape(BinningConfig.BinShape shape)` Sets the shape of the cells
`void`	`setSpatialConfig(SpatialConfig spatialConfig)` Sets the current spatial configuration
`void`	`store(Configuration conf)` Stores the binning configuration into the job configuration
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONF_AGGR_FIELDS
```
public static final java.lang.String CONF_AGGR_FIELDS
```
    Job configuration: a comma separated list of numeric field values to be aggregated.
    
    See Also:
    
    Constant Field Values
  - CONF_CELL_HEIGHT
```
public static final java.lang.String CONF_CELL_HEIGHT
```
    Job configuration: The height of the cells as a double value
    
    See Also:
    
    Constant Field Values
  - CONF_CELL_SHAPE
```
public static final java.lang.String CONF_CELL_SHAPE
```
    Job configuration: the shape of the cells. Expected values: a string representation of any value of BinningConfig.BinShape
    
    See Also:
    
    Constant Field Values
  - CONF_CELL_WIDTH
```
public static final java.lang.String CONF_CELL_WIDTH
```
    Job configuration: The width of the cells as a double value
    
    See Also:
    
    Constant Field Values
  - CONF_GRID_COLS
```
public static final java.lang.String CONF_GRID_COLS
```
    Job configuration: The number of columns in the grid as an integer number. This value is calculated automatically when the cell size and the grid MBR are specified.
    
    See Also:
    
    Constant Field Values
  - CONF_GRID_MAX_X
```
public static final java.lang.String CONF_GRID_MAX_X
```
    Job configuration: The maximum x ordinate value of the grid as a double value
    
    See Also:
    
    Constant Field Values
  - CONF_GRID_MAX_Y
```
public static final java.lang.String CONF_GRID_MAX_Y
```
    Job configuration: The maximum y ordinate value of the grid as a double value
    
    See Also:
    
    Constant Field Values
  - CONF_GRID_MIN_X
```
public static final java.lang.String CONF_GRID_MIN_X
```
    Job configuration: The minimum x ordinate value of the grid as a double value
    
    See Also:
    
    Constant Field Values
  - CONF_GRID_MIN_Y
```
public static final java.lang.String CONF_GRID_MIN_Y
```
    Job configuration: The minimum y ordinate value of the grid as a double value
    
    See Also:
    
    Constant Field Values
  - CONF_GRID_ROWS
```
public static final java.lang.String CONF_GRID_ROWS
```
    Job configuration: The number of rows in the grid as an integer number. This value is calculated automatically when the cell size and the grid MBR are specified.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BinningConfig
```
public BinningConfig()
```
- Method Detail
  - getAggrFields
```
public java.lang.String[] getAggrFields()
```
    Gets the name of the fields to be aggregated
    
    Returns:
    
    an array of field names
  - getCellHeight
```
public double getCellHeight()
```
    Gets the height of the cells
    
    Returns:
    
    the cell height
  - getCellWidth
```
public double getCellWidth()
```
    Gets the width of the cells
    
    Returns:
    
    the cell with
  - getGridColumns
```
public int getGridColumns()
```
    Gets the number of columns in the grid
    
    Returns:
    
    the number of columns
  - getGridMbr
```
public double[] getGridMbr()
```
    Gets the minimum bounding box of the grid
    
    Returns:
    
    a double array with the values minX,minY,maxX,maxY
  - getGridRows
```
public int getGridRows()
```
    Gets the number of rows in the grid
    
    Returns:
    
    the number of rows
  - getShape
```
public BinningConfig.BinShape getShape()
```
    Gets the shape of the cells
    
    Returns:
    
    the cell shape
  - getSpatialConfig
```
public SpatialConfig getSpatialConfig()
```
    Gets the current spatial configuration
    
    Returns:
    
    a spatial configuration
  - load
```
public void load(Configuration conf)
```
    Loads a binning configuration from the job configuration
    
    Parameters:
    
    conf - the job configuration
  - setAggrFields
```
public void setAggrFields(java.lang.String[] aggrFields)
```
    Sets the name of the fields to be aggregated
    
    Parameters:
    
    aggrFields - an array of field names
  - setCellHeight
```
public void setCellHeight(double cellHeight)
```
    Sets the height of the cells
    
    Parameters:
    
    cellHeight - the cell height
  - setCellWidth
```
public void setCellWidth(double cellWidth)
```
    Sets the width of the cells
    
    Parameters:
    
    cellWidth - the cell width
  - setGridColumns
```
public void setGridColumns(int gridColumns)
```
    Sets the number of columns in the grid
    
    Parameters:
    
    gridColumns - the number of columns
  - setGridMbr
```
public void setGridMbr(double[] gridMbr)
```
    Sets the minimum bounding box of the grid
    
    Parameters:
    
    gridMbr - a double array with the values minX,minY,maxX,maxY
  - setGridRows
```
public void setGridRows(int gridRows)
```
    Sets the number of rows in the grid
    
    Parameters:
    
    gridRows - the number of rows
  - setShape
```
public void setShape(BinningConfig.BinShape shape)
```
    Sets the shape of the cells
    
    Parameters:
    
    shape - the cell shape
  - setSpatialConfig
```
public void setSpatialConfig(SpatialConfig spatialConfig)
```
    Sets the current spatial configuration
    
    Parameters:
    
    spatialConfig - a spatial configuration
  - store
```
public void store(Configuration conf)
```
    Stores the binning configuration into the job configuration
    
    Parameters:
    
    conf - the job configuration
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BinningConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONF_AGGR_FIELDS

CONF_CELL_HEIGHT

CONF_CELL_SHAPE

CONF_CELL_WIDTH

CONF_GRID_COLS

CONF_GRID_MAX_X

CONF_GRID_MAX_Y

CONF_GRID_MIN_X

CONF_GRID_MIN_Y

CONF_GRID_ROWS

Constructor Detail

BinningConfig

Method Detail

getAggrFields

getCellHeight

getCellWidth

getGridColumns

getGridMbr

getGridRows

getShape

getSpatialConfig

load

setAggrFields

setCellHeight

setCellWidth

setGridColumns

setGridMbr

setGridRows

setShape

setSpatialConfig

store

toString