CQLTranslator (kundera-cassandra 2.17 API)

java.lang.Object
- com.impetus.client.cassandra.thrift.CQLTranslator

```
public final class CQLTranslator
extends Object
```
CQL translator interface, to translate all CRUD operations into CQL queries. In case compound primary key is boolean, we need to $COLUMNS,$COLUMNFAMILY,$COLUMNVALUES : They need to be comma separated. $COLUMNVALUES : It has to be according to data type(add "'" only for text/string)

Author:

vivek.mishra

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CQLTranslator.TranslationType
The Enum TranslationType.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CQLTranslator.TranslationType` The Enum TranslationType.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADD_PRIMARYKEY_CLAUSE` The Constant ADD_PRIMARYKEY_CLAUSE.
`static String`	`ADD_SET_CLAUSE` The Constant ADD_SET_CLAUSE.
`static String`	`ADD_WHERE_CLAUSE` The Constant ADD_WHERE_CLAUSE.
`static String`	`AND_CLAUSE` The Constant AND_CLAUSE.
`static String`	`APPLY_BATCH` The Constant APPLY_BATCH.
`static String`	`BATCH_QUERY` The Constant BATCH_QUERY.
`static String`	`CLOSE_BRACKET` The Constant CLOSE_BRACKET.
`static String`	`COLUMN_FAMILY` The Constant COLUMN_FAMILY.
`static String`	`COLUMN_VALUES` The Constant COLUMN_VALUES.
`static String`	`COLUMNS` The Constant COLUMNS.
`static String`	`COMMA_STR` The Constant COMMA_STR.
`static String`	`CONSISTENCY_LEVEL` The Constant CONSISTENCY_LEVEL.
`static String`	`CREATE_COLUMNFAMILY_CLUSTER_ORDER` The Constant CREATE_COLUMNFAMILY_CLUSTER_ORDER.
`static String`	`CREATE_COLUMNFAMILY_QUERY` The Constant CREATE_COLUMNFAMILY_QUERY.
`static String`	`CREATE_INDEX_QUERY` The Constant CREATE_INDEX_QUERY.
`static String`	`CREATE_KEYSPACE` The Constant CREATE_KEYSPACE.
`static String`	`CREATE_TYPE` The Constant CREATE_TYPE.
`static String`	`DEFAULT_KEY_NAME` The Constant DEFAULT_KEY_NAME.
`static String`	`DELETE_QUERY` The Constant DELETE_QUERY.
`static String`	`DROP_TABLE` The Constant DROP_TABLE.
`static String`	`DURABLE_WRITES` The Constant DURABLE_WRITES.
`static String`	`EQ_CLAUSE` The Constant EQ_CLAUSE.
`static String`	`FROZEN` The Constant FROZEN.
`static String`	`IN_CLAUSE` The Constant IN_CLAUSE.
`static String`	`INCR_COUNTER` The Constant INCR_COUNTER.
`static String`	`INSERT_QUERY` The Constant INSERT_QUERY.
`static String`	`LIMIT` The Constant LIMIT.
`static String`	`OPEN_BRACKET` The Constant OPEN_BRACKET.
`static String`	`QUOTE_STR` The Constant QUOTE_STR.
`static String`	`SELECT_COUNT_QUERY` The Constant SELECT_COUNT_QUERY.
`static String`	`SELECT_QUERY` The Constant SELECT_QUERY.
`static String`	`SELECTALL_QUERY` The Constant SELECTALL_QUERY.
`static String`	`SIMPLE_REPLICATION` The Constant SIMPLE_REPLICATION.
`static String`	`SORT_CLAUSE` The Constant SORT_CLAUSE.
`static String`	`SPACE_STRING` The Constant SPACE_STRING.
`static String`	`STATEMENT` The Constant STATEMENT.
`static String`	`TOKEN` The Constant TOKEN.
`static String`	`TYPE` The Constant TYPE.
`static String`	`UPDATE_QUERY` The Constant UPDATE_QUERY.
`static String`	`USING_CONSISTENCY` The Constant USING_CONSISTENCY.
`static String`	`WITH_CLAUSE` The Constant WITH_CLAUSE.

Constructor Summary

Constructors
Constructor and Description

CQLTranslator()
Instantiates a new CQL translator.

Constructors
Constructor and Description
`CQLTranslator()` Instantiates a new CQL translator.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendColumnName(StringBuilder builder, String columnName)` Appends column name and ensure case sensitivity.
`void`	`appendColumnName(StringBuilder builder, String columnName, String dataType)` Appends column name and data type also ensures case sensitivity.
`boolean`	`appendValue(StringBuilder builder, Class fieldClazz, Object value, boolean isPresent, boolean useToken)` Appends value to builder object for given class type.
`void`	`buildFilteringClause(StringBuilder builder)` Builds the filtering clause.
`void`	`buildOrderByClause(StringBuilder builder, String field, Object orderType, boolean useToken)` Builds the order by clause.
`StringBuilder`	`buildSelectQuery(TableGeneratorDiscriptor descriptor)` Builds the select query.
`void`	`buildSetClause(EntityMetadata m, StringBuilder builder, String property, Object value)` Builds set clause for a given field.
`void`	`buildSetClauseForCounters(StringBuilder builder, String field, Object value)` Builds set clause for a given counter field.
`StringBuilder`	`buildUpdateQuery(TableGeneratorDiscriptor descriptor)` Builds the update query.
`void`	`buildWhereClause(StringBuilder builder, Class fieldClazz, String field, Object value, String clause, boolean useToken)` Build where clause with given clause.
`void`	`buildWhereClause(StringBuilder builder, String field, Field member, Object entity)` Build where clause with @ EQ_CLAUSE} clause.
`StringBuilder`	`ensureCase(StringBuilder builder, String fieldName, boolean useToken)` Ensures case for corresponding column name.
`static String`	`getCQLType(String internalClazz)` Gets the CQL type.
`static String`	`getKeyword(String property)` Gets the keyword.
`StringBuilder`	`onWhereClause(StringBuilder builder, Class fieldClazz, String field, Object value, String clause, boolean useToken)` Build where clause with given clause.
`HashMap<CQLTranslator.TranslationType,Map<String,StringBuilder>>`	`prepareColumnOrColumnValues(Object record, EntityMetadata entityMetadata, CQLTranslator.TranslationType type, Map<String,Object> externalProperties, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)` Prepares column name or column values.

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

Field Detail
- CREATE_COLUMNFAMILY_QUERY
```
public static final String CREATE_COLUMNFAMILY_QUERY
```
  The Constant CREATE_COLUMNFAMILY_QUERY.
  
  See Also:
  Constant Field Values
- ADD_PRIMARYKEY_CLAUSE
```
public static final String ADD_PRIMARYKEY_CLAUSE
```
  The Constant ADD_PRIMARYKEY_CLAUSE.
  
  See Also:
  Constant Field Values
- SELECTALL_QUERY
```
public static final String SELECTALL_QUERY
```
  The Constant SELECTALL_QUERY.
  
  See Also:
  Constant Field Values
- SELECT_COUNT_QUERY
```
public static final String SELECT_COUNT_QUERY
```
  The Constant SELECT_COUNT_QUERY.
  
  See Also:
  Constant Field Values
- ADD_WHERE_CLAUSE
```
public static final String ADD_WHERE_CLAUSE
```
  The Constant ADD_WHERE_CLAUSE.
  
  See Also:
  Constant Field Values
- SELECT_QUERY
```
public static final String SELECT_QUERY
```
  The Constant SELECT_QUERY.
  
  See Also:
  Constant Field Values
- INSERT_QUERY
```
public static final String INSERT_QUERY
```
  The Constant INSERT_QUERY.
  
  See Also:
  Constant Field Values
- DELETE_QUERY
```
public static final String DELETE_QUERY
```
  The Constant DELETE_QUERY.
  
  See Also:
  Constant Field Values
- COLUMN_FAMILY
```
public static final String COLUMN_FAMILY
```
  The Constant COLUMN_FAMILY.
  
  See Also:
  Constant Field Values
- COLUMNS
```
public static final String COLUMNS
```
  The Constant COLUMNS.
  
  See Also:
  Constant Field Values
- COLUMN_VALUES
```
public static final String COLUMN_VALUES
```
  The Constant COLUMN_VALUES.
  
  See Also:
  Constant Field Values
- AND_CLAUSE
```
public static final String AND_CLAUSE
```
  The Constant AND_CLAUSE.
  
  See Also:
  Constant Field Values
- SORT_CLAUSE
```
public static final String SORT_CLAUSE
```
  The Constant SORT_CLAUSE.
  
  See Also:
  Constant Field Values
- EQ_CLAUSE
```
public static final String EQ_CLAUSE
```
  The Constant EQ_CLAUSE.
  
  See Also:
  Constant Field Values
- WITH_CLAUSE
```
public static final String WITH_CLAUSE
```
  The Constant WITH_CLAUSE.
  
  See Also:
  Constant Field Values
- QUOTE_STR
```
public static final String QUOTE_STR
```
  The Constant QUOTE_STR.
  
  See Also:
  Constant Field Values
- LIMIT
```
public static final String LIMIT
```
  The Constant LIMIT.
  
  See Also:
  Constant Field Values
- CREATE_INDEX_QUERY
```
public static final String CREATE_INDEX_QUERY
```
  The Constant CREATE_INDEX_QUERY.
  
  See Also:
  Constant Field Values
- BATCH_QUERY
```
public static final String BATCH_QUERY
```
  The Constant BATCH_QUERY.
  
  See Also:
  Constant Field Values
- STATEMENT
```
public static final String STATEMENT
```
  The Constant STATEMENT.
  
  See Also:
  Constant Field Values
- APPLY_BATCH
```
public static final String APPLY_BATCH
```
  The Constant APPLY_BATCH.
  
  See Also:
  Constant Field Values
- USING_CONSISTENCY
```
public static final String USING_CONSISTENCY
```
  The Constant USING_CONSISTENCY.
  
  See Also:
  Constant Field Values
- CONSISTENCY_LEVEL
```
public static final String CONSISTENCY_LEVEL
```
  The Constant CONSISTENCY_LEVEL.
  
  See Also:
  Constant Field Values
- DROP_TABLE
```
public static final String DROP_TABLE
```
  The Constant DROP_TABLE.
  
  See Also:
  Constant Field Values
- UPDATE_QUERY
```
public static final String UPDATE_QUERY
```
  The Constant UPDATE_QUERY.
  
  See Also:
  Constant Field Values
- ADD_SET_CLAUSE
```
public static final String ADD_SET_CLAUSE
```
  The Constant ADD_SET_CLAUSE.
  
  See Also:
  Constant Field Values
- COMMA_STR
```
public static final String COMMA_STR
```
  The Constant COMMA_STR.
  
  See Also:
  Constant Field Values
- INCR_COUNTER
```
public static final String INCR_COUNTER
```
  The Constant INCR_COUNTER.
  
  See Also:
  Constant Field Values
- TOKEN
```
public static final String TOKEN
```
  The Constant TOKEN.
  
  See Also:
  Constant Field Values
- CLOSE_BRACKET
```
public static final String CLOSE_BRACKET
```
  The Constant CLOSE_BRACKET.
  
  See Also:
  Constant Field Values
- SPACE_STRING
```
public static final String SPACE_STRING
```
  The Constant SPACE_STRING.
  
  See Also:
  Constant Field Values
- IN_CLAUSE
```
public static final String IN_CLAUSE
```
  The Constant IN_CLAUSE.
  
  See Also:
  Constant Field Values
- OPEN_BRACKET
```
public static final String OPEN_BRACKET
```
  The Constant OPEN_BRACKET.
  
  See Also:
  Constant Field Values
- CREATE_COLUMNFAMILY_CLUSTER_ORDER
```
public static final String CREATE_COLUMNFAMILY_CLUSTER_ORDER
```
  The Constant CREATE_COLUMNFAMILY_CLUSTER_ORDER.
  
  See Also:
  Constant Field Values
- DEFAULT_KEY_NAME
```
public static final String DEFAULT_KEY_NAME
```
  The Constant DEFAULT_KEY_NAME.
  
  See Also:
  Constant Field Values
- CREATE_KEYSPACE
```
public static final String CREATE_KEYSPACE
```
  The Constant CREATE_KEYSPACE.
  
  See Also:
  Constant Field Values
- SIMPLE_REPLICATION
```
public static final String SIMPLE_REPLICATION
```
  The Constant SIMPLE_REPLICATION.
  
  See Also:
  Constant Field Values
- DURABLE_WRITES
```
public static final String DURABLE_WRITES
```
  The Constant DURABLE_WRITES.
  
  See Also:
  Constant Field Values
- CREATE_TYPE
```
public static final String CREATE_TYPE
```
  The Constant CREATE_TYPE.
  
  See Also:
  Constant Field Values
- TYPE
```
public static final String TYPE
```
  The Constant TYPE.
  
  See Also:
  Constant Field Values
- FROZEN
```
public static final String FROZEN
```
  The Constant FROZEN.
  
  See Also:
  Constant Field Values

Constructor Detail
- CQLTranslator
```
public CQLTranslator()
```
  Instantiates a new CQL translator.

Method Detail

prepareColumnOrColumnValues

public HashMap<CQLTranslator.TranslationType,Map<String,StringBuilder>> prepareColumnOrColumnValues(Object record,
                                                                                           EntityMetadata entityMetadata,
                                                                                           CQLTranslator.TranslationType type,
                                                                                           Map<String,Object> externalProperties,
                                                                                           EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Prepares column name or column values.

Parameters:: record - entity.; entityMetadata - entity meta data; type - translation type.; externalProperties - the external properties; kunderaMetadata - the kundera metadata
Returns:: Map containing translation type as key and string as translated CQL string.

getCQLType
```
public static String getCQLType(String internalClazz)
```
Gets the CQL type.

Parameters:
internalClazz - the internal clazz

Returns:
the CQL type

getKeyword
```
public static String getKeyword(String property)
```
Gets the keyword.

Parameters:
property - the property

Returns:
the keyword

buildWhereClause

public void buildWhereClause(StringBuilder builder,
                    String field,
                    Field member,
                    Object entity)

Build where clause with @ EQ_CLAUSE} clause.

Parameters:: builder - the builder; field - the field; member - the member; entity - the entity

buildWhereClause

public void buildWhereClause(StringBuilder builder,
                    Class fieldClazz,
                    String field,
                    Object value,
                    String clause,
                    boolean useToken)

Build where clause with given clause.

Parameters:: builder - the builder; fieldClazz - the field clazz; field - the field; value - the value; clause - the clause; useToken - the use token

onWhereClause

public StringBuilder onWhereClause(StringBuilder builder,
                          Class fieldClazz,
                          String field,
                          Object value,
                          String clause,
                          boolean useToken)

Build where clause with given clause.

Parameters:: builder - the builder; fieldClazz - the field clazz; field - the field; value - the value; clause - the clause; useToken - the use token
Returns:: the string builder

buildSetClauseForCounters

public void buildSetClauseForCounters(StringBuilder builder,
                             String field,
                             Object value)

Builds set clause for a given counter field.

Parameters:: builder - the builder; field - the field; value - the value

buildSetClause

public void buildSetClause(EntityMetadata m,
                  StringBuilder builder,
                  String property,
                  Object value)

Builds set clause for a given field.

Parameters:: m - the m; builder - the builder; property - the property; value - the value

ensureCase
```
public StringBuilder ensureCase(StringBuilder builder,
                       String fieldName,
                       boolean useToken)
```
Ensures case for corresponding column name.

Parameters:
builder - column name builder.
fieldName - column name.
useToken - the use token

Returns:
builder object with appended column name.

appendValue
```
public boolean appendValue(StringBuilder builder,
                  Class fieldClazz,
                  Object value,
                  boolean isPresent,
                  boolean useToken)
```
Appends value to builder object for given class type.

Parameters:
builder - string builder.
fieldClazz - field class.
value - value to be appended.
isPresent - if field is present.
useToken - the use token

Returns:
true, if value is not null else false.

appendColumnName
```
public void appendColumnName(StringBuilder builder,
                    String columnName)
```
Appends column name and ensure case sensitivity.

Parameters:
builder - string builder.
columnName - column name.

appendColumnName

public void appendColumnName(StringBuilder builder,
                    String columnName,
                    String dataType)

Appends column name and data type also ensures case sensitivity.

Parameters:: builder - string builder; columnName - column name; dataType - data type.

buildFilteringClause
```
public void buildFilteringClause(StringBuilder builder)
```
Builds the filtering clause.

Parameters:
builder - the builder

buildOrderByClause

public void buildOrderByClause(StringBuilder builder,
                      String field,
                      Object orderType,
                      boolean useToken)

Builds the order by clause.

Parameters:: builder - the builder; field - the field; orderType - the order type; useToken - the use token

buildSelectQuery
```
public StringBuilder buildSelectQuery(TableGeneratorDiscriptor descriptor)
```
Builds the select query.

Parameters:
descriptor - the descriptor

Returns:
the string builder

buildUpdateQuery
```
public StringBuilder buildUpdateQuery(TableGeneratorDiscriptor descriptor)
```
Builds the update query.

Parameters:
descriptor - the descriptor

Returns:
the string builder

Class CQLTranslator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATE_COLUMNFAMILY_QUERY

ADD_PRIMARYKEY_CLAUSE

SELECTALL_QUERY

SELECT_COUNT_QUERY

ADD_WHERE_CLAUSE

SELECT_QUERY

INSERT_QUERY

DELETE_QUERY

COLUMN_FAMILY

COLUMNS

COLUMN_VALUES

AND_CLAUSE

SORT_CLAUSE

EQ_CLAUSE

WITH_CLAUSE

QUOTE_STR

LIMIT

CREATE_INDEX_QUERY

BATCH_QUERY

STATEMENT

APPLY_BATCH

USING_CONSISTENCY

CONSISTENCY_LEVEL

DROP_TABLE

UPDATE_QUERY

ADD_SET_CLAUSE

COMMA_STR

INCR_COUNTER

TOKEN

CLOSE_BRACKET

SPACE_STRING

IN_CLAUSE

OPEN_BRACKET

CREATE_COLUMNFAMILY_CLUSTER_ORDER

DEFAULT_KEY_NAME

CREATE_KEYSPACE

SIMPLE_REPLICATION

DURABLE_WRITES

CREATE_TYPE

TYPE

FROZEN

Constructor Detail

CQLTranslator

Method Detail

prepareColumnOrColumnValues

getCQLType

getKeyword

buildWhereClause

buildWhereClause

onWhereClause

buildSetClauseForCounters

buildSetClause

ensureCase

appendValue

appendColumnName

appendColumnName

buildFilteringClause

buildOrderByClause

buildSelectQuery

buildUpdateQuery