ClassInfoImpl (Helenus Implementation 1.0.12 API)

java.lang.Object
- org.helenus.driver.impl.ClassInfoImpl<T>

Type Parameters:

T - The type of POJO represented by this class

All Implemented Interfaces:

Iterable<TableInfo<T>>, ClassInfo<T>

Direct Known Subclasses:

RootClassInfoImpl, TypeClassInfoImpl, UDTClassInfoImpl
```
public class ClassInfoImpl<T>
extends Object
implements ClassInfo<T>
```
The ClassInfo class provides information about a particular POJO class.

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle, vasu - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ClassInfoImpl.Context` The `Context` class provides a specific context for the POJO as referenced while building a statement.
`class`	`ClassInfoImpl.POJOContext` The `POJOContext` class provides a specific context for the POJO as referenced while building an insert or update statement.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Class<T>`	`clazz` Holds the class for the POJO.
`protected Constructor<T>`	`constructor` Holds the default serialization constructor to use to instantiate a blank POJO.
`protected Class<? extends Annotation>`	`entityAnnotationClass` Holds the entity annotation class used to annotated the POJO class.
`protected Map<Field,Object>`	`finalFields` Holds the map of all final fields with their default values.
`protected Map<String,FieldInfoImpl<T>>`	`suffixesByName` Holds a map of all fields annotated as suffixes keyed by the suffix name.
`protected Map<String,FieldInfoImpl<T>>`	`suffixesByType` Holds a map of all fields annotated as suffixes keyed by the suffix type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.stream.Stream<ClassInfoImpl<? extends T>>`	`classInfos()` Gets all class infos (including type classes if this is a root class) for the POJO.
`Optional<TableInfo<T>>`	`getAuditTable()`
`Collection<String>`	`getColumns()` Retrieves all columns from the POJO no matter which table they are defined in.
`Object`	`getDefaultValue(Field field)` Gets the default value for the specified final field.
`Class<? extends Annotation>`	`getEntityAnnotationClass()` Gets the entity annotation class used to annotated the POJO class.
`Collection<T>`	`getInitialObjects(Map<String,String> suffixes)`
`Keyspace`	`getKeyspace()` Gets the keyspace annotation for this POJO.
`int`	`getNumSuffixKeys()`
`int`	`getNumTables()`
`T`	`getObject(com.datastax.driver.core.Row row, Map<String,Object> suffixes)` Converts the specified result row into a POJO object defined by this class information and suffix map.
`T`	`getObject(com.datastax.driver.core.UDTValue uval)` Converts the specified UDT value into a POJO object defined by this class information.
`Class<T>`	`getObjectClass()` Gets the class of POJO represented by this class info object.
`Optional<TableInfo<T>>`	`getPrimaryTable()`
`FieldInfo<T>`	`getSuffixKey(String name)`
`FieldInfo<T>`	`getSuffixKeyByType(String type)`
`Map<String,FieldInfoImpl<T>>`	`getSuffixKeys()` Gets the field info for all suffix keys defined by this POJO.
`Map<String,FieldInfoImpl<T>>`	`getSuffixTypes()` Gets the field info for all suffix types defined by this POJO.
`TableInfo<T>`	`getTable(String name)`
`TableInfoImpl<T>`	`getTableImpl(String name)` Gets the table info corresponding to the given table name.
`Collection<TableInfo<T>>`	`getTables()`
`protected Collection<TableInfoImpl<T>>`	`getTablesImpl()` Gets the tables info defined by the POJO.
`boolean`	`isColumn(String name)` Checks if the specified name is defined as a column for any tables.
`boolean`	`isSuffixKey(String name)` Checks if the specified name is defined as a suffix key.
`Iterator<TableInfo<T>>`	`iterator()`
`ClassInfoImpl.Context`	`newContext()` Creates a new context for this class info.
`ClassInfoImpl.POJOContext`	`newContext(T object)` Creates a new context for this class info with the given POJO object.
`java.util.stream.Stream<Class<? extends T>>`	`objectClasses()` Gets all classes (including type classes if this is a root class) for the POJO represented by this class info object.
`boolean`	`supportsTablesAndIndexes()`
`java.util.stream.Stream<TableInfo<T>>`	`tables()`
`protected java.util.stream.Stream<TableInfoImpl<T>>`	`tablesImpl()` Gets the tables info defined by the POJO.
`java.util.stream.Stream<UDTClassInfoImpl<?>>`	`udts()` Gets all user-defined types the pojo class represented by this class is dependent on.
`void`	`validateColumn(Object name)` Validates if a column is defined by the POJO in any tables.
`void`	`validateColumnAndValue(String name, Object value)` Validates if a column is defined by the POJO and its potential value in any table.
`void`	`validateColumnOrSuffix(String name)` Validates if a column is defined by the POJO in any tables or if it is defined as a suffix key.
`void`	`validateColumns(Iterable<Object> names)` Validates if specified columns are defined by the POJO in any tables.
`void`	`validateColumns(String... names)` Validates if specified columns are defined by the POJO in any table.
`void`	`validateSuffix(String suffix, Object value)` Validates the specified suffix and its value as being a valid suffix for the POJO.

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

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

- Field Detail
  - entityAnnotationClass
```
protected final Class<? extends Annotation> entityAnnotationClass
```
    Holds the entity annotation class used to annotated the POJO class.
  - clazz
```
protected final Class<T> clazz
```
    Holds the class for the POJO.
  - constructor
```
protected final Constructor<T> constructor
```
    Holds the default serialization constructor to use to instantiate a blank POJO.
  - finalFields
```
protected final Map<Field,Object> finalFields
```
    Holds the map of all final fields with their default values.
  - suffixesByName
```
protected final Map<String,FieldInfoImpl<T>> suffixesByName
```
    Holds a map of all fields annotated as suffixes keyed by the suffix name.
  - suffixesByType
```
protected final Map<String,FieldInfoImpl<T>> suffixesByType
```
    Holds a map of all fields annotated as suffixes keyed by the suffix type.
- Method Detail
  - tablesImpl
```
protected java.util.stream.Stream<TableInfoImpl<T>> tablesImpl()
```
    Gets the tables info defined by the POJO.
    
    Returns:
    
    a stream of all defined tables info
  - getTablesImpl
```
protected Collection<TableInfoImpl<T>> getTablesImpl()
```
    Gets the tables info defined by the POJO.
    
    Returns:
    
    a collection of all defined tables info
  - getEntityAnnotationClass
```
public Class<? extends Annotation> getEntityAnnotationClass()
```
    Gets the entity annotation class used to annotated the POJO class.
    
    Returns:
    
    the entity annotation class used to annotated the POJO class
  - getObjectClass
```
public Class<T> getObjectClass()
```
    Gets the class of POJO represented by this class info object.
    
    Specified by:
    
    getObjectClass in interface ClassInfo<T>
    
    Returns:
    
    the non-null type of POJO represented by this class info
  - supportsTablesAndIndexes
```
public boolean supportsTablesAndIndexes()
```
    Specified by:
    
    supportsTablesAndIndexes in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.supportsTablesAndIndexes()
  - objectClasses
```
public java.util.stream.Stream<Class<? extends T>> objectClasses()
```
    Gets all classes (including type classes if this is a root class) for the POJO represented by this class info object.
    
    Returns:
    
    a stream of classes of POJOs (including type classes if this is a root class) represented by this class info
  - classInfos
```
public java.util.stream.Stream<ClassInfoImpl<? extends T>> classInfos()
```
    Gets all class infos (including type classes if this is a root class) for the POJO.
    
    Returns:
    
    a stream of all class infos (including type classes if this is a root class) for the POJO
  - udts
```
public java.util.stream.Stream<UDTClassInfoImpl<?>> udts()
```
    Gets all user-defined types the pojo class represented by this class is dependent on.
    
    Returns:
    
    a stream of all class infos for the user-defined types the pojo class depends on
  - getDefaultValue
```
public Object getDefaultValue(Field field)
```
    Gets the default value for the specified final field.
    
    Parameters:
    
    field - the non-null final field for which to gets its default value
    
    Returns:
    
    the corresponding default value
    
    Throws:
    
    IllegalArgumentException - if the field is not a defined final field for the associated class or one of its super class up to and excluding the first one that is not annotated with the entity annotation
  - getKeyspace
```
public Keyspace getKeyspace()
```
    Gets the keyspace annotation for this POJO.
    
    Specified by:
    
    getKeyspace in interface ClassInfo<T>
    
    Returns:
    
    the non-null keyspace annotation for this POJO
  - getNumSuffixKeys
```
public int getNumSuffixKeys()
```
    Specified by:
    
    getNumSuffixKeys in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getNumSuffixKeys()
  - getSuffixKey
```
public FieldInfo<T> getSuffixKey(String name)
```
    Specified by:
    
    getSuffixKey in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getSuffixKey(java.lang.String)
  - getSuffixKeyByType
```
public FieldInfo<T> getSuffixKeyByType(String type)
```
    Specified by:
    
    getSuffixKeyByType in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getSuffixKeyByType(java.lang.String)
  - isSuffixKey
```
public boolean isSuffixKey(String name)
```
    Checks if the specified name is defined as a suffix key.
    
    Parameters:
    
    name - the name of the suffix key
    
    Returns:
    
    true if that name is defined as a suffix key; false otherwise
  - getSuffixKeys
```
public Map<String,FieldInfoImpl<T>> getSuffixKeys()
```
    Gets the field info for all suffix keys defined by this POJO.
    
    Returns:
    
    the non-null map of all suffix key fields keyed by their names
  - getSuffixTypes
```
public Map<String,FieldInfoImpl<T>> getSuffixTypes()
```
    Gets the field info for all suffix types defined by this POJO.
    
    Returns:
    
    the non-null map of all suffix type fields keyed by their types
  - getTableImpl
```
public TableInfoImpl<T> getTableImpl(String name)
```
    Gets the table info corresponding to the given table name.
    
    Parameters:
    
    name - the name of the table to get
    
    Returns:
    
    the corresponding table info
    
    Throws:
    
    NullPointerException - if name is null
    
    IllegalArgumentException - if the specified table is not defined by the POJO
  - getTable
```
public TableInfo<T> getTable(String name)
```
    Specified by:
    
    getTable in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getTable(java.lang.String)
  - getPrimaryTable
```
public Optional<TableInfo<T>> getPrimaryTable()
```
    Specified by:
    
    getPrimaryTable in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getPrimaryTable()
  - getAuditTable
```
public Optional<TableInfo<T>> getAuditTable()
```
    Specified by:
    
    getAuditTable in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getAuditTable()
  - getNumTables
```
public int getNumTables()
```
    Specified by:
    
    getNumTables in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getNumTables()
  - getTables
```
public Collection<TableInfo<T>> getTables()
```
    Specified by:
    
    getTables in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getTables()
  - tables
```
public java.util.stream.Stream<TableInfo<T>> tables()
```
    Specified by:
    
    tables in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.tables()
  - iterator
```
public Iterator<TableInfo<T>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<TableInfo<T>>
    
    Specified by:
    
    iterator in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.iterator()
  - getColumns
```
public Collection<String> getColumns()
```
    Retrieves all columns from the POJO no matter which table they are defined in.
    
    Returns:
    
    a non-null set of all columns for the POJO
  - newContext
```
public ClassInfoImpl.Context newContext()
```
    Creates a new context for this class info.
    
    Returns:
    
    a non-null newly created context for this class info
  - newContext
```
public ClassInfoImpl.POJOContext newContext(T object)
```
    Creates a new context for this class info with the given POJO object.
    
    Parameters:
    
    object - the POJO object
    
    Returns:
    
    a non-null newly created context for this class info
    
    Throws:
    
    NullPointerException - if object is null
    
    IllegalArgumentException - if object is not of the appropriate class
  - isColumn
```
public boolean isColumn(String name)
```
    Checks if the specified name is defined as a column for any tables.
    
    Parameters:
    
    name - the name of the column
    
    Returns:
    
    true if that name is defined as a column for any tables; false otherwise
  - validateColumn
```
public void validateColumn(Object name)
```
    Validates if a column is defined by the POJO in any tables.
    
    Parameters:
    
    name - the column name to validate
    
    Throws:
    
    NullPointerException - if name is null
    
    IllegalArgumentException - if any of the specified columns are not defined by the POJO
  - validateColumnOrSuffix
```
public void validateColumnOrSuffix(String name)
```
    Validates if a column is defined by the POJO in any tables or if it is defined as a suffix key.
    
    Parameters:
    
    name - the column name or suffix key to validate
    
    Throws:
    
    NullPointerException - if name is null
    
    IllegalArgumentException - if the specified column or suffix key is not defined by the POJO
  - validateColumns
```
public void validateColumns(Iterable<Object> names)
```
    Validates if specified columns are defined by the POJO in any tables.
    
    Parameters:
    
    names - the names of the column to validate
    
    Throws:
    
    NullPointerException - if any of the column names are null
    
    IllegalArgumentException - if any of the column names are not defined by the POJO
  - validateColumns
```
public void validateColumns(String... names)
```
    Validates if specified columns are defined by the POJO in any table.
    
    Parameters:
    
    names - the names of the column to validate
    
    Throws:
    
    NullPointerException - if any of the column names are null
    
    IllegalArgumentException - if any of the column names are not defined by the POJO
  - validateColumnAndValue
```
public void validateColumnAndValue(String name,
                                   Object value)
```
    Validates if a column is defined by the POJO and its potential value in any table.
    
    Parameters:
    
    name - the column name to validate
    
    value - the value to validate for the column
    
    Throws:
    
    NullPointerException - if name is null
    
    IllegalArgumentException - if the specified column is not defined by the POJO or if the specified value is not of the right type or is null when the column is mandatory
  - validateSuffix
```
public void validateSuffix(String suffix,
                           Object value)
```
    Validates the specified suffix and its value as being a valid suffix for the POJO.
    
    Parameters:
    
    suffix - the suffix to validate
    
    value - the value for the suffix
    
    Throws:
    
    IllegalArgumentException - if the suffix is not defined by this POJO if the specified value is not of the right type or is null when the field is mandatory
    
    ExcludedSuffixKeyException - if the specified suffix value is marked as excluded the specified suffix key
  - getObject
```
public T getObject(com.datastax.driver.core.Row row,
                   Map<String,Object> suffixes)
```
    Converts the specified result row into a POJO object defined by this class information and suffix map.
    
    Parameters:
    
    row - the result row to convert into a POJO
    
    suffixes - a map of suffix values to report back into the created POJO
    
    Returns:
    
    the POJO object corresponding to the given result row
    
    Throws:
    
    NullPointerException - if suffixes is null
    
    ObjectConversionException - if unable to convert to a POJO
  - getObject
```
public T getObject(com.datastax.driver.core.UDTValue uval)
```
    Converts the specified UDT value into a POJO object defined by this class information.
    
    Parameters:
    
    uval - the UDT value to convert into a POJO
    
    Returns:
    
    the POJO object corresponding to the given UDT value
    
    Throws:
    
    ObjectConversionException - if unable to convert to a POJO
  - getInitialObjects
```
public Collection<T> getInitialObjects(Map<String,String> suffixes)
```
    Specified by:
    
    getInitialObjects in interface ClassInfo<T>
    
    See Also:
    
    ClassInfo.getInitialObjects(java.util.Map)

Class ClassInfoImpl<T>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

entityAnnotationClass

clazz

constructor

finalFields

suffixesByName

suffixesByType

Method Detail

tablesImpl

getTablesImpl

getEntityAnnotationClass

getObjectClass

supportsTablesAndIndexes

objectClasses

classInfos

udts

getDefaultValue

getKeyspace

getNumSuffixKeys

getSuffixKey

getSuffixKeyByType

isSuffixKey

getSuffixKeys

getSuffixTypes

getTableImpl

getTable

getPrimaryTable

getAuditTable

getNumTables

getTables

tables

iterator

getColumns

newContext

newContext

isColumn

validateColumn

validateColumnOrSuffix

validateColumns

validateColumns

validateColumnAndValue

validateSuffix

getObject

getObject

getInitialObjects