com.datastax.driver.mapping.annotations

Annotation Type Column

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface Column

Annotation that allows to specify the name of the CQL column to which the property should be mapped.

Note that this annotation is generally optional in the sense that any field or any getter method of a Java bean property of a class annotated by Table will be mapped by default to a column having the same name than this field / property, unless that field or method has the Transient annotation. As such, this annotation is mainly useful when the CQL column name does not correspond to the field or property name itself.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	caseSensitive Whether the value return by name() is case-sensitive (this has no effect if no name is provided in the annotation).
Class<? extends TypeCodec<?>>	codec A custom codec that will be used to serialize and deserialize the column.
String	name Name of the column being mapped in Cassandra.

Element Detail

name

public abstract String name

Name of the column being mapped in Cassandra. By default, the name returned by the NamingStrategy of the current MappingConfiguration.

Returns:

the name of the mapped column in Cassandra, or "" to use the naming strategy.

Default:

""

caseSensitive

public abstract boolean caseSensitive

Whether the value return by name() is case-sensitive (this has no effect if no name is provided in the annotation).

Returns:

whether the column name is case-sensitive.

Default:

false

codec

public abstract Class<? extends TypeCodec<?>> codec

A custom codec that will be used to serialize and deserialize the column.

Returns:

the codec's class. It must have a no-argument constructor (the mapper will create an instance and cache it).

Default:

com.datastax.driver.mapping.annotations.Defaults.NoCodec.class