DirectPrimaryKey (hrorm 0.15.1 API)

java.lang.Object
- org.hrorm.DirectPrimaryKey<ENTITY>

Type Parameters:

ENTITY - The type of the class being persisted.

All Implemented Interfaces:

Column<Long,Long,ENTITY,ENTITY>, PrimaryKey<ENTITY,ENTITY>
```
public class DirectPrimaryKey<ENTITY>
extends Object
implements PrimaryKey<ENTITY,ENTITY>
```
Primary key for an entity whose construction is direct, i.e. the entity has setters.
Most users of hrorm will have no need to directly use this.

Constructor Summary

Constructors
Constructor and Description
`DirectPrimaryKey(String prefix, String name, String sequenceName, Function<ENTITY,Long> getter, BiConsumer<ENTITY,Long> setter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenericColumn<Long>`	`asGenericColumn()` Returns a generic column instance that supports the underlying `DBTYPE`
`Long`	`getKey(ENTITY item)` Reads the value of the primary key from the passed entity object.
`String`	`getName()` The name of the database column this instance represents.
`String`	`getPrefix()` The prefix that should be used for this column when generating SQL.
`String`	`getSequenceName()` The name of the database sequence that is used to populate this key
`String`	`getSqlTypeName()` Returns the name of the column type in SQL, e.g.
`boolean`	`isNullable()` Indicator of whether or not this column is nullable or not.
`boolean`	`isPrimaryKey()` Flag indicating whether or not this column is the primary key of the table
`void`	`notNull()` Calling this method will enforce a not-null constraint on this column.
`void`	`optimisticSetKey(ENTITY item, Long id)` Sets the key onto the object
`PopulateResult`	`populate(ENTITY constructor, ResultSet resultSet)` Populates the passed builder object with the data read from the database.
`void`	`setSqlTypeName(String sqlTypeName)` Set the name of the type of this column as it would be in the SQL schema.
`void`	`setValue(ENTITY item, int index, PreparedStatement preparedStatement)` Sets a value onto the prepared statement based on the state of the object passed.
`Set<Integer>`	`supportedTypes()` The members of `java.sql.Types` that this column should support.
`Long`	`toClassType(Long value)` Applies any `Converter` associated with this column to a raw database type.
`Column<Long,Long,ENTITY,ENTITY>`	`withPrefix(String newPrefix, Prefixer prefixer)` Make a new instance of the column, identical to this instance, except with a new prefix.

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

Methods inherited from interface org.hrorm.PrimaryKey
getKeyPrimitive

Methods inherited from interface org.hrorm.Column
fromResultSet, isParentColumn

- Constructor Detail
  - DirectPrimaryKey
```
public DirectPrimaryKey(String prefix,
                        String name,
                        String sequenceName,
                        Function<ENTITY,Long> getter,
                        BiConsumer<ENTITY,Long> setter)
```
- Method Detail
  - getKey
```
public Long getKey(ENTITY item)
```
    Description copied from interface: PrimaryKey
    
    Reads the value of the primary key from the passed entity object.
    
    Specified by:
    
    getKey in interface PrimaryKey<ENTITY,ENTITY>
    
    Parameters:
    
    item - The object whose primary key is to be read.
    
    Returns:
    
    The primary key, or null.
  - getSequenceName
```
public String getSequenceName()
```
    Description copied from interface: PrimaryKey
    
    The name of the database sequence that is used to populate this key
    
    Specified by:
    
    getSequenceName in interface PrimaryKey<ENTITY,ENTITY>
    
    Returns:
    
    the sequence name
  - optimisticSetKey
```
public void optimisticSetKey(ENTITY item,
                             Long id)
```
    Description copied from interface: PrimaryKey
    
    Sets the key onto the object
    
    Specified by:
    
    optimisticSetKey in interface PrimaryKey<ENTITY,ENTITY>
    
    Parameters:
    
    item - the object whose key is to be set
    
    id - the primary key to assign it
  - getName
```
public String getName()
```
    Description copied from interface: Column
    
    The name of the database column this instance represents.
    
    Specified by:
    
    getName in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    The name of the column in the underlying database.
  - getPrefix
```
public String getPrefix()
```
    Description copied from interface: Column
    
    The prefix that should be used for this column when generating SQL. This is necessary to prevent name clashes between columns of other tables that might be joined with this one.
    
    Specified by:
    
    getPrefix in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    The prefix to use when generating SQL with this column instance.
  - populate
```
public PopulateResult populate(ENTITY constructor,
                               ResultSet resultSet)
                        throws SQLException
```
    Description copied from interface: Column
    
    Populates the passed builder object with the data read from the database.
    
    Specified by:
    
    populate in interface Column<Long,Long,ENTITY,ENTITY>
    
    Parameters:
    
    constructor - The object being populated
    
    resultSet - The result said being read
    
    Returns:
    
    A coded value indicating information about what happened during population
    
    Throws:
    
    SQLException - allowed for ResultSet operations
  - setValue
```
public void setValue(ENTITY item,
                     int index,
                     PreparedStatement preparedStatement)
              throws SQLException
```
    Description copied from interface: Column
    
    Sets a value onto the prepared statement based on the state of the object passed.
    
    Specified by:
    
    setValue in interface Column<Long,Long,ENTITY,ENTITY>
    
    Parameters:
    
    item - The object to read the data from.
    
    index - Where in the prepared statement to set the read value
    
    preparedStatement - The statement being populated
    
    Throws:
    
    SQLException - allowed for PreparedStatement operations
  - withPrefix
```
public Column<Long,Long,ENTITY,ENTITY> withPrefix(String newPrefix,
                                                  Prefixer prefixer)
```
    Description copied from interface: Column
    
    Make a new instance of the column, identical to this instance, except with a new prefix.
    
    Specified by:
    
    withPrefix in interface Column<Long,Long,ENTITY,ENTITY>
    
    Parameters:
    
    newPrefix - The new prefix
    
    prefixer - The source for new prefixes
    
    Returns:
    
    A new instance of the column with the reset prefix
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Description copied from interface: Column
    
    Flag indicating whether or not this column is the primary key of the table
    
    Specified by:
    
    isPrimaryKey in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    true if this column represents the primary key of the table, otherwise false
  - notNull
```
public void notNull()
```
    Description copied from interface: Column
    
    Calling this method will enforce a not-null constraint on this column.
    
    Specified by:
    
    notNull in interface Column<Long,Long,ENTITY,ENTITY>
  - supportedTypes
```
public Set<Integer> supportedTypes()
```
    Description copied from interface: Column
    
    The members of java.sql.Types that this column should support.
    
    Specified by:
    
    supportedTypes in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    The types that should be handled by this column type.
  - isNullable
```
public boolean isNullable()
```
    Description copied from interface: Column
    
    Indicator of whether or not this column is nullable or not.
    
    Specified by:
    
    isNullable in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    true if this column is allowed to contain null values, false otherwise.
  - getSqlTypeName
```
public String getSqlTypeName()
```
    Description copied from interface: Column
    
    Returns the name of the column type in SQL, e.g. "text" for String, "decimal" for BigDecimal.
    
    Specified by:
    
    getSqlTypeName in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    The SQL name of the type.
  - setSqlTypeName
```
public void setSqlTypeName(String sqlTypeName)
```
    Description copied from interface: Column
    
    Set the name of the type of this column as it would be in the SQL schema.
    
    Specified by:
    
    setSqlTypeName in interface Column<Long,Long,ENTITY,ENTITY>
    
    Parameters:
    
    sqlTypeName - The name of the SQL type.
  - toClassType
```
public Long toClassType(Long value)
```
    Description copied from interface: Column
    
    Applies any Converter associated with this column to a raw database type.
    
    Specified by:
    
    toClassType in interface Column<Long,Long,ENTITY,ENTITY>
    
    Parameters:
    
    value - The value of an element represented by this column, as stored in the database, or at least, as represented in the JDBC.
    
    Returns:
    
    The value in the type as defined on the ENTITY class.
  - asGenericColumn
```
public GenericColumn<Long> asGenericColumn()
```
    Description copied from interface: Column
    
    Returns a generic column instance that supports the underlying DBTYPE
    
    Specified by:
    
    asGenericColumn in interface Column<Long,Long,ENTITY,ENTITY>
    
    Returns:
    
    A generic column instance.

Class DirectPrimaryKey<ENTITY>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hrorm.PrimaryKey

Methods inherited from interface org.hrorm.Column

Constructor Detail

DirectPrimaryKey

Method Detail

getKey

getSequenceName

optimisticSetKey

getName

getPrefix

populate

setValue

withPrefix

isPrimaryKey

notNull

supportedTypes

isNullable

getSqlTypeName

setSqlTypeName

toClassType

asGenericColumn