org.helenus.driver.impl

Class ClassInfoImpl.POJOContext

java.lang.Object

org.helenus.driver.impl.ClassInfoImpl.Context

org.helenus.driver.impl.ClassInfoImpl.POJOContext

All Implemented Interfaces:

StatementManager.Context<T>

Direct Known Subclasses:

RootClassInfoImpl.POJOContext, UDTClassInfoImpl.POJOContext

Enclosing class:

ClassInfoImpl<T>

public class ClassInfoImpl.POJOContext
extends ClassInfoImpl.Context

The POJOContext class provides a specific context for the POJO as referenced while building an insert or update statement.

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Field Summary

Fields

Modifier and Type	Field and Description
protected T	object Holds the POJO object

Fields inherited from class org.helenus.driver.impl.ClassInfoImpl.Context

keyspaceKeys

Constructor Summary

Constructors

Constructor and Description
POJOContext(T object) Instantiates a new POJOContext object.

Method Summary

Modifier and Type	Method and Description
void	addKeyspaceKey(String name) Adds a keyspace key to the context for use in keyspace name creation by retrieving its value from the associated POJO.
Pair<Object,CQLDataType>	getColumnNonEncodedValue(String tname, CharSequence name) Retrieves the specified column non-encoded value from the POJO and the specified table.
Pair<Object,CQLDataType>	getColumnValue(String tname, CharSequence name) Retrieves the specified column value from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getColumnValues(String tname) Retrieves all columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getColumnValues(String tname, CharSequence... names) Retrieves the specified columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getColumnValues(String tname, Iterable<CharSequence> names) Retrieves the specified columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getKeyspaceAndPartitionKeyColumnValues(String tname) Retrieves all keyspace and partition key columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getKeyspaceAndPrimaryKeyColumnValues(String tname) Retrieves all keyspace and primary key columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getKeyspaceKeyValues() Retrieves all keyspace keys and their values from the POJO.
Map<String,Pair<Object,CQLDataType>>	getMandatoryAndPrimaryKeyColumnValues(String tname) Retrieves all mandatory and primary key columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getNonPrimaryKeyColumnNonEncodedValues(String tname) Retrieves all non primary key columns and their non-encoded values from the POJO from the specified table.
T	getObject() Gets the POJO object associated with this context.
Map<String,Pair<Object,CQLDataType>>	getPartitionKeyColumnValues(String tname) Retrieves all partition key columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getPrimaryKeyColumnValues(String tname) Retrieves all primary key columns and their values from the POJO and the specified table.
Map<String,Pair<Object,CQLDataType>>	getPrimaryKeyColumnValues(String tname, Map<String,Object> pkeys_override) Retrieves all primary key columns and their values from the POJO and the specified table while giving priority to values provided by the specified override map.
protected void	populateKeyspaceKeys(Map<String,FieldInfoImpl<T>> fields) Populates the keyspace keys defined in the given map from the POJO.

Methods inherited from class org.helenus.driver.impl.ClassInfoImpl.Context

addKeyspaceKey, getClassInfo, getInitialObjects, getKeyspace, getObject, getObject, getObjectClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

object

protected final T object

Holds the POJO object

Constructor Detail

POJOContext

public POJOContext(T object)

Instantiates a new POJOContext object.

Parameters:

object - the POJO object

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is not of the appropriate class

Method Detail

populateKeyspaceKeys

protected void populateKeyspaceKeys(Map<String,FieldInfoImpl<T>> fields)

Populates the keyspace keys defined in the given map from the POJO.

Parameters:

fields - the map of keyspace key fields from the POJO where to extract the keyspace key values

getObject

public T getObject()

Gets the POJO object associated with this context.

Returns:

the POJO object associated with this context

getColumnValues

public Map<String,Pair<Object,CQLDataType>> getColumnValues(String tname)

Retrieves all columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all column/value pairs for the POJO

Throws:

IllegalArgumentException - if a mandatory column is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getPartitionKeyColumnValues

public Map<String,Pair<Object,CQLDataType>> getPartitionKeyColumnValues(String tname)

Retrieves all partition key columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all partition key column/value pairs for the POJO

Throws:

IllegalArgumentException - if a column is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getKeyspaceAndPartitionKeyColumnValues

public Map<String,Pair<Object,CQLDataType>> getKeyspaceAndPartitionKeyColumnValues(String tname)

Retrieves all keyspace and partition key columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all keyspace key and partition key column/value pairs for the POJO

Throws:

IllegalArgumentException - if a column or a keyspace key is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getPrimaryKeyColumnValues

public Map<String,Pair<Object,CQLDataType>> getPrimaryKeyColumnValues(String tname)

Retrieves all primary key columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all primary key column/value pairs for the POJO

Throws:

IllegalArgumentException - if a column is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getPrimaryKeyColumnValues

public Map<String,Pair<Object,CQLDataType>> getPrimaryKeyColumnValues(String tname,
                                                                      Map<String,Object> pkeys_override)

Retrieves all primary key columns and their values from the POJO and the specified table while giving priority to values provided by the specified override map.

Parameters:

tname - the name of the table from which to retrieve columns

pkeys_override - a non-null map of primary key values to use instead of those provided by the object

Returns:

a non-null map of all primary key column/value pairs for the POJO

Throws:

IllegalArgumentException - if a column is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getKeyspaceKeyValues

public Map<String,Pair<Object,CQLDataType>> getKeyspaceKeyValues()

Retrieves all keyspace keys and their values from the POJO.

Returns:

a non-null map of all keyspace key name/value pairs for the POJO

Throws:

IllegalArgumentException - if a keyspace key is missing from the POJO

ColumnPersistenceException - if unable to persist a keyspace key's value

getKeyspaceAndPrimaryKeyColumnValues

public Map<String,Pair<Object,CQLDataType>> getKeyspaceAndPrimaryKeyColumnValues(String tname)

Retrieves all keyspace and primary key columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all keyspace key and primary key column/value pairs for the POJO

Throws:

IllegalArgumentException - if a column or a keyspace key is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getMandatoryAndPrimaryKeyColumnValues

public Map<String,Pair<Object,CQLDataType>> getMandatoryAndPrimaryKeyColumnValues(String tname)

Retrieves all mandatory and primary key columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all mandatory and primary key column/value pairs for the POJO

Throws:

IllegalArgumentException - if a column is missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getNonPrimaryKeyColumnNonEncodedValues

public Map<String,Pair<Object,CQLDataType>> getNonPrimaryKeyColumnNonEncodedValues(String tname)

Retrieves all non primary key columns and their non-encoded values from the POJO from the specified table.

Note: The returned values should not be encoded.

Parameters:

tname - the name of the table from which to retrieve columns

Returns:

a non-null map of all non primary key column/value (non-encoded) pairs for the POJO

Throws:

IllegalArgumentException - if a mandatory column is missing from the POJO

getColumnNonEncodedValue

public Pair<Object,CQLDataType> getColumnNonEncodedValue(String tname,
                                                         CharSequence name)

Retrieves the specified column non-encoded value from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve the column

name - the name of the column to retrieve

Returns:

the column non-encoded value for the POJO

Throws:

IllegalArgumentException - if the column name is not defined by the POJO or is mandatory and missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getColumnValue

public Pair<Object,CQLDataType> getColumnValue(String tname,
                                               CharSequence name)

Retrieves the specified column value from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve the column

name - the name of the column to retrieve

Returns:

the column value for the POJO

Throws:

IllegalArgumentException - if the column name is not defined by the POJO or is mandatory and missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getColumnValues

public Map<String,Pair<Object,CQLDataType>> getColumnValues(String tname,
                                                            Iterable<CharSequence> names)

Retrieves the specified columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve the column

names - the names of the columns to retrieve

Returns:

a non-null map of all requested column/value pairs for the POJO

Throws:

IllegalArgumentException - if any of the column names are not defined by the POJO or is mandatory and missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

getColumnValues

public Map<String,Pair<Object,CQLDataType>> getColumnValues(String tname,
                                                            CharSequence... names)

Retrieves the specified columns and their values from the POJO and the specified table.

Parameters:

tname - the name of the table from which to retrieve the column

names - the names of the columns to retrieve

Returns:

a non-null map of all requested column/value pairs for the POJO

Throws:

IllegalArgumentException - if any of the column names are not defined by the POJO or is mandatory and missing from the POJO

ColumnPersistenceException - if unable to persist a column's value

addKeyspaceKey

public void addKeyspaceKey(String name)

Adds a keyspace key to the context for use in keyspace name creation by retrieving its value from the associated POJO.

Parameters:

name - the keyspace name

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the POJO doesn't require the specified keyspace key or if the value doesn't match the POJO's definition for the specified keyspace key

ExcludedKeyspaceKeyException - if the specified keyspace key value is marked as excluded the specified keyspace key