com.datastax.oss.driver.api.core.cql

Interface ColumnDefinitions

All Superinterfaces:

Detachable, Iterable<ColumnDefinition>

public interface ColumnDefinitions
extends Iterable<ColumnDefinition>, Detachable

Metadata about a set of CQL columns.

The default implementation returned by the driver is immutable and serializable. If you write your own implementation, it should at least be thread-safe; serializability is not mandatory, but recommended for use with some 3rd-party tools like Apache Spark ™.

Method Summary

Modifier and Type	Method and Description
boolean	contains(CqlIdentifier id) Whether there is a definition using the given CQL identifier.
boolean	contains(String name) Whether there is a definition using the given name.
int	firstIndexOf(CqlIdentifier id) Returns the index of the first column that uses the given identifier.
int	firstIndexOf(String name) Returns the index of the first column that uses the given name.
default ColumnDefinition	get(CqlIdentifier name) Get a definition by name.
ColumnDefinition	get(int i)
default ColumnDefinition	get(String name) Get a definition by name.
int	size()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.datastax.oss.driver.api.core.detach.Detachable

attach, isDetached

Method Detail

size

int size()

Returns:

the number of definitions contained in this metadata.

get

@NonNull
ColumnDefinition get(int i)

Parameters:

i - the index to check.

Returns:

the ith ColumnDefinition in this metadata.

Throws:

IndexOutOfBoundsException - if the index is invalid.

get

@NonNull
default ColumnDefinition get(@NonNull
                                      String name)

Get a definition by name.

This is the equivalent of:

   get(firstIndexOf(name))
 

Throws:

IllegalArgumentException - if the name does not exist (in other words, if !contains(name))).

See Also:

contains(String), firstIndexOf(String)

get

@NonNull
default ColumnDefinition get(@NonNull
                                      CqlIdentifier name)

Get a definition by name.

This is the equivalent of:

   get(firstIndexOf(name))
 

Throws:

IllegalArgumentException - if the name does not exist (in other words, if !contains(name))).

See Also:

contains(CqlIdentifier), firstIndexOf(CqlIdentifier)

contains

boolean contains(@NonNull
                 String name)

Whether there is a definition using the given name.

Because raw strings are ambiguous with regard to case-sensitivity, the argument will be interpreted according to the rules described in AccessibleByName.

contains

boolean contains(@NonNull
                 CqlIdentifier id)

Whether there is a definition using the given CQL identifier.

firstIndexOf

int firstIndexOf(@NonNull
                 String name)

Returns the index of the first column that uses the given name.

Because raw strings are ambiguous with regard to case-sensitivity, the argument will be interpreted according to the rules described in AccessibleByName.

Also, note that if multiple columns use the same name, there is no way to find the index for the next occurrences. One way to avoid this is to use aliases in your CQL queries.

firstIndexOf

int firstIndexOf(@NonNull
                 CqlIdentifier id)

Returns the index of the first column that uses the given identifier.

Note that if multiple columns use the same identifier, there is no way to find the index for the next occurrences. One way to avoid this is to use aliases in your CQL queries.