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

java.lang.Object
- oracle.spatial.hadoop.vector.nosql.NoSQLConfiguration

All Implemented Interfaces:

ConfigurationStorable
```
public class NoSQLConfiguration
extends java.lang.Object
implements ConfigurationStorable
```
Bean class that contains the properties to connect and query a NoSQL KV store

Author:

hsaucedo

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARG_BATCH_SIZE` Command line argument for the batch size property
`static java.lang.String`	`ARG_CONSISTENCY` Command line argument for the consistency property
`static java.lang.String`	`ARG_DEFAULT_ENTRY_PROCESSOR` Command line argument for the default `NoSQLEntryProcessor` implementation
`static java.lang.String`	`ARG_DEPTH` Command line argument for the depth property
`static java.lang.String`	`ARG_ENTRY_GROUPER` Command line argument for the entry grouper class property
`static java.lang.String`	`ARG_FORMATTER_CLASS` Command line argument for the formatter class property
`static java.lang.String`	`ARG_KVSTORE_HOSTS` Command line argument for the list of NoSQL service hosts
`static java.lang.String`	`ARG_KVSTORE_NAME` Command line argument for a KV store name
`static java.lang.String`	`ARG_KVSTORE_SECURITY` Command line argument for the security properties file property
`static java.lang.String`	`ARG_PARENT_KEY` Command line argument for the parent key property
`static java.lang.String`	`ARG_PARTITION_READER` Command line argument for the partition reader property
`static java.lang.String`	`ARG_RESULT_ENTRIES` Command line argument for the list of result entries property
`static java.lang.String`	`ARG_SECURITY_PROPS` Command line argument for the security properties file property
`static java.lang.String`	`ARG_SUB_RANGE` Command line argument for the sub range property
`static java.lang.String`	`ARG_TIME_OUT` Command line argument for the time out property
`static java.lang.String`	`ARG_TIME_OUT_UNIT` Command line argument for the time out unit
`static java.lang.String`	`CONF_BATCH_SIZE` Configuration property name for the batch size
`static java.lang.String`	`CONF_CONSISTENCY` Configuration property name for the consistency
`static java.lang.String`	`CONF_DEFAULT_ENTRY_PROCESSOR` Configuration property name for the default implementation of `NoSQLEntryProcessor`
`static java.lang.String`	`CONF_DEPTH` Configuration property name for the depth
`static java.lang.String`	`CONF_ENTRY_GROUPER` Configuration property name for the `NoSQLEntryGrouper` class
`static java.lang.String`	`CONF_FORMATTER_CLASS` Configuration property name for the formatter class
`static java.lang.String`	`CONF_KVSTORE_HOSTS` Configuration property name for the list of KV store hosts
`static java.lang.String`	`CONF_KVSTORE_NAME` Configuration property name for the KV store name
`static java.lang.String`	`CONF_KVSTORE_SECURITY` Configuration property name for the security properties file
`static java.lang.String`	`CONF_PARENT_KEY` Configuration property name for the KV store name
`static java.lang.String`	`CONF_PARTITION_READER` Configuration property name for the partition reader
`static java.lang.String`	`CONF_RESULT_ENTRIES` Configuration property name for the result entry list
`static java.lang.String`	`CONF_SUB_RANGE` Configuration property name for the minor key subrange
`static java.lang.String`	`CONF_TIME_OUT` Configuration property name for the time out
`static java.lang.String`	`CONF_TIME_OUT_UNIT` Configuration property name for the time out unit
`static java.lang.Class<? extends NoSQLEntryGrouper>`	`DEFAULT_ENTRY_GROUPER_CLASS` De default implementation of `NoSQLEntryGrouper` used when the property `CONF_ENTRY_GROUPER` is not set

Constructor Summary

Constructors
Constructor and Description

NoSQLConfiguration()

Constructors
Constructor and Description
`NoSQLConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTargetEntries(java.lang.String[] entryKeys)` Adds an array of keys from NoSQL entries (key-value pairs) to be included in a `RecordInfo` passed as a value to a job's mapper.
`void`	`addTargetEntry(java.lang.String entryKey, java.lang.Class<? extends NoSQLEntryProcessor> entryProcessorClass)` Adds a key from a NoSQL entry (key-value pair )to be included in a `RecordInfo` passed as a value to a job's mapper.
`int`	`getBatchSize()` Gets the current batch size
`Configuration`	`getConfiguration()` Gets the current job configuration
`Consistency`	`getConsistency()`
`Depth`	`getDepth()`
`java.lang.Class<? extends NoSQLEntryGrouper>`	`getEntryGrouperClass()` Gets the `NoSQLEntryGrouper` subclass which is in charge of grouping key-value pairs into a single record
`java.lang.Class<? extends NoSQLEntryProcessor>`	`getEntryProcessor(java.lang.String entryKey)` Gets the entry processor assigned to process a NoSQL key-value pair identified by the given minor key.
`java.lang.String`	`getFormatterClassName()`
`java.util.Properties`	`getKvSecurityProps()`
`java.lang.String[]`	`getKvStoreHosts()` Gets an array containing the KV store hosts locations
`java.lang.String`	`getKvStoreName()` Gets the current KV store name
`java.lang.String`	`getKvStoreSecurityFile()`
`Key`	`getParentKey()` Gets the major key used to select NoSQL entries
`KeyRange`	`getSubRange()`
`java.util.Collection<java.lang.String>`	`getTargetEntries()`
`long`	`getTimeOut()`
`java.util.concurrent.TimeUnit`	`getTimeOutUnit()`
`void`	`load(Configuration conf)` Loads the current state from the given job configuration
`void`	`removeAllTargetEntries()` Removes all the NoSQL minor keys that were added previously to be included in a job mapper value.
`void`	`setBatchSize(int batchSize)` Sets the current batch size
`void`	`setConfiguration(Configuration configuration)` Sets the current job configuration
`void`	`setConsistency(Consistency consistency)`
`void`	`setDefaultEntryProcessorClass(java.lang.Class<? extends NoSQLEntryProcessor> entryProcessorClass)` Sets the default implementation of `NoSQLEntryProcessor` used for all the target entries for which an explicit entry processor was not specified
`void`	`setDepth(Depth depth)`
`void`	`setEntryGrouperClass(java.lang.Class<? extends NoSQLEntryGrouper> entryGrouperClass)` Sets the `NoSQLEntryGrouper` subclass which is in charge of grouping key-value pairs into a single record
`void`	`setFormatterClassName(java.lang.String formatterClassName)`
`void`	`setKvStoreHosts(java.lang.String[] kvStoreHosts)` Sets an array containing the KV store hosts locations
`void`	`setKvStoreName(java.lang.String kvStoreName)` Sets the current KV store name
`void`	`setKvStoreSecurityFile(java.lang.String kvStoreSecurityFile)`
`void`	`setParentKey(Key parentKey)` Sets the major key used to select NoSQL entries
`void`	`setSubRange(KeyRange subRange)`
`void`	`setTimeOut(long timeOut)`
`void`	`store(Configuration conf)` Stores the current state into the given job configuration
`java.lang.String`	`toString()`

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

- Field Detail
  - ARG_BATCH_SIZE
```
public static final java.lang.String ARG_BATCH_SIZE
```
    Command line argument for the batch size property
    
    See Also:
    
    Constant Field Values
  - ARG_CONSISTENCY
```
public static final java.lang.String ARG_CONSISTENCY
```
    Command line argument for the consistency property
    
    See Also:
    
    Constant Field Values
  - ARG_DEFAULT_ENTRY_PROCESSOR
```
public static final java.lang.String ARG_DEFAULT_ENTRY_PROCESSOR
```
    Command line argument for the default NoSQLEntryProcessor implementation
    
    See Also:
    
    Constant Field Values
  - ARG_DEPTH
```
public static final java.lang.String ARG_DEPTH
```
    Command line argument for the depth property
    
    See Also:
    
    Constant Field Values
  - ARG_ENTRY_GROUPER
```
public static final java.lang.String ARG_ENTRY_GROUPER
```
    Command line argument for the entry grouper class property
    
    See Also:
    
    Constant Field Values
  - ARG_FORMATTER_CLASS
```
public static final java.lang.String ARG_FORMATTER_CLASS
```
    Command line argument for the formatter class property
    
    See Also:
    
    Constant Field Values
  - ARG_KVSTORE_HOSTS
```
public static final java.lang.String ARG_KVSTORE_HOSTS
```
    Command line argument for the list of NoSQL service hosts
    
    See Also:
    
    Constant Field Values
  - ARG_KVSTORE_NAME
```
public static final java.lang.String ARG_KVSTORE_NAME
```
    Command line argument for a KV store name
    
    See Also:
    
    Constant Field Values
  - ARG_KVSTORE_SECURITY
```
public static final java.lang.String ARG_KVSTORE_SECURITY
```
    Command line argument for the security properties file property
    
    See Also:
    
    Constant Field Values
  - ARG_PARENT_KEY
```
public static final java.lang.String ARG_PARENT_KEY
```
    Command line argument for the parent key property
    
    See Also:
    
    Constant Field Values
  - ARG_PARTITION_READER
```
public static final java.lang.String ARG_PARTITION_READER
```
    Command line argument for the partition reader property
    
    See Also:
    
    Constant Field Values
  - ARG_RESULT_ENTRIES
```
public static final java.lang.String ARG_RESULT_ENTRIES
```
    Command line argument for the list of result entries property
    
    See Also:
    
    Constant Field Values
  - ARG_SECURITY_PROPS
```
public static final java.lang.String ARG_SECURITY_PROPS
```
    Command line argument for the security properties file property
    
    See Also:
    
    Constant Field Values
  - ARG_SUB_RANGE
```
public static final java.lang.String ARG_SUB_RANGE
```
    Command line argument for the sub range property
    
    See Also:
    
    Constant Field Values
  - ARG_TIME_OUT
```
public static final java.lang.String ARG_TIME_OUT
```
    Command line argument for the time out property
    
    See Also:
    
    Constant Field Values
  - ARG_TIME_OUT_UNIT
```
public static final java.lang.String ARG_TIME_OUT_UNIT
```
    Command line argument for the time out unit
    
    See Also:
    
    Constant Field Values
  - CONF_BATCH_SIZE
```
public static final java.lang.String CONF_BATCH_SIZE
```
    Configuration property name for the batch size
    
    See Also:
    
    Constant Field Values
  - CONF_CONSISTENCY
```
public static final java.lang.String CONF_CONSISTENCY
```
    Configuration property name for the consistency
    
    See Also:
    
    Constant Field Values
  - CONF_DEFAULT_ENTRY_PROCESSOR
```
public static final java.lang.String CONF_DEFAULT_ENTRY_PROCESSOR
```
    Configuration property name for the default implementation of NoSQLEntryProcessor
    
    See Also:
    
    Constant Field Values
  - CONF_DEPTH
```
public static final java.lang.String CONF_DEPTH
```
    Configuration property name for the depth
    
    See Also:
    
    Constant Field Values
  - CONF_ENTRY_GROUPER
```
public static final java.lang.String CONF_ENTRY_GROUPER
```
    Configuration property name for the NoSQLEntryGrouper class
    
    See Also:
    
    Constant Field Values
  - CONF_FORMATTER_CLASS
```
public static final java.lang.String CONF_FORMATTER_CLASS
```
    Configuration property name for the formatter class
    
    See Also:
    
    Constant Field Values
  - CONF_KVSTORE_HOSTS
```
public static final java.lang.String CONF_KVSTORE_HOSTS
```
    Configuration property name for the list of KV store hosts
    
    See Also:
    
    Constant Field Values
  - CONF_KVSTORE_NAME
```
public static final java.lang.String CONF_KVSTORE_NAME
```
    Configuration property name for the KV store name
    
    See Also:
    
    Constant Field Values
  - CONF_KVSTORE_SECURITY
```
public static final java.lang.String CONF_KVSTORE_SECURITY
```
    Configuration property name for the security properties file
    
    See Also:
    
    Constant Field Values
  - CONF_PARENT_KEY
```
public static final java.lang.String CONF_PARENT_KEY
```
    Configuration property name for the KV store name
    
    See Also:
    
    Constant Field Values
  - CONF_PARTITION_READER
```
public static final java.lang.String CONF_PARTITION_READER
```
    Configuration property name for the partition reader
    
    See Also:
    
    Constant Field Values
  - CONF_RESULT_ENTRIES
```
public static final java.lang.String CONF_RESULT_ENTRIES
```
    Configuration property name for the result entry list
    
    See Also:
    
    Constant Field Values
  - CONF_SUB_RANGE
```
public static final java.lang.String CONF_SUB_RANGE
```
    Configuration property name for the minor key subrange
    
    See Also:
    
    Constant Field Values
  - CONF_TIME_OUT
```
public static final java.lang.String CONF_TIME_OUT
```
    Configuration property name for the time out
    
    See Also:
    
    Constant Field Values
  - CONF_TIME_OUT_UNIT
```
public static final java.lang.String CONF_TIME_OUT_UNIT
```
    Configuration property name for the time out unit
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENTRY_GROUPER_CLASS
```
public static final java.lang.Class<? extends NoSQLEntryGrouper> DEFAULT_ENTRY_GROUPER_CLASS
```
    De default implementation of NoSQLEntryGrouper used when the property CONF_ENTRY_GROUPER is not set
- Constructor Detail
  - NoSQLConfiguration
```
public NoSQLConfiguration()
```
- Method Detail
  - addTargetEntries
```
public void addTargetEntries(java.lang.String[] entryKeys)
```
    Adds an array of keys from NoSQL entries (key-value pairs) to be included in a RecordInfo passed as a value to a job's mapper. A default entry processor is used for all the entries.
    
    Parameters:
    
    entryKeys - an array of minor keys from NoSQL
  - addTargetEntry
```
public void addTargetEntry(java.lang.String entryKey,
                           java.lang.Class<? extends NoSQLEntryProcessor> entryProcessorClass)
```
    Adds a key from a NoSQL entry (key-value pair )to be included in a RecordInfo passed as a value to a job's mapper. Optionally, an implementation of NoSQLEntryProcessor can be specified to parse and process the NoSQL key-value pair. If no entry processor is passed, the entry processor returned by defaultEntryProcessorClass is used.
    
    Parameters:
    
    entryKey - a minor key from NoSQL
    
    entryProcessorClass - an implementation of NoSQLEntryProcessor or null
  - getBatchSize
```
public int getBatchSize()
```
    Gets the current batch size
    
    Returns:
  - getConfiguration
```
public Configuration getConfiguration()
```
    Gets the current job configuration
    
    Returns:
    
    a job configuration
  - getConsistency
```
public Consistency getConsistency()
```
  - getDepth
```
public Depth getDepth()
```
  - getEntryGrouperClass
```
public java.lang.Class<? extends NoSQLEntryGrouper> getEntryGrouperClass()
```
    Gets the NoSQLEntryGrouper subclass which is in charge of grouping key-value pairs into a single record
    
    Returns:
    
    a subclass of NoSQLEntryGrouper
  - getEntryProcessor
```
public java.lang.Class<? extends NoSQLEntryProcessor> getEntryProcessor(java.lang.String entryKey)
```
    Gets the entry processor assigned to process a NoSQL key-value pair identified by the given minor key. If no explicit entry processor was set for the key, the default entry processor will be returned.
    
    Parameters:
    
    entryKey - a minor key from NoSQL
    
    Returns:
    
    a subclass of NoSQLEntryProcessor
  - getFormatterClassName
```
public java.lang.String getFormatterClassName()
```
  - getKvSecurityProps
```
public java.util.Properties getKvSecurityProps()
```
  - getKvStoreHosts
```
public java.lang.String[] getKvStoreHosts()
```
    Gets an array containing the KV store hosts locations
    
    Returns:
    
    an array of KV hosts locations
  - getKvStoreName
```
public java.lang.String getKvStoreName()
```
    Gets the current KV store name
    
    Returns:
    
    a KV store name
  - getKvStoreSecurityFile
```
public java.lang.String getKvStoreSecurityFile()
```
  - getParentKey
```
public Key getParentKey()
```
    Gets the major key used to select NoSQL entries
    
    Returns:
  - getSubRange
```
public KeyRange getSubRange()
```
    Returns:
  - getTargetEntries
```
public java.util.Collection<java.lang.String> getTargetEntries()
```
  - getTimeOut
```
public long getTimeOut()
```
  - getTimeOutUnit
```
public java.util.concurrent.TimeUnit getTimeOutUnit()
```
  - load
```
public void load(Configuration conf)
```
    Description copied from interface: ConfigurationStorable
    
    Loads the current state from the given job configuration
    
    Specified by:
    
    load in interface ConfigurationStorable
  - removeAllTargetEntries
```
public void removeAllTargetEntries()
```
    Removes all the NoSQL minor keys that were added previously to be included in a job mapper value.
  - setBatchSize
```
public void setBatchSize(int batchSize)
```
    Sets the current batch size
    
    Parameters:
    
    batchSize -
  - setConfiguration
```
public void setConfiguration(Configuration configuration)
```
    Sets the current job configuration
    
    Parameters:
    
    configuration - a job configuration
  - setConsistency
```
public void setConsistency(Consistency consistency)
```
  - setDefaultEntryProcessorClass
```
public void setDefaultEntryProcessorClass(java.lang.Class<? extends NoSQLEntryProcessor> entryProcessorClass)
```
    Sets the default implementation of NoSQLEntryProcessor used for all the target entries for which an explicit entry processor was not specified
    
    Parameters:
    
    entryProcessorClass - a subclass of NoSQLEntryProcessor
  - setDepth
```
public void setDepth(Depth depth)
```
  - setEntryGrouperClass
```
public void setEntryGrouperClass(java.lang.Class<? extends NoSQLEntryGrouper> entryGrouperClass)
```
    Sets the NoSQLEntryGrouper subclass which is in charge of grouping key-value pairs into a single record
    
    Parameters:
    
    entryGrouperClass - a subclass of NoSQLEntryGrouper
  - setFormatterClassName
```
public void setFormatterClassName(java.lang.String formatterClassName)
```
  - setKvStoreHosts
```
public void setKvStoreHosts(java.lang.String[] kvStoreHosts)
```
    Sets an array containing the KV store hosts locations
    
    Parameters:
    
    kvStoreHosts - an array of KV hosts locations
  - setKvStoreName
```
public void setKvStoreName(java.lang.String kvStoreName)
```
    Sets the current KV store name
    
    Parameters:
    
    kvStoreName - a KV store name
  - setKvStoreSecurityFile
```
public void setKvStoreSecurityFile(java.lang.String kvStoreSecurityFile)
```
  - setParentKey
```
public void setParentKey(Key parentKey)
```
    Sets the major key used to select NoSQL entries
    
    Parameters:
    
    parentKey -
  - setSubRange
```
public void setSubRange(KeyRange subRange)
```
  - setTimeOut
```
public void setTimeOut(long timeOut)
```
  - store
```
public void store(Configuration conf)
```
    Description copied from interface: ConfigurationStorable
    
    Stores the current state into the given job configuration
    
    Specified by:
    
    store in interface ConfigurationStorable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class NoSQLConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARG_BATCH_SIZE

ARG_CONSISTENCY

ARG_DEFAULT_ENTRY_PROCESSOR

ARG_DEPTH

ARG_ENTRY_GROUPER

ARG_FORMATTER_CLASS

ARG_KVSTORE_HOSTS

ARG_KVSTORE_NAME

ARG_KVSTORE_SECURITY

ARG_PARENT_KEY

ARG_PARTITION_READER

ARG_RESULT_ENTRIES

ARG_SECURITY_PROPS

ARG_SUB_RANGE

ARG_TIME_OUT

ARG_TIME_OUT_UNIT

CONF_BATCH_SIZE

CONF_CONSISTENCY

CONF_DEFAULT_ENTRY_PROCESSOR

CONF_DEPTH

CONF_ENTRY_GROUPER

CONF_FORMATTER_CLASS

CONF_KVSTORE_HOSTS

CONF_KVSTORE_NAME

CONF_KVSTORE_SECURITY

CONF_PARENT_KEY

CONF_PARTITION_READER

CONF_RESULT_ENTRIES

CONF_SUB_RANGE

CONF_TIME_OUT

CONF_TIME_OUT_UNIT

DEFAULT_ENTRY_GROUPER_CLASS

Constructor Detail

NoSQLConfiguration

Method Detail

addTargetEntries

addTargetEntry

getBatchSize

getConfiguration

getConsistency

getDepth

getEntryGrouperClass

getEntryProcessor

getFormatterClassName

getKvSecurityProps

getKvStoreHosts

getKvStoreName

getKvStoreSecurityFile

getParentKey

getSubRange

getTargetEntries

getTimeOut

getTimeOutUnit

load

removeAllTargetEntries

setBatchSize

setConfiguration

setConsistency

setDefaultEntryProcessorClass

setDepth

setEntryGrouperClass

setFormatterClassName

setKvStoreHosts

setKvStoreName

setKvStoreSecurityFile

setParentKey

setSubRange

setTimeOut

store

toString