org.hrorm

Class DirectPrimaryKey<ENTITY>

java.lang.Object

org.hrorm.DirectPrimaryKey<ENTITY>

Type Parameters:

ENTITY - The type of the class being persisted.

All Implemented Interfaces:

Column<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

Modifier and Type	Method and Description
Long	getKey(ENTITY item)
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
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 object with the data read from the database.
void	setKey(ENTITY builder, Long id)
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.
Column<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.Column

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)

Specified by:

getKey in interface PrimaryKey<ENTITY,ENTITY>

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

setKey

public void setKey(ENTITY builder,
                   Long id)

Specified by:

setKey in interface PrimaryKey<ENTITY,ENTITY>

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<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<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 object with the data read from the database.

Specified by:

populate in interface Column<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<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<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<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<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<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<ENTITY,ENTITY>

Returns:

The types that should be handled by this column type.