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
default List<Integer>	allIndicesOf(CqlIdentifier id) Returns the indices of all columns that use the given identifier.
default List<Integer>	allIndicesOf(String name) Returns the indices of all columns that use the given name.
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.

allIndicesOf

@NonNull
default List<Integer> allIndicesOf(@NonNull
                                            String name)

Returns the indices of all columns that use 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.

Returns:

the indices, or an empty list if no column uses this name.

API note:

the default implementation only exists for backward compatibility. It wraps the result of firstIndexOf(String) in a singleton list, which is not entirely correct, as it will only return the first occurrence. Therefore it also logs a warning.

Implementors should always override this method (all built-in driver implementations do).

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.

Returns:

the index, or -1 if no column uses this name.

allIndicesOf

@NonNull
default List<Integer> allIndicesOf(@NonNull
                                            CqlIdentifier id)

Returns the indices of all columns that use the given identifier.

Returns:

the indices, or an empty list if no column uses this identifier.

API note:

the default implementation only exists for backward compatibility. It wraps the result of firstIndexOf(CqlIdentifier) in a singleton list, which is not entirely correct, as it will only return the first occurrence. Therefore it also logs a warning.

Implementors should always override this method (all built-in driver implementations do).

firstIndexOf

int firstIndexOf(@NonNull
                 CqlIdentifier id)

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

Returns:

the index, or -1 if no column uses this identifier.