com.stratio.deep.entity

Class Cell

java.lang.Object

com.stratio.deep.entity.Cell

All Implemented Interfaces:

Serializable

public final class Cell
extends Object
implements Serializable

Generic abstraction for cassandra's columns.

Author:

Luca Rosellini

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static Cell	create(Cell metadata, ByteBuffer cellValue) Factory method, creates a new Cell from its value and metadata information
static Cell	create(Cell metadata, Object cellValue) Factory method, creates a new Cell from its value and metadata information
static <E extends IDeepType> Cell	create(E e, Field field) Constructs a Cell from a DeepField property.
static Cell	create(String cellName) Factory method, builds a new Cell (isPartitionKey = false and isClusterKey = false) with value = null.
static Cell	create(String cellName, com.datastax.driver.core.DataType cellType, Boolean isPartitionKey, Boolean isClusterKey) Factory method, creates a new metadata Cell, i.e.
static Cell	create(String cellName, Object cellValue) Factory method, builds a new Cell (isPartitionKey = false and isClusterKey = false).
static Cell	create(String cellName, Object cellValue, Boolean isPartitionKey, Boolean isClusterKey) Factory method, creates a new Cell.
boolean	equals(Object o) Two Cell are considered equal if and only if the following properties are equal: cellName cellValue isClusterKey isPartitionKey validator
String	getCellName()
CellValidator	getCellValidator()
Object	getCellValue() Returns the composed cell value.
ByteBuffer	getDecomposedCellValue() Returns the cell value as a ByteBuffer, performs the conversion using the configured validator.
Class<?>	getValueType() Returns the Java type corresponding to the current Cell.
static CellValidator	getValueType(com.datastax.driver.core.DataType obj) Calculates the Cassandra validator type given the value class type. There's a shortcoming in the case of an UUID.
static CellValidator	getValueType(Object obj) Calculates the Cassandra marshaller given the cell value.
int	hashCode()
Boolean	isClusterKey()
Boolean	isPartitionKey()
org.apache.cassandra.db.marshal.AbstractType	marshaller()
String	marshallerClassName()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Cell create(Cell metadata,
          Object cellValue)

Factory method, creates a new Cell from its value and metadata information

Parameters:

metadata - the cell object carrying the metadata for this new cell

cellValue - the cell value, provided as a ByteBuffer.

Returns:

an instance of a Cell object for the provided parameters.

create

public static Cell create(Cell metadata,
          ByteBuffer cellValue)

Factory method, creates a new Cell from its value and metadata information

Parameters:

metadata - the cell object carrying the metadata for this new cell

cellValue - the cell value, provided as a ByteBuffer.

Returns:

an instance of a Cell object for the provided parameters.

create

public static Cell create(String cellName,
          Object cellValue)

Factory method, builds a new Cell (isPartitionKey = false and isClusterKey = false). The validator will be automatically calculated using the value object type.

Parameters:

cellName - the cell name

cellValue - the cell value, provided as a ByteBuffer.

Returns:

an instance of a Cell object for the provided parameters.

create

public static Cell create(String cellName)

Factory method, builds a new Cell (isPartitionKey = false and isClusterKey = false) with value = null. The validator will be automatically calculated using the value object type.

Parameters:

cellName - the cell name

Returns:

an instance of a Cell object for the provided parameters.

create

public static Cell create(String cellName,
          Object cellValue,
          Boolean isPartitionKey,
          Boolean isClusterKey)

Factory method, creates a new Cell.

Parameters:

cellName - the cell name

cellValue - the cell value, provided as a ByteBuffer.

isPartitionKey - true if this cell is part of the cassandra's partition key.

isClusterKey - true if this cell is part of the cassandra's clustering key.

Returns:

an instance of a Cell object for the provided parameters.

create

public static Cell create(String cellName,
          com.datastax.driver.core.DataType cellType,
          Boolean isPartitionKey,
          Boolean isClusterKey)

Factory method, creates a new metadata Cell, i.e. a Cell without value.

Parameters:

cellName - the cell name

cellType - the cell value type.

isPartitionKey - true if this cell is part of the cassandra's partition key.

isClusterKey - true if this cell is part of the cassandra's clustering key.

Returns:

an instance of a Cell object for the provided parameters.

create

public static <E extends IDeepType> Cell create(E e,
                                Field field)

Constructs a Cell from a DeepField property.

Type Parameters:

E - a subclass of IDeepType.

Parameters:

e - instance of the testentity whose field is going to generate a Cell.

field - field that will generate the Cell.

Returns:

an instance of a Cell object for the provided parameters.

getValueType

public static CellValidator getValueType(com.datastax.driver.core.DataType obj)

Calculates the Cassandra validator type given the value class type.
There's a shortcoming in the case of an UUID. At this level we are not able to distinguish between an UUID or a TimeUUID because twe don't have the UUID value.

Parameters:

obj - the value class type.

Returns:

the CellValidator object associated to this cell.

getValueType

public static CellValidator getValueType(Object obj)

Calculates the Cassandra marshaller given the cell value.

Parameters:

obj - the cell value.

Returns:

the CellValidator object associated to this cell.

getCellValidator

public CellValidator getCellValidator()

Returns:

Returns the validator object associated to this Cell.

equals

public boolean equals(Object o)

Two Cell are considered equal if and only if the following properties are equal:

1. cellName
2. cellValue
3. isClusterKey
4. isPartitionKey
5. validator

Overrides:

equals in class Object

Parameters:

o - the object instance we want to compare to this object.

Returns:

either true or false if this Cell is equal to the one supplied as an argument.

getValueType

public Class<?> getValueType()

Returns the Java type corresponding to the current Cell.

Returns:

the Java type corresponding to the current Cell.

getCellName

public String getCellName()

Returns:

the name of the current cell as defined in the database.

getCellValue

public Object getCellValue()

Returns the composed cell value. The type of the returned object can be obtained by calling getValueType(com.datastax.driver.core.DataType)

Returns:

the composed cell value.

getDecomposedCellValue

public ByteBuffer getDecomposedCellValue()

Returns the cell value as a ByteBuffer, performs the conversion using the configured validator.

If cell value is null we propagate an empty array, see CASSANDRA-5885 and CASSANDRA-6180.

Returns:

Returns the cell value as a ByteBuffer.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isClusterKey

public Boolean isClusterKey()

Returns:

true if the current cell is part of the clustering key.

isPartitionKey

public Boolean isPartitionKey()

Returns:

true if the current cell is part of the partition key.

marshaller

public org.apache.cassandra.db.marshal.AbstractType marshaller()

Returns:

Returns the Cassandra validator instance associated to this cell.

marshallerClassName

public String marshallerClassName()

Returns:

the fully qualified class name of the cassandra validator associated to this cell.

toString

public String toString()

Overrides:

toString in class Object