IDeepJobConfig (deep commons 0.2.9 API)

Type Parameters:
T - the generic type associated to this configuration object.

All Superinterfaces:

Serializable
```
public interface IDeepJobConfig<T>
extends Serializable
```
Defines the public methods that each Stratio Deep configuration object should implement.

Method Summary

Methods
Modifier and Type	Method and Description
`IDeepJobConfig<T>`	`batchSize(int batchSize)` Sets the batch size used to write to Cassandra.
`IDeepJobConfig<T>`	`bisectFactor(int bisectFactor)` Sets the token range bisect factor.
`Map<String,Cell>`	`columnDefinitions()` Fetches table metadata from Casandra and generates a Map where the key is the column name, and the value is the `Cell` containing column's metadata.
`IDeepJobConfig<T>`	`columnFamily(String columnFamily)` Sets the cassandra CF from which data will be read from.
`IDeepJobConfig<T>`	`cqlPort(Integer port)` Sets cassandra host rpcPort.
`IDeepJobConfig<T>`	`createTableOnWrite(Boolean createTableOnWrite)` Whether or not to create the output column family on write. .
`IDeepJobConfig<T>`	`filterByField(String filterColumnName, Serializable filterValue)` Adds a new filter for the Cassandra underlying datastore. Once a new filter has been added, all subsequent queries generated to the underlying datastore will include the filter on the specified column called filterColumnName.
`Map<String,Serializable>`	`getAdditionalFilters()` Returns the map of additional filters specified by the user.
`int`	`getBatchSize()` Returns the batch size used for writing objects to the underying Cassandra datastore.
`int`	`getBisectFactor()`
`String`	`getColumnFamily()` Returns the name of the configured column family.
`Integer`	`getCqlPort()` CQL port where the remote Cassandra cluster is listening to.
`Class<T>`	`getEntityClass()` Returns the underlying testentity class used to map the Cassandra Column family.
`String`	`getHost()` Returns the hostname of the cassandra server.
`String[]`	`getInputColumns()` Returns the list of column names that will be fetched from the underlying datastore.
`Boolean`	`getIsWriteConfig()` Returns whether this configuration config is suitable for writing out data to the datastore.
`String`	`getKeyspace()` Returns the name of the keyspace.
`int`	`getPageSize()` Returns the maximum number of rows that will be retrieved when fetching data pages from Cassandra.
`String`	`getPartitionerClassName()` Returns the partitioner class name.
`String`	`getPassword()` Returns the password needed to authenticate to the remote cassandra cluster.
`String`	`getReadConsistencyLevel()` Returns the configured read consistency level.
`Integer`	`getRpcPort()` RPC port where the remote Cassandra cluster is listening to.
`com.datastax.driver.core.Session`	`getSession()` Returns the session opened to the cassandra server.
`String`	`getTable()` Returns the name of the configured column family.
`String`	`getUsername()` Returns the username used to authenticate to the cassandra server.
`String`	`getWriteConsistencyLevel()` Returns the configured write consistency level.
`IDeepJobConfig<T>`	`host(String hostname)` Sets the cassandra's hostname
`IDeepJobConfig<T>`	`initialize()` Initialized the current configuration object.
`IDeepJobConfig<T>`	`inputColumns(String... columns)` Defines a projection over the CF columns.
`Boolean`	`isCreateTableOnWrite()` Returns whether or not in this configuration object we specify to automatically create the output column family.
`IDeepJobConfig<T>`	`keyspace(String keyspace)` Sets Cassandra Keyspace.
`IDeepJobConfig<T>`	`pageSize(int pageSize)` Sets the number of rows to retrieve for each page of data fetched from Cassandra. Defaults to 1000 rows.
`IDeepJobConfig<T>`	`partitioner(String partitionerClassName)` Let's the user specify an alternative partitioner class.
`IDeepJobConfig<T>`	`password(String password)` Sets the password to use to login to Cassandra.
`IDeepJobConfig<T>`	`readConsistencyLevel(String level)` Sets read consistency level.
`IDeepJobConfig<T>`	`rpcPort(Integer port)` Sets cassandra host rpcPort.
`IDeepJobConfig<T>`	`session(com.datastax.driver.core.Session session)` Sets the session to use.
`IDeepJobConfig<T>`	`table(String table)` Sets the cassandra CF from which data will be read from.
`IDeepJobConfig<T>`	`username(String username)` /** Sets the username to use to login to Cassandra.
`IDeepJobConfig<T>`	`writeConsistencyLevel(String level)` Sets write consistency level.

- Method Detail
  - getSession
```
com.datastax.driver.core.Session getSession()
```
    Returns the session opened to the cassandra server.
    
    Returns:
    the Session opened by this configuration object to the cassandra server.
  - session
```
IDeepJobConfig<T> session(com.datastax.driver.core.Session session)
```
    Sets the session to use. If a session is not provided, this object will open a new one.
    
    Parameters:
    session - the session to use.
  - columnDefinitions
```
Map<String,Cell> columnDefinitions()
```
    Fetches table metadata from Casandra and generates a Map where the key is the column name, and the value is the Cell containing column's metadata.
    
    Returns:
    the map of column names and the corresponding Cell object containing its metadata.
  - table
```
IDeepJobConfig<T> table(String table)
```
    Sets the cassandra CF from which data will be read from.
    
    Parameters:
    table - the table name.
    
    Returns:
    this configuration object.
  - columnFamily
```
IDeepJobConfig<T> columnFamily(String columnFamily)
```
    Sets the cassandra CF from which data will be read from. Column family name is case sensitive.
    
    Parameters:
    columnFamily - the table name data will be fetched from.
    
    Returns:
    this configuration object.
  - filterByField
```
IDeepJobConfig<T> filterByField(String filterColumnName,
                              Serializable filterValue)
```
    Adds a new filter for the Cassandra underlying datastore.
    Once a new filter has been added, all subsequent queries generated to the underlying datastore will include the filter on the specified column called filterColumnName. Before propagating the filter we check if an index exists in Cassandra.
    
    Parameters:
    filterColumnName - the name of the columns (as known by the datastore) to filter on.
    filterValue - the value of the filter to use. May be any expression, depends on the actual index implementation.
    
    Returns:
    this configuration object.
    
    Throws:
    
    DeepIndexNotFoundException - if the specified field has not been indexed in Cassandra.
    
    DeepNoSuchFieldException - if the specified field is not a valid column in Cassandra.
  - pageSize
```
IDeepJobConfig<T> pageSize(int pageSize)
```
    Sets the number of rows to retrieve for each page of data fetched from Cassandra.
    Defaults to 1000 rows.
    
    Parameters:
    pageSize - the number of rows per page
    
    Returns:
    this configuration object.
  - getColumnFamily
```
String getColumnFamily()
```
    Returns the name of the configured column family.
    
    Returns:
    the configured column family.
  - getEntityClass
```
Class<T> getEntityClass()
```
    Returns the underlying testentity class used to map the Cassandra Column family.
    
    Returns:
    the entity class object associated to this configuration object.
  - getHost
```
String getHost()
```
    Returns the hostname of the cassandra server.
    
    Returns:
    the endpoint of the cassandra server.
  - getInputColumns
```
String[] getInputColumns()
```
    Returns the list of column names that will be fetched from the underlying datastore.
    
    Returns:
    the array of column names that will be retrieved from the data store.
  - getKeyspace
```
String getKeyspace()
```
    Returns the name of the keyspace.
    
    Returns:
    the name of the configured keyspace.
  - getPartitionerClassName
```
String getPartitionerClassName()
```
    Returns the partitioner class name.
    
    Returns:
    the partitioner class name.
  - getPassword
```
String getPassword()
```
    Returns the password needed to authenticate to the remote cassandra cluster.
    
    Returns:
    the password used to login to the remote cluster.
  - getRpcPort
```
Integer getRpcPort()
```
    RPC port where the remote Cassandra cluster is listening to. Defaults to 9160.
    
    Returns:
    the thrift port.
  - getCqlPort
```
Integer getCqlPort()
```
    CQL port where the remote Cassandra cluster is listening to. Defaults to 9042.
    
    Returns:
    the cql port.
  - getUsername
```
String getUsername()
```
    Returns the username used to authenticate to the cassandra server. Defaults to the empty string.
    
    Returns:
    the username to use to login to the remote server.
  - host
```
IDeepJobConfig<T> host(String hostname)
```
    Sets the cassandra's hostname
    
    Parameters:
    hostname - the cassandra server endpoint.
    
    Returns:
    this object.
  - initialize
```
IDeepJobConfig<T> initialize()
```
    Initialized the current configuration object.
    
    Returns:
    this object.
  - inputColumns
```
IDeepJobConfig<T> inputColumns(String... columns)
```
    Defines a projection over the CF columns.
    Key columns will always be returned, even if not specified in the columns input array.
    
    Parameters:
    columns - list of columns we want to retrieve from the datastore.
    
    Returns:
    this object.
  - keyspace
```
IDeepJobConfig<T> keyspace(String keyspace)
```
    Sets Cassandra Keyspace.
    
    Parameters:
    keyspace - the keyspace to use.
    
    Returns:
    this object.
  - bisectFactor
```
IDeepJobConfig<T> bisectFactor(int bisectFactor)
```
    Sets the token range bisect factor. The provided number must be a power of two. Defaults to 1.
    
    Parameters:
    bisectFactor - the bisect factor to use.
    
    Returns:
    this configuration object.
  - partitioner
```
IDeepJobConfig<T> partitioner(String partitionerClassName)
```
    Let's the user specify an alternative partitioner class. The default partitioner is org.apache.cassandra.dht.Murmur3Partitioner.
    
    Parameters:
    partitionerClassName - the partitioner class name.
    
    Returns:
    this object.
  - password
```
IDeepJobConfig<T> password(String password)
```
    Sets the password to use to login to Cassandra. Leave empty if you do not need authentication.
    
    Returns:
    this object.
  - rpcPort
```
IDeepJobConfig<T> rpcPort(Integer port)
```
    Sets cassandra host rpcPort.
    
    Parameters:
    port - the thrift port number.
    
    Returns:
    this object.
  - cqlPort
```
IDeepJobConfig<T> cqlPort(Integer port)
```
    Sets cassandra host rpcPort.
    
    Parameters:
    port - the cql port number.
    
    Returns:
    this object.
  - username
```
IDeepJobConfig<T> username(String username)
```
    /** Sets the username to use to login to Cassandra. Leave empty if you do not need authentication.
    
    Returns:
    this object.
  - batchSize
```
IDeepJobConfig<T> batchSize(int batchSize)
```
    Sets the batch size used to write to Cassandra.
    
    Returns:
    this object.
  - createTableOnWrite
```
IDeepJobConfig<T> createTableOnWrite(Boolean createTableOnWrite)
```
    Whether or not to create the output column family on write.
    .
    Defaults to FALSE.
    
    Parameters:
    createTableOnWrite - a boolean that tells this configuration obj to create missing tables on write.
    
    Returns:
    this configuration object.
  - isCreateTableOnWrite
```
Boolean isCreateTableOnWrite()
```
    Returns whether or not in this configuration object we specify to automatically create the output column family.
    
    Returns:
    true if this configuration object has been configured to create missing tables on writes.
  - getReadConsistencyLevel
```
String getReadConsistencyLevel()
```
    Returns the configured read consistency level.
    
    Returns:
    the read consistency level.
  - getWriteConsistencyLevel
```
String getWriteConsistencyLevel()
```
    Returns the configured write consistency level.
    
    Returns:
    the write consistency level.
  - readConsistencyLevel
```
IDeepJobConfig<T> readConsistencyLevel(String level)
```
    Sets read consistency level.
    Can be one of those consistency levels defined in ConsistencyLevel.
    Defaults to ConsistencyLevel.LOCAL_ONE.
    
    Parameters:
    level - the read consistency level to use.
    
    Returns:
    this configuration object.
  - writeConsistencyLevel
```
IDeepJobConfig<T> writeConsistencyLevel(String level)
```
    Sets write consistency level.
    Can be one of those consistency levels defined in ConsistencyLevel.
    Defaults to ConsistencyLevel.LOCAL_ONE.
    
    Parameters:
    level - the write consistency level to use.
    
    Returns:
    this configuration object.
  - getTable
```
String getTable()
```
    Returns the name of the configured column family. Column family name is case sensitive.
    
    Returns:
    the table name.
  - getBatchSize
```
int getBatchSize()
```
    Returns the batch size used for writing objects to the underying Cassandra datastore.
    
    Returns:
    the batch size.
  - getAdditionalFilters
```
Map<String,Serializable> getAdditionalFilters()
```
    Returns the map of additional filters specified by the user.
    
    Returns:
    the map of configured additional filters.
  - getPageSize
```
int getPageSize()
```
    Returns the maximum number of rows that will be retrieved when fetching data pages from Cassandra.
    
    Returns:
    the page size
  - getIsWriteConfig
```
Boolean getIsWriteConfig()
```
    Returns whether this configuration config is suitable for writing out data to the datastore.
    
    Returns:
    true if this configuratuon object is suitable for writing to cassandra, false otherwise.
  - getBisectFactor
```
int getBisectFactor()
```
    Returns:
    the configured bisect factor.

Interface IDeepJobConfig<T>

Method Summary

Method Detail

getSession

session

columnDefinitions

table

columnFamily

filterByField

pageSize

getColumnFamily

getEntityClass

getHost

getInputColumns

getKeyspace

getPartitionerClassName

getPassword

getRpcPort

getCqlPort

getUsername

host

initialize

inputColumns

keyspace

bisectFactor

partitioner

password

rpcPort

cqlPort

username

batchSize

createTableOnWrite

isCreateTableOnWrite

getReadConsistencyLevel

getWriteConsistencyLevel

readConsistencyLevel

writeConsistencyLevel

getTable

getBatchSize

getAdditionalFilters

getPageSize

getIsWriteConfig

getBisectFactor