com.stratio.deep.config

Interface IDeepJobConfig<T,S extends IDeepJobConfig>

Type Parameters:

T - the generic type associated to this configuration object.

All Superinterfaces:

Serializable

All Known Subinterfaces:

ICassandraDeepJobConfig<T>, IMongoDeepJobConfig<T>

public interface IDeepJobConfig<T,S extends IDeepJobConfig>
extends Serializable

Defines the public methods that each Stratio Deep configuration object should implement.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Cell>	columnDefinitions() Fetches table metadata from the underlying datastore and generates a Map where the key is the column name, and the value is the Cell containing column's metadata.
S	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.
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.
int	getPageSize() Returns the maximum number of rows that will be retrieved when fetching data pages from Cassandra.
String	getPassword() Returns the password needed to authenticate to the remote datastore cluster.
String	getUsername() Returns the username used to authenticate to the cassandra server.
S	host(String hostname) Sets the datastore hostname
S	initialize() Initialized the current configuration object.
S	inputColumns(String... columns) Defines a projection over the CF columns.
S	pageSize(int pageSize) Sets the number of rows to retrieve for each page of data fetched from Cassandra. Defaults to 1000 rows.
S	password(String password) Sets the password to use to login to Cassandra.
S	username(String username) /** Sets the username to use to login to Cassandra.

Method Detail

getPassword

String getPassword()

Returns the password needed to authenticate to the remote datastore cluster.

Returns:

the password used to login to the remote cluster.

columnDefinitions

Map<String,Cell> columnDefinitions()

Fetches table metadata from the underlying datastore 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.

filterByField

S 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

S 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.

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.

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

S host(String hostname)

Sets the datastore hostname

Parameters:

hostname - the cassandra server endpoint.

Returns:

this object.

initialize

S initialize()

Initialized the current configuration object.

Returns:

this object.

inputColumns

S 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.

password

S password(String password)

Sets the password to use to login to Cassandra. Leave empty if you do not need authentication.

Returns:

this object.

username

S username(String username)

/** Sets the username to use to login to Cassandra. Leave empty if you do not need authentication.

Returns:

this object.

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