RowTranslator (sormula)

java.lang.Object
- org.sormula.translator.ColumnsTranslator<R>
- - org.sormula.translator.RowTranslator<R>

Type Parameters:

R - row class
```
public class RowTranslator<R>
extends ColumnsTranslator<R>
```
Translates a row to prepared statement and from result set. ColumnTranslator objects are created for each column based upon annotations on row class.
If no Column annotation exists for a field, then column name is same as field name and StandardColumnTranslator is used.
If any of the following are true, then field is assumed to be cascaded:
- field is a Collection
- field is an array
- field is a Map
- field is a class that has no TypeTranslator
Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description

RowTranslator(Table<R> table, Row rowAnnotation)
Constructs for a table.

Constructors
Constructor and Description
`RowTranslator(Table<R> table, Row rowAnnotation)` Constructs for a table.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RowField<R,?>`	`createRowField(java.lang.reflect.Field field)` Creates a `RowField` object with the appropriate field access (either getter/setter method or direct access).
`java.util.List<java.lang.reflect.Field>`	`getCascadeFieldList()` Gets list of fields that are to be cascaded.
`protected java.lang.reflect.Field`	`getDeclaredField(java.lang.Class<?> clazz, java.lang.String fieldName)` Recursively searches for declared field in superclass(es) of clazz and then clazz parameter.
`java.lang.reflect.Field`	`getDeclaredField(java.lang.String fieldName)` Gets a declared field of `ColumnsTranslator.getRowClass()`.
`java.lang.reflect.Field[]`	`getDeclaredFields()` Gets all of the declared fields for `ColumnsTranslator.getRowClass()`.
`protected void`	`getDeclaredFields(java.lang.Class<?> clazz, java.util.List<java.lang.reflect.Field[]> classHierarchyFields)` Recursively searches for declared fields in super class(es) of clazz and then clazz parameter.
`FieldAccessType`	`getFieldAccessType()` Gets the field access type to use for all fields in row if no access type has been specified for `Column`.
`ColumnTranslator<R>`	`getIdentityColumnTranslator()` Column translator used to set the value of a row column that is the identity column for row.
`PrimaryKeyWhereTranslator<R>`	`getPrimaryKeyWhereTranslator()` Gets primary key translator for use in where clause.
`java.lang.String`	`getUnusedColumnInsertNamesSql()` Gets names of unused columns for insert statement.
`java.lang.String`	`getUnusedColumnInsertValuesSql()` Gets values for unused columns for insert statement.
`java.lang.String`	`getUnusedColumnUpdateSql()` Gets column=value for all unused columns for update statement.
`protected void`	`initColumnTranslators()` Process `Transient` and `Cascade` annotations.
`protected void`	`initUnusedColumnSql(java.lang.Class<R> rowClass)` Process `UnusedColumns` annotations.
`boolean`	`isInheritedFields()` Reports if super class fields are used.
`void`	`setInheritedFields(boolean inheritedFields)` Sets if super class fields are used.

Methods inherited from class org.sormula.translator.ColumnsTranslator
addColumnTranslator, createColumnParameterPhrase, createColumnPhrase, createParameterPhrase, getColumnTranslator, getColumnTranslatorList, getRowClass, initColumnTranslatorList, isIncluded, isIncludeIdentityColumns, isIncludeReadOnlyColumns, read, setIncludeIdentityColumns, setIncludeReadOnlyColumns, write

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

- Constructor Detail
  - RowTranslator
```
public RowTranslator(Table<R> table,
                     Row rowAnnotation)
              throws TranslatorException
```
    Constructs for a table.
    
    Parameters:
    
    table - table associated with this row translator
    
    rowAnnotation - row annotation on table or row class
    
    Throws:
    
    TranslatorException - if error
    
    Since:
    
    3.0
- Method Detail
  - getFieldAccessType
```
public FieldAccessType getFieldAccessType()
```
    Gets the field access type to use for all fields in row if no access type has been specified for Column.
    
    Returns:
    
    the field access type specified by Row.fieldAccess() or FieldAccessType.Default if no Row annotation was used
    
    Since:
    
    3.4
  - createRowField
```
public RowField<R,?> createRowField(java.lang.reflect.Field field)
                             throws TranslatorException
```
    Creates a RowField object with the appropriate field access (either getter/setter method or direct access). Typically this method is used to create a field that will receive value from a cascade.
    
    Parameters:
    
    field - create for this field
    
    Returns:
    
    a concrete subclass of RowField
    
    Throws:
    
    TranslatorException - if error
    
    Since:
    
    3.4
  - getIdentityColumnTranslator
```
public ColumnTranslator<R> getIdentityColumnTranslator()
```
    Column translator used to set the value of a row column that is the identity column for row. Typically used by insert operations for column that is annotated with Column.identity().
    
    Returns:
    
    column translator for identity column; null if no identity column
    
    See Also:
    
    Column.identity()
  - isInheritedFields
```
public boolean isInheritedFields()
```
    Reports if super class fields are used.
    
    Returns:
    
    true if fields used include super class fields; false to use only fields in ColumnsTranslator.getRowClass()
    
    Since:
    
    3.0
    
    See Also:
    
    Row.inhertedFields()
  - setInheritedFields
```
public void setInheritedFields(boolean inheritedFields)
```
    Sets if super class fields are used.
    
    Parameters:
    
    inheritedFields - true if fields used include super class fields; false to use only fields in ColumnsTranslator.getRowClass()
    
    Since:
    
    3.0
    
    See Also:
    
    Row.inhertedFields()
  - getDeclaredFields
```
public java.lang.reflect.Field[] getDeclaredFields()
```
    Gets all of the declared fields for ColumnsTranslator.getRowClass(). Also gets declared fields for subclass(es) if isInheritedFields() is true. Subclass fields appear in array prior to superclass fields.
    
    Returns:
    
    all fields for row class (and optionally row class superclass(es))
    
    Since:
    
    3.0
  - getDeclaredFields
```
protected void getDeclaredFields(java.lang.Class<?> clazz,
                                 java.util.List<java.lang.reflect.Field[]> classHierarchyFields)
```
    Recursively searches for declared fields in super class(es) of clazz and then clazz parameter.
    
    Parameters:
    
    clazz - get fields from this class and superclass(es)
    
    classHierarchyFields - each class fields are added to this list
    
    Since:
    
    3.0
  - getDeclaredField
```
public java.lang.reflect.Field getDeclaredField(java.lang.String fieldName)
```
    Gets a declared field of ColumnsTranslator.getRowClass(). Searches for declared fields in subclass(es) of ColumnsTranslator.getRowClass() if isInheritedFields() is true. Subclasses are searched prior to to super classes.
    
    Parameters:
    
    fieldName - get field for this name
    
    Returns:
    
    field for row class (and optionally row class superclass(es)); null if field not found
    
    Since:
    
    3.0
  - getDeclaredField
```
protected java.lang.reflect.Field getDeclaredField(java.lang.Class<?> clazz,
                                                   java.lang.String fieldName)
```
    Recursively searches for declared field in superclass(es) of clazz and then clazz parameter.
    
    Parameters:
    
    clazz - get fields from this class and superclass(es)
    
    fieldName - get field for this name
    
    Returns:
    
    field or null if not found
    
    Since:
    
    3.0
  - initColumnTranslators
```
protected void initColumnTranslators()
                              throws TranslatorException
```
    Process Transient and Cascade annotations.
    Versions prior to 1.9.2 did not allow type translators to be replaced. Starting with version 1.9.2 and 2.3.2, this method will replace existing type translator with new one ImplicitType.translator() is different from existing.
    
    Throws:
    
    TranslatorException - if error
  - getCascadeFieldList
```
public java.util.List<java.lang.reflect.Field> getCascadeFieldList()
```
    Gets list of fields that are to be cascaded. Fields are in this list if they have a cascade annotation or if they have the following:
    - field is Collection
    - field is a Map
    - field is an array
    - field is a class that has no TypeTranslator
    Returns:
    
    list of fields that should be cascaded
    
    Since:
    
    3.1
  - initUnusedColumnSql
```
protected void initUnusedColumnSql(java.lang.Class<R> rowClass)
                            throws TranslatorException
```
    Process UnusedColumns annotations.
    
    Parameters:
    
    rowClass - class of row
    
    Throws:
    
    TranslatorException - if error
  - getPrimaryKeyWhereTranslator
```
public PrimaryKeyWhereTranslator<R> getPrimaryKeyWhereTranslator()
```
    Gets primary key translator for use in where clause.
    
    Returns:
    
    translator for primary key columns
  - getUnusedColumnInsertNamesSql
```
public java.lang.String getUnusedColumnInsertNamesSql()
```
    Gets names of unused columns for insert statement.
    
    Returns:
    
    ", uc1, uc2, uc3..." for all unused columns
  - getUnusedColumnInsertValuesSql
```
public java.lang.String getUnusedColumnInsertValuesSql()
```
    Gets values for unused columns for insert statement.
    
    Returns:
    
    ", v1, v2, v3..." for all unused columns
  - getUnusedColumnUpdateSql
```
public java.lang.String getUnusedColumnUpdateSql()
```
    Gets column=value for all unused columns for update statement.
    
    Returns:
    
    ", uc1=v1, uc2=v2, uc3=v3..." for all unused columns

Class RowTranslator<R>

Constructor Summary

Method Summary

Methods inherited from class org.sormula.translator.ColumnsTranslator

Methods inherited from class java.lang.Object

Constructor Detail

RowTranslator

Method Detail

getFieldAccessType

createRowField

getIdentityColumnTranslator

isInheritedFields

setInheritedFields

getDeclaredFields

getDeclaredFields

getDeclaredField

getDeclaredField

initColumnTranslators

getCascadeFieldList

initUnusedColumnSql

getPrimaryKeyWhereTranslator

getUnusedColumnInsertNamesSql

getUnusedColumnInsertValuesSql

getUnusedColumnUpdateSql