RowDefinitionClassWrapper (DBvolution 7 0.9.13-SNAPSHOT API)

java.lang.Object
- nz.co.gregs.dbvolution.internal.properties.RowDefinitionClassWrapper

```
public class RowDefinitionClassWrapper
extends Object
```
Wraps the class-type of an end-user's data model object. Generally it's expected that the class is annotated with DBvolution annotations to mark the table name and the fields or bean properties that map to columns, however this class will work against any class type.
To wrap a target object instance, use the instanceWrapperFor(nz.co.gregs.dbvolution.query.RowDefinition) method.
Note: instances of this class are expensive to create, and are intended to be cached and kept long-term. Instances can be safely shared between DBDatabase instances for different database types.
Instances of this class are thread-safe.
Support DBvolution at Patreon

Author:

Malcolm Lett

Constructor Summary

Constructors
Constructor and Description
`RowDefinitionClassWrapper(Class<? extends RowDefinition> clazz)` Fully constructs a wrapper for the given class, including performing all validations that can be performed up front.

Method Summary

Methods
Modifier and Type	Method and Description
`Class<? extends RowDefinition>`	`adapteeClass()` Gets the underlying wrapped class.
`boolean`	`equals(Object obj)` Two `RowDefinitionClassWrappers` are equal if they wrap the same classes.
`List<PropertyWrapperDefinition>`	`getAutoFillingPropertyDefinitions()` Gets all properties NOT annotated with `DBColumn`.
`List<PropertyWrapperDefinition>`	`getColumnPropertyDefinitions()` Gets all properties annotated with `DBColumn`.
`List<PropertyWrapperDefinition>`	`getForeignKeyPropertyDefinitions()` Gets all foreign key properties.
`List<PropertyWrapperDefinition>`	`getPrimaryKeyPropertyDefinitions()` Gets all primary key properties.
`PropertyWrapperDefinition`	`getPropertyDefinitionByColumn(DBDatabase database, String columnName)` Gets the property associated with the given column.
`PropertyWrapperDefinition`	`getPropertyDefinitionByName(String propertyName)` Gets the property by its java property name.
`int`	`hashCode()` Calculates the hash-code based on the hash-code of the wrapped class.
`RowDefinitionInstanceWrapper`	`instanceWrapperFor(RowDefinition target)` Gets an object wrapper instance for the given target object
`boolean`	`isTable()` Indicates whether this class maps to a database table.
`String`	`javaName()` Gets the simple name of the class being wrapped by this adaptor.
`PropertyWrapperDefinition[]`	`primaryKeyDefinitions()` Gets the property that is the primary key, if one is marked.
`String`	`qualifiedJavaName()` Gets the fully qualified name of the class being wrapped by this adaptor.
`String`	`selectQuery()` Support DBvolution at Patreon
`String`	`tableName()` Gets the indicated table name.
`String`	`toString()` Gets a string representation suitable for debugging.

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

- Constructor Detail
  - RowDefinitionClassWrapper
```
public RowDefinitionClassWrapper(Class<? extends RowDefinition> clazz)
```
    Fully constructs a wrapper for the given class, including performing all validations that can be performed up front.
    
    Parameters:
    clazz - the DBRow class to wrap
- Method Detail
  - instanceWrapperFor
```
public RowDefinitionInstanceWrapper instanceWrapperFor(RowDefinition target)
```
    Gets an object wrapper instance for the given target object
    
    Parameters:
    target - the DBRow instance
    Support DBvolution at Patreon
    
    Returns:
    A RowDefinitionInstanceWrapper for the supplied target.
  - toString
```
public String toString()
```
    Gets a string representation suitable for debugging.
    Support DBvolution at Patreon
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this object.
  - equals
```
public boolean equals(Object obj)
```
    Two RowDefinitionClassWrappers are equal if they wrap the same classes.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - obj
    Support DBvolution at Patreon
    
    Returns:
    true if the two objects are equal, false otherwise.
  - hashCode
```
public int hashCode()
```
    Calculates the hash-code based on the hash-code of the wrapped class.
    Support DBvolution at Patreon
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash-code
  - adapteeClass
```
public Class<? extends RowDefinition> adapteeClass()
```
    Gets the underlying wrapped class.
    Support DBvolution at Patreon
    
    Returns:
    the DBRow or Object wrapped by this instance.
  - javaName
```
public String javaName()
```
    Gets the simple name of the class being wrapped by this adaptor.
    Use tableName() for the name of the table mapped to this class.
    Equivalent to this.adaptee().getSimpleName();
    Support DBvolution at Patreon
    
    Returns:
    the SimpleName of the class being wrapped.
  - qualifiedJavaName
```
public String qualifiedJavaName()
```
    Gets the fully qualified name of the class being wrapped by this adaptor.
    Use tableName() for the name of the table mapped to this class.
    Support DBvolution at Patreon
    
    Returns:
    the fully qualified name of the class being wrapped.
  - isTable
```
public boolean isTable()
```
    Indicates whether this class maps to a database table.
    Support DBvolution at Patreon
    
    Returns:
    TRUE if this RowDefinitionClassWrapper represents a database table or view, otherwise FALSE.
  - tableName
```
public String tableName()
```
    Gets the indicated table name. Applies defaulting if the DBTableName annotation is present but doesn't provide an explicit table name.
    If the DBTableName annotation is missing, this method returns null.
    Use TableHandler.getDBTableNameAnnotation() for low level access.
    Support DBvolution at Patreon
    
    Returns:
    the table name, if specified explicitly or implicitly.
  - selectQuery
```
public String selectQuery()
```
    Support DBvolution at Patreon
    
    Returns:
    the table name, if specified explicitly or implicitly.
  - primaryKeyDefinitions
```
public PropertyWrapperDefinition[] primaryKeyDefinitions()
```
    Gets the property that is the primary key, if one is marked. Note: multi-column primary key tables are not yet supported.
    Support DBvolution at Patreon
    
    Returns:
    the primary key property or null if no primary key
  - getPropertyDefinitionByColumn
```
public PropertyWrapperDefinition getPropertyDefinitionByColumn(DBDatabase database,
                                                      String columnName)
```
    Gets the property associated with the given column. If multiple properties are annotated for the same column, this method will return only the first.
    Only provides access to properties annotated with DBColumn.
    Assumes validation is applied elsewhere to prohibit duplication of column names.
    
    Parameters:
    database - active database
    columnName - columnName columnName
    Support DBvolution at Patreon
    
    Returns:
    the PropertyWrapperDefinition for the column name supplied. Null if no such column is found.
    
    Throws:
    
    AssertionError - if called when in identityOnly mode.
  - getPropertyDefinitionByName
```
public PropertyWrapperDefinition getPropertyDefinitionByName(String propertyName)
```
    Gets the property by its java property name.
    Only provides access to properties annotated with DBColumn.
    It's legal for a field and bean-property to have the same name, and to both be annotated, but for different columns. This method doesn't handle that well and returns only the first one it sees.
    
    Parameters:
    propertyName - propertyName
    Support DBvolution at Patreon
    
    Returns:
    the PropertyWrapperDefinition for the named object property Null if no such property is found.
    
    Throws:
    
    AssertionError - if called when in identityOnly mode.
  - getColumnPropertyDefinitions
```
public List<PropertyWrapperDefinition> getColumnPropertyDefinitions()
```
    Gets all properties annotated with DBColumn.
    Support DBvolution at Patreon
    
    Returns:
    a List of all PropertyWrapperDefinitions for the wrapped class.
  - getAutoFillingPropertyDefinitions
```
public List<PropertyWrapperDefinition> getAutoFillingPropertyDefinitions()
```
    Gets all properties NOT annotated with DBColumn.
    Support DBvolution at Patreon
    
    Returns:
    a List of all PropertyWrapperDefinitions for the wrapped class.
  - getForeignKeyPropertyDefinitions
```
public List<PropertyWrapperDefinition> getForeignKeyPropertyDefinitions()
```
    Gets all foreign key properties.
    Support DBvolution at Patreon
    
    Returns:
    a list of ProperyWrapperDefinitions for all the foreign keys defined in the wrapped object
  - getPrimaryKeyPropertyDefinitions
```
public List<PropertyWrapperDefinition> getPrimaryKeyPropertyDefinitions()
```
    Gets all primary key properties.
    Support DBvolution at Patreon
    
    Returns:
    a list of ProperyWrapperDefinitions for all the foreign keys defined in the wrapped object

Class RowDefinitionClassWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RowDefinitionClassWrapper

Method Detail

instanceWrapperFor

toString

equals

hashCode

adapteeClass

javaName

qualifiedJavaName

isTable

tableName

selectQuery

primaryKeyDefinitions

getPropertyDefinitionByColumn

getPropertyDefinitionByName

getColumnPropertyDefinitions

getAutoFillingPropertyDefinitions

getForeignKeyPropertyDefinitions

getPrimaryKeyPropertyDefinitions