org.hrorm

Class StringColumn<T>

java.lang.Object

org.hrorm.StringColumn<T>

Type Parameters:

T - The entity type this column belongs to

All Implemented Interfaces:

TypedColumn<T>

public class StringColumn<T>
extends Object
implements TypedColumn<T>

Describes a column with a text value that can be mapped to a String

Most users of hrorm will have no need to directly use this.

Constructor Summary

Constructors

Constructor and Description
StringColumn(String name, String prefix, Function<T,String> getter, BiConsumer<T,String> setter)
StringColumn(String name, String prefix, Function<T,String> getter, BiConsumer<T,String> setter, boolean nullable)

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getPrefix()
boolean	isPrimaryKey()
void	notNull() Calling this method will enforce a not-null constraint on this column.
PopulateResult	populate(T item, ResultSet resultSet) Populates the object with the data read from the database.
void	setValue(T item, int index, PreparedStatement preparedStatement) Sets a value onto the prepared statement based on the state of the object passed.
TypedColumn<T>	withPrefix(String prefix, 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

Constructor Detail

StringColumn

public StringColumn(String name,
                    String prefix,
                    Function<T,String> getter,
                    BiConsumer<T,String> setter,
                    boolean nullable)

StringColumn

public StringColumn(String name,
                    String prefix,
                    Function<T,String> getter,
                    BiConsumer<T,String> setter)

Method Detail

withPrefix

public TypedColumn<T> withPrefix(String prefix,
                                 Prefixer prefixer)

Description copied from interface: TypedColumn

Make a new instance of the column, identical to this instance, except with a new prefix.

Specified by:

withPrefix in interface TypedColumn<T>

Parameters:

prefix - The new prefix

prefixer - The source for new prefixes

Returns:

A new instance of the column with the reset prefix

getName

public String getName()

Specified by:

getName in interface TypedColumn<T>

Returns:

The name of the column in the underlying database.

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface TypedColumn<T>

Returns:

The prefix to use when generating SQL with this column instance.

populate

public PopulateResult populate(T item,
                               ResultSet resultSet)
                        throws SQLException

Description copied from interface: TypedColumn

Populates the object with the data read from the database.

Specified by:

populate in interface TypedColumn<T>

Parameters:

item - 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(T item,
                     int index,
                     PreparedStatement preparedStatement)
              throws SQLException

Description copied from interface: TypedColumn

Sets a value onto the prepared statement based on the state of the object passed.

Specified by:

setValue in interface TypedColumn<T>

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

isPrimaryKey

public boolean isPrimaryKey()

Specified by:

isPrimaryKey in interface TypedColumn<T>

Returns:

true if this column represents the primary key of the table

notNull

public void notNull()

Description copied from interface: TypedColumn

Calling this method will enforce a not-null constraint on this column.

Specified by:

notNull in interface TypedColumn<T>