org.helenus.driver.impl

Class UDTClassInfoImpl<T>

java.lang.Object

org.helenus.driver.impl.ClassInfoImpl<T>

org.helenus.driver.impl.UDTClassInfoImpl<T>

Type Parameters:

T - The type of POJO represented by this class

All Implemented Interfaces:

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

Direct Known Subclasses:

UDTActualClassInfoImpl, UDTRootClassInfoImpl, UDTTypeClassInfoImpl

public abstract class UDTClassInfoImpl<T>
extends ClassInfoImpl<T>
implements CQLDataType

The UDTClassInfoImpl class provides information about a particular POJO class.

Since:

1.0

Version:

1 - Mar 3, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.helenus.driver.impl.ClassInfoImpl

ClassInfoImpl.Context

Field Summary

Fields inherited from class org.helenus.driver.impl.ClassInfoImpl

clazz, constructor, entityAnnotationClass, finalFields, keyspaceKeysByName, keyspaceKeysByType, mgr

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UDTClassInfoImpl(StatementManagerImpl mgr, Class<T> clazz, Class<? extends Annotation> entityAnnotationClass) Instantiates a new UDTClassInfoImpl object.
protected	UDTClassInfoImpl(UDTClassInfoImpl<T> cinfo, Class<T> clazz) Instantiates a new UDTClassInfoImpl object.

Method Summary

Modifier and Type	Method and Description
protected void	deregister(com.datastax.driver.core.UserType definition) Deregisters the corresponding definition for this user data type.
List<CQLDataType>	getArgumentTypes()
protected UDTCodecImpl<T>	getCodec(String keyspace) Gets a codec for this user data type.
com.datastax.driver.core.DataType	getDataType()
CQLDataType	getElementType()
CQLDataType	getFirstArgumentType()
CQLDataType	getMainType()
String	getName() Gets a name representation for this data type.
int	getNumTables()
T	getObject(com.datastax.driver.core.Row row, Map<String,Object> kkeys) Converts the specified result row into a POJO object defined by this class information and keyspace key map.
T	getObject(String keyspace, Map<String,String> values) Converts the specified parsed values into a POJO object defined by this class information.
T	getObject(com.datastax.driver.core.UDTValue uval) Converts the specified UDT value into a POJO object defined by this class information.
TableInfoImpl<T>	getTableImpl() Gets the fake table info defined by the user-defined POJO.
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.
com.datastax.driver.core.UserType	getUserType(String keyspace) Gets the corresponding default Cassandra user type.
boolean	isAlterableTo(CQLDataType to)
boolean	isCollection()
boolean	isFrozen()
boolean	isTuple()
boolean	isUserDefined()
String	name()
UDTClassInfoImpl.POJOContext	newContext(T object) Creates a new context for this class info with the given POJO object.
T	newObject() Instantiates a new blank object.
protected void	register(com.datastax.driver.core.UserType definition) Registers a new cluster-defined definition for this user data type.
boolean	supportsTablesAndIndexes()
java.util.stream.Stream<TableInfo<T>>	tables()
String	toCQL()
String	toString()

Methods inherited from class org.helenus.driver.impl.ClassInfoImpl

classInfos, equals, getAuditTable, getColumns, getDefaultValue, getEntityAnnotationClass, getInitialObjects, getKeyspace, getKeyspaceKey, getKeyspaceKeyByType, getKeyspaceKeys, getKeyspaceKeyTypes, getNumKeyspaceKeys, getObjectClass, getPrimaryTable, getTable, hashCode, isColumn, isKeyspaceKey, iterator, newContext, objectClasses, tablesImpl, udts, validateColumn, validateColumnAndValue, validateColumnOrKeyspaceKey, validateColumns, validateColumns, validateKeyspaceKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

UDTClassInfoImpl

protected UDTClassInfoImpl(StatementManagerImpl mgr,
                           Class<T> clazz,
                           Class<? extends Annotation> entityAnnotationClass)

Instantiates a new UDTClassInfoImpl object.

Parameters:

mgr - the non-null statement manager

clazz - the class of POJO for which to get a class info object for

entityAnnotationClass - the non-null entity annotation class to compute from

Throws:

NullPointerException - if clazz is null

IllegalArgumentException - if clazz doesn't represent a valid POJO class

UDTClassInfoImpl

protected UDTClassInfoImpl(UDTClassInfoImpl<T> cinfo,
                           Class<T> clazz)

Instantiates a new UDTClassInfoImpl object.

Parameters:

cinfo - the non-null class info to link to

clazz - the class of POJO for which to get a class info object for

Throws:

NullPointerException - if clazz is null

IllegalArgumentException - if clazz doesn't represent a valid POJO class

Method Detail

getTablesImpl

protected Collection<TableInfoImpl<T>> getTablesImpl()

Gets the tables info defined by the POJO.

Overrides:

getTablesImpl in class ClassInfoImpl<T>

Returns:

a collection of all defined tables info

See Also:

ClassInfoImpl.getTablesImpl()

getCodec

protected UDTCodecImpl<T> getCodec(String keyspace)

Gets a codec for this user data type.

Parameters:

keyspace - the keyspace for which to get a codec

Returns:

a suitable codec for this user data type

register

protected void register(com.datastax.driver.core.UserType definition)

Registers a new cluster-defined definition for this user data type.

Parameters:

definition - the new user definition for this the user type to register

deregister

protected void deregister(com.datastax.driver.core.UserType definition)

Deregisters the corresponding definition for this user data type.

Parameters:

definition - the definition for the user type to deregister

name

public String name()

Specified by:

name in interface CQLDataType

See Also:

CQLDataType.name()

getName

public String getName()

Gets a name representation for this data type.

Returns:

a non-null name representation for this data type

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface CQLDataType

See Also:

CQLDataType.isFrozen()

isCollection

public boolean isCollection()

Specified by:

isCollection in interface CQLDataType

See Also:

CQLDataType.isCollection()

isTuple

public boolean isTuple()

Specified by:

isTuple in interface CQLDataType

See Also:

CQLDataType.isTuple()

isUserDefined

public boolean isUserDefined()

Specified by:

isUserDefined in interface CQLDataType

See Also:

CQLDataType.isUserDefined()

getUserType

public com.datastax.driver.core.UserType getUserType(String keyspace)

Gets the corresponding default Cassandra user type.

Parameters:

keyspace - the keyspace for which to get a user type

Returns:

the non-null corresponding Cassandra user type

getDataType

public com.datastax.driver.core.DataType getDataType()

Specified by:

getDataType in interface CQLDataType

See Also:

CQLDataType.getDataType()

getMainType

public CQLDataType getMainType()

Specified by:

getMainType in interface CQLDataType

See Also:

CQLDataType.getMainType()

getElementType

public CQLDataType getElementType()

Specified by:

getElementType in interface CQLDataType

See Also:

CQLDataType.getElementType()

getArgumentTypes

public List<CQLDataType> getArgumentTypes()

Specified by:

getArgumentTypes in interface CQLDataType

See Also:

CQLDataType.getArgumentTypes()

getFirstArgumentType

public CQLDataType getFirstArgumentType()

Specified by:

getFirstArgumentType in interface CQLDataType

See Also:

CQLDataType.getFirstArgumentType()

isAlterableTo

public boolean isAlterableTo(CQLDataType to)

Specified by:

isAlterableTo in interface CQLDataType

See Also:

CQLDataType.isAlterableTo(org.helenus.driver.persistence.CQLDataType)

toCQL

public String toCQL()

Specified by:

toCQL in interface CQLDataType

See Also:

CQLDataType.toCQL()

supportsTablesAndIndexes

public boolean supportsTablesAndIndexes()

Specified by:

supportsTablesAndIndexes in interface ClassInfo<T>

Overrides:

supportsTablesAndIndexes in class ClassInfoImpl<T>

See Also:

ClassInfoImpl.supportsTablesAndIndexes()

getTableImpl

public TableInfoImpl<T> getTableImpl()

Gets the fake table info defined by the user-defined POJO.

Returns:

the fake table info defined by the POJO

tables

public java.util.stream.Stream<TableInfo<T>> tables()

Specified by:

tables in interface ClassInfo<T>

Overrides:

tables in class ClassInfoImpl<T>

See Also:

ClassInfoImpl.tables()

getTableImpl

public TableInfoImpl<T> getTableImpl(String name)

Gets the table info corresponding to the given table name.

Overrides:

getTableImpl in class ClassInfoImpl<T>

Parameters:

name - the name of the table to get

Returns:

the corresponding table info

See Also:

ClassInfoImpl.getTableImpl(java.lang.String)

getNumTables

public int getNumTables()

Specified by:

getNumTables in interface ClassInfo<T>

Overrides:

getNumTables in class ClassInfoImpl<T>

See Also:

ClassInfoImpl.getNumTables()

getTables

public Collection<TableInfo<T>> getTables()

Specified by:

getTables in interface ClassInfo<T>

Overrides:

getTables in class ClassInfoImpl<T>

See Also:

ClassInfoImpl.getTables()

newContext

public UDTClassInfoImpl.POJOContext newContext(T object)

Creates a new context for this class info with the given POJO object.

Overrides:

newContext in class ClassInfoImpl<T>

Parameters:

object - the POJO object

Returns:

a non-null newly created context for this class info

See Also:

ClassInfoImpl.newContext(java.lang.Object)

getObject

public T getObject(com.datastax.driver.core.Row row,
                   Map<String,Object> kkeys)

Converts the specified result row into a POJO object defined by this class information and keyspace key map.

Overrides:

getObject in class ClassInfoImpl<T>

Parameters:

row - the result row to convert into a POJO

kkeys - a map of keyspace key values to report back into the created POJO

Returns:

the POJO object corresponding to the given result row

See Also:

ClassInfoImpl.getObject(com.datastax.driver.core.Row, java.util.Map)

newObject

public T newObject()

Instantiates a new blank object.

Returns:

a newly created blank pojo of this type

getObject

public T getObject(com.datastax.driver.core.UDTValue uval)

Converts the specified UDT value into a POJO object defined by this class information.

Overrides:

getObject in class ClassInfoImpl<T>

Parameters:

uval - the UDT value to convert into a POJO

Returns:

the POJO object corresponding to the given UDT value

See Also:

ClassInfoImpl.getObject(com.datastax.driver.core.UDTValue)

getObject

public T getObject(String keyspace,
                   Map<String,String> values)

Converts the specified parsed values into a POJO object defined by this class information.

Parameters:

keyspace - the keyspace for which to create the object

values - the formated values to convert into a POJO

Returns:

the POJO object corresponding to the given UDT value

Throws:

ObjectConversionException - if unable to convert to a POJO

toString

public String toString()

Overrides:

toString in class ClassInfoImpl<T>

See Also:

Object.toString()