com.datastax.driver.mapping

Interface MappedProperty<T>

public interface MappedProperty<T>

A Java property that is mapped to either a table column, a user-defined type (UDT) field, or a CQL expression such as "ttl(col1)".

Method Summary

Modifier and Type	Method and Description
TypeCodec<T>	getCustomCodec() Returns the codec to use to serialize and deserialize this property.
String	getMappedName() Returns the name of the table column or UDT field that this property maps to.
int	getPosition() Returns this property's zero-based position among partition key columns or clustering columns.
String	getPropertyName() Returns this property's name.
TypeToken<T>	getPropertyType() Returns this property's type.
T	getValue(Object entity) Reads the current value of this property in the given entity.
boolean	isClusteringColumn() Returns true if this property is a clustering column, false otherwise.
boolean	isComputed() Returns true if this property is computed, i.e.
boolean	isPartitionKey() Returns true if this property is part of the table's partition key, false otherwise.
void	setValue(Object entity, T value) Writes the given value to this property in the given entity.

Method Detail

getPropertyName

String getPropertyName()

Returns this property's name.

Returns:

this property's name; may not be null.

getMappedName

String getMappedName()

Returns the name of the table column or UDT field that this property maps to.

Note that case-sensitive identifiers should be quoted with Metadata.quote(java.lang.String)

In case of a computed property, this method should return the CQL expression to compute the property value, e.g. "ttl(col1)".

Returns:

the name of the table column or UDT field that this property maps to, or the CQL expression in case of computed properties; may not be null.

getPropertyType

TypeToken<T> getPropertyType()

Returns this property's type.

Returns:

this property's type; may not be null.

getCustomCodec

TypeCodec<T> getCustomCodec()

Returns the codec to use to serialize and deserialize this property.

If this method returns null, then a default codec for the property's type will be used.

Returns:

codec to use to serialize and deserialize this property.

isPartitionKey

boolean isPartitionKey()

Returns true if this property is part of the table's partition key, false otherwise.

This method has no effect if this property is mapped to a UDT field or a CQL expression.

Returns:

true if this property is part of the table's partition key, false otherwise.

See Also:

PartitionKey

isClusteringColumn

boolean isClusteringColumn()

Returns true if this property is a clustering column, false otherwise.

This method has no effect if this property is mapped to a UDT field or a CQL expression.

Returns:

true if this property is a clustering column, false otherwise.

See Also:

ClusteringColumn

getPosition

int getPosition()

Returns this property's zero-based position among partition key columns or clustering columns.

For example, assuming the following primary key definition: PRIMARY KEY ((col1, col2), col3, col4), col1 has position 0 (i.e. first partition key column), col2 has position 1 (i.e. second partition key column), col3 has position 0 (i.e. first clustering key column), col4 has position 1 (i.e. second clustering key column),

This method has no effect if this property is not part of the primary key, or if it is mapped to a UDT field or a CQL expression. Implementors are encouraged to return -1 in these situations.

Returns:

this property's zero-based position among partition key columns or clustering columns.

isComputed

boolean isComputed()

Returns true if this property is computed, i.e. if it represents the result of a CQL expression such as "ttl(col1)", false otherwise.

Computed properties are not allowed with protocol v1.

Also note that computed properties are read-only.

Returns:

true if this property is computed, false otherwise.

See Also:

Computed

getValue

T getValue(Object entity)

Reads the current value of this property in the given entity.

Parameters:

entity - The instance to read the property from; may not be null.

Returns:

The property value.

Throws:

IllegalArgumentException - if the property cannot be read.

setValue

void setValue(Object entity,
              T value)

Writes the given value to this property in the given entity.

Parameters:

entity - The instance to write the property to; may not be null.

value - The property value.

Throws:

IllegalArgumentException - if the property cannot be written.