ColumnDefinitions (Cassandra JDBC Wrapper 4.13.0 API)

java.lang.Object
- com.ing.data.cassandra.jdbc.ColumnDefinitions

All Implemented Interfaces:

Iterable<ColumnDefinitions.Definition>
```
public class ColumnDefinitions
extends Object
implements Iterable<ColumnDefinitions.Definition>
```
Metadata describing the columns returned in a CassandraResultSet or a CassandraPreparedStatement.
A ColumnDefinitions instance is mainly a list of ColumnDefinitions.Definition. The definitions or metadata for a column can be accessed either by:
- index (indexed from 0)
- name
When accessed by name, column selection is case insensitive. In case multiple columns only differ by the case of their name, then the column returned will be the first column that has been defined in CQL without forcing case sensitivity (that is, it has either been defined without quotes or is fully lowercase). If none of the columns have been defined in this manner, the first column matching (with case insensitivity) is returned. You can force the case of a selection by using double quotes (") around the name.

For example, considering cd an instance of ColumnDefinitions:
- if cd contains column bAR, then cd.contains("bar"), cd.contains("bAR") and cd.contains("Bar") will return true
- if cd contains both foo and FOO then:
  - cd.getType("foo"), cd.getType("fOO") and cd.getType("FOO") will all match the column foo
  - cd.getType("\"FOO\"") will match the column FOO
Note that the preceding rules mean that if a ColumnDefinitions object contains multiple occurrences of the exact same name (either the same column multiple times or columns from different tables with the same name), you will have to use selection by index to disambiguate.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ColumnDefinitions.Definition
A column definition.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ColumnDefinitions.Definition` A column definition.

Constructor Summary

Constructors
Constructor and Description

ColumnDefinitions(ColumnDefinitions.Definition[] definitions)
Constructor.

Constructors
Constructor and Description
`ColumnDefinitions(ColumnDefinitions.Definition[] definitions)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ColumnDefinitions.Definition>`	`asList()` Returns a list containing all the definitions of these metadata ordered by index.
`boolean`	`contains(String name)` Returns whether these metadata contains a given name.
`int`	`getIndexOf(String name)` Returns the first index in these metadata of the provided column name, if present.
`String`	`getKeyspace(int i)` Returns the keyspace of the `i`th column in these metadata.
`String`	`getKeyspace(String name)` Returns the keyspace of the first occurrence of the column `name` in these metadata.
`String`	`getName(int i)` Returns the name of the `i`th column in these metadata.
`String`	`getTable(int i)` Returns the table name of the `i`th column in these metadata.
`String`	`getTable(String name)` Returns the table name of the first occurrence of the column `name` in these metadata.
`com.datastax.oss.driver.api.core.type.DataType`	`getType(int i)` Returns the type of the `i`th column in these metadata.
`com.datastax.oss.driver.api.core.type.DataType`	`getType(String name)` Returns the type of the first occurrence of the column `name` in these metadata.
`Iterator<ColumnDefinitions.Definition>`	`iterator()` Returns an iterator over the `ColumnDefinitions.Definition` contained in these metadata.
`int`	`size()` Returns the number of columns described by this `ColumnDefinitions` instance.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ColumnDefinitions
```
public ColumnDefinitions(ColumnDefinitions.Definition[] definitions)
```
    Constructor.
    
    Parameters:
    
    definitions - Array of columns definitions.
- Method Detail
  - size
```
public int size()
```
    Returns the number of columns described by this ColumnDefinitions instance.
    
    Returns:
    
    The number of columns described by these metadata.
  - contains
```
public boolean contains(String name)
```
    Returns whether these metadata contains a given name.
    
    Parameters:
    
    name - The name to check.
    
    Returns:
    
    true if these metadata contains the column named name, false otherwise.
  - getIndexOf
```
public int getIndexOf(String name)
```
    Returns the first index in these metadata of the provided column name, if present.
    
    Parameters:
    
    name - The name of the column.
    
    Returns:
    
    The index of the first occurrence of the column name in these metadata if present, -1 otherwise.
  - iterator
```
@Nonnull
public Iterator<ColumnDefinitions.Definition> iterator()
```
    Returns an iterator over the ColumnDefinitions.Definition contained in these metadata.
    The order of the iterator will be the one of these metadata.
    
    Specified by:
    
    iterator in interface Iterable<ColumnDefinitions.Definition>
    
    Returns:
    
    An iterator over the ColumnDefinitions.Definition contained in these metadata.
  - asList
```
public List<ColumnDefinitions.Definition> asList()
```
    Returns a list containing all the definitions of these metadata ordered by index.
    
    Returns:
    
    A list of the ColumnDefinitions.Definition contained in these metadata.
  - getName
```
public String getName(int i)
```
    Returns the name of the ith column in these metadata.
    
    Parameters:
    
    i - The index of the column in these metadata (the first column is 0).
    
    Returns:
    
    The name of the ith column in these metadata.
    
    Throws:
    
    IndexOutOfBoundsException - if i < 0 or i >= size().
  - getType
```
public com.datastax.oss.driver.api.core.type.DataType getType(int i)
```
    Returns the type of the ith column in these metadata.
    
    Parameters:
    
    i - The index of the column in these metadata (the first column is 0).
    
    Returns:
    
    The type of the ith column in these metadata.
    
    Throws:
    
    IndexOutOfBoundsException - if i < 0 or i >= size().
  - getType
```
public com.datastax.oss.driver.api.core.type.DataType getType(String name)
```
    Returns the type of the first occurrence of the column name in these metadata.
    
    Parameters:
    
    name - The name of the column.
    
    Returns:
    
    The type of (the first occurrence of) the column name in these metadata.
    
    Throws:
    
    IllegalArgumentException - if name is not in these metadata.
  - getKeyspace
```
public String getKeyspace(int i)
```
    Returns the keyspace of the ith column in these metadata.
    
    Parameters:
    
    i - The index of the column in these metadata (the first column is 0).
    
    Returns:
    
    The keyspace of the ith column in these metadata.
    
    Throws:
    
    IndexOutOfBoundsException - if i < 0 or i >= size().
  - getKeyspace
```
public String getKeyspace(String name)
```
    Returns the keyspace of the first occurrence of the column name in these metadata.
    
    Parameters:
    
    name - The name of the column.
    
    Returns:
    
    The keyspace of (the first occurrence of) the column name in these metadata.
    
    Throws:
    
    IllegalArgumentException - if name is not in these metadata.
  - getTable
```
public String getTable(int i)
```
    Returns the table name of the ith column in these metadata.
    
    Parameters:
    
    i - The index of the column in these metadata (the first column is 0).
    
    Returns:
    
    The table name of the ith column in these metadata.
    
    Throws:
    
    IndexOutOfBoundsException - if i < 0 or i >= size().
  - getTable
```
public String getTable(String name)
```
    Returns the table name of the first occurrence of the column name in these metadata.
    
    Parameters:
    
    name - The name of the column.
    
    Returns:
    
    The table name of (the first occurrence of) the column name in these metadata.
    
    Throws:
    
    IllegalArgumentException - if name is not in these metadata.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ColumnDefinitions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ColumnDefinitions

Method Detail

size

contains

getIndexOf

iterator

asList

getName

getType

getType

getKeyspace

getKeyspace

getTable

getTable

toString