com.feedzai.commons.sql.abstraction.engine

Class MappedEntity

java.lang.Object

com.feedzai.commons.sql.abstraction.engine.MappedEntity

All Implemented Interfaces:

java.lang.AutoCloseable

public class MappedEntity
extends java.lang.Object
implements java.lang.AutoCloseable

Mapped entity contains information about an entity that has been mapped using the engine.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

Constructor Summary

Constructors

Constructor and Description
MappedEntity() Creates a new instance of MappedEntity.

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.String	getAutoIncColumn() Gets the auto increment column.
DbEntity	getEntity() Gets the entity.
java.sql.PreparedStatement	getInsert() Gets the prepared statement for inserts.
java.sql.PreparedStatement	getInsertReturning() Gets the prepared statement for inserts that retrieve the generated keys using the insert statement.
java.sql.PreparedStatement	getInsertWithAutoInc() Gets the insert statement with auto increment columns.
boolean	isSequenceDirty() Checks if a sequence is dirty.
MappedEntity	setAutoIncColumn(java.lang.String autoIncColumn) Sets the auto increment column.
MappedEntity	setEntity(DbEntity entity) Sets the entity.
MappedEntity	setInsert(java.sql.PreparedStatement insert) Sets the insert statement.
MappedEntity	setInsertReturning(java.sql.PreparedStatement insertReturning) Sets the insert statement that allows returning the generated keys.
MappedEntity	setInsertWithAutoInc(java.sql.PreparedStatement insertWithAutoInc) Sets the insert statement auto inc columns.
void	setSequenceDirty(boolean sequenceDirty) Sets a sequence as dirty or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MappedEntity

public MappedEntity()

Creates a new instance of MappedEntity.

Method Detail

setEntity

public MappedEntity setEntity(DbEntity entity)

Sets the entity.

Parameters:

entity - The entity.

Returns:

This mapped entity

setInsert

public MappedEntity setInsert(java.sql.PreparedStatement insert)

Sets the insert statement.

Parameters:

insert - The insert statement.

Returns:

This mapped entity

getEntity

public DbEntity getEntity()

Gets the entity.

Returns:

The entity.

getInsert

public java.sql.PreparedStatement getInsert()

Gets the prepared statement for inserts.

Returns:

The prepared statement for inserts.

getInsertReturning

public java.sql.PreparedStatement getInsertReturning()

Gets the prepared statement for inserts that retrieve the generated keys using the insert statement.

Returns:

The insert statement that allows returning the generated keys.

setInsertReturning

public MappedEntity setInsertReturning(java.sql.PreparedStatement insertReturning)

Sets the insert statement that allows returning the generated keys.

Parameters:

insertReturning - The insert statement that allows returning the generated keys

Returns:

This mapped entity

getInsertWithAutoInc

public java.sql.PreparedStatement getInsertWithAutoInc()

Gets the insert statement with auto increment columns.

Returns:

The insert statement with auto increment columns.

See Also:

DatabaseEngine.persist(String, EntityEntry, boolean)

setInsertWithAutoInc

public MappedEntity setInsertWithAutoInc(java.sql.PreparedStatement insertWithAutoInc)

Sets the insert statement auto inc columns.

Parameters:

insertWithAutoInc - The insert statement with auto inc columns.

Returns:

This mapped entity;

See Also:

DatabaseEngine.persist(String, EntityEntry, boolean)

getAutoIncColumn

public java.lang.String getAutoIncColumn()

Gets the auto increment column.

Returns:

The auto increment column.

setAutoIncColumn

public MappedEntity setAutoIncColumn(java.lang.String autoIncColumn)

Sets the auto increment column.

Parameters:

autoIncColumn - the auto increment column.

Returns:

This mapped entity.

isSequenceDirty

public boolean isSequenceDirty()

Checks if a sequence is dirty. A sequence is dirty only if it was potentially marked as so and there's an auto increment column set.

Returns:

true if the sequence is dirty, false otherwise.

setSequenceDirty

public void setSequenceDirty(boolean sequenceDirty)

Sets a sequence as dirty or not.

Parameters:

sequenceDirty - The flag signaling the status of the sequence.

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception