Package lu.kbra.pclib.db.utils

Class BaseDatabaseEntryUtils

java.lang.Object

lu.kbra.pclib.db.utils.BaseDatabaseEntryUtils

All Implemented Interfaces:

TreeStringConvertible, DatabaseEntryUtils, DatabaseEntryUtilsOptionsOwner, MapConvertible

Direct Known Subclasses:

BaseProxyDatabaseEntryUtils

public class BaseDatabaseEntryUtils
extends Object
implements DatabaseEntryUtils, TreeStringConvertible

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnTypeProvider	columnTypeProvider
protected DatabaseScanner	databaseScanner
protected final String	dbmsQualifierName
protected EntryInstanceProvider	entryInstanceProvider
protected SQLFunctionResolver	functionResolver
protected HintScanner	hintScanner
protected Map<String,Object>	options
protected SQLQueryableHookManager	queryableHookManager
protected SQLStructureVisitor	structureVisitor

Fields inherited from interface lu.kbra.pclib.db.utils.impl.DatabaseEntryUtils

ALIAS_KEY, DBMS_FILTER_ALL, EMPTY_ARRAY, EMPTY_MAP, EMPTY_OPTIONAL, EMPTY_SET, FIELD_NAME_KEY, FUNCTION_KEY, MEMBER_KEY, PARAMETER_COLUMN_KEY, PARAMETER_VALUE_KEY, PROPERTY_ENVIRONMENT_KEY, PROPERTY_KEY, PROPERTY_PROP_KEY, PROPERTY_QUERYABLE_KEY, QUALIFIER_KEY, TABLE_KEY, TABLE_NAME_KEY

Fields inherited from interface lu.kbra.pclib.db.utils.impl.DatabaseEntryUtilsOptionsOwner

FAIL_ON_DUPLICATE_FACTORY_METHOD, FAIL_ON_DUPLICATE_FACTORY_METHOD_PROPERTY, FORCE_DEFAULT_VALUE_ON_NON_NULL, FORCE_DEFAULT_VALUE_ON_NON_NULL_PROPERTY, LAZY_CONSTRUCTOR_SCAN, LAZY_CONSTRUCTOR_SCAN_PROPERTY

Constructor Summary

Constructors

Constructor	Description
BaseDatabaseEntryUtils(String protocolName)
BaseDatabaseEntryUtils(ColumnTypeRegistry columnTypeRegistry, EncodingTypeRegistry encodingTypeRegistry, String protocolName)
BaseDatabaseEntryUtils(ColumnTypeRegistry columnTypeRegistry, EncodingTypeRegistry encodingTypeRegistry, String protocolName, SQLStructureVisitor structureVisitor, SQLFunctionResolver functionResolver)

Method Summary

Modifier and Type	Method	Description
void	appendColumnTypes(ColumnTypeRegistry columnTypeRegistry)
void	appendEncodingTypes(EncodingTypeRegistry encodingTypeRegistry)
protected Method	computeFactoryMethod(Class<?> clazz)
<T extends DatabaseEntry> BitSet	computeInsertColumnMask(AbstractDBTable<? extends T> table, T data)
<T extends DatabaseEntry> void	fillInsert(AbstractDBTable<? extends T> table, T data, ResultSet rs)	Only reload generated keys
<T extends DatabaseEntry> T	fillLoad(Class<T> entryClazz, ResultSet rs, EntryInstanceProvider.FactoryMethod factoryMethod)
<T extends DatabaseEntry> void	fillLoad(SQLQueryable<? extends T> table, T data, ResultSet rs)	Full reload
<T extends DatabaseEntry> void	fillLoadAll(SQLQueryable<? extends T> table, Class<T> entryClazz, ResultSet rs, Consumer<T> listExporter)
ColumnData	getColumnFor(SQLQueryableStructure structure, String localName)
ColumnData	getColumnForMember(SQLQueryableStructure structure, String fieldName)
<T extends DatabaseEntry> ColumnData[]	getInsertColumns(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> String[]	getInsertGeneratedColumnNames(AbstractDBTable<? extends T> table)	Deprecated.
<T extends DatabaseEntry> ColumnData[]	getInsertGeneratedColumns(AbstractDBTable<? extends T> table)	Deprecated.
<T extends DatabaseEntry> Method	getInsertMethod(Class<T> dataClazz)
<T extends DatabaseEntry> Method	getLoadMethod(Class<T> dataClazz)
<T extends DatabaseEntry> ColumnData[]	getNonNullColumns(SQLQueryable<? extends T> table)	NOT OnUpdate, NOT PK, NOT Generated
<T extends DatabaseEntry> String[]	getNonNullKeys(SQLQueryable<? extends T> instance, T data)	returns the names of the columns that aren't null. ignored primary keys, generated and OnUpdate columns.
<T extends DatabaseEntry> Map<String,Object>	getNonNullValues(SQLQueryable<? extends T> instance, T data)
<T extends DatabaseEntry> String	getPreparedDeleteAllSQL(AbstractDBTable<? extends T> table, int count)
<T extends DatabaseEntry> String	getPreparedDeleteSql(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> String	getPreparedDeleteSQL(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> String	getPreparedInsertSQL(AbstractDBTable<? extends T> table, T data)
<T extends DatabaseEntry> String	getPreparedSelectAllSQL(SQLQueryable<? extends T> table, int count)
<T extends DatabaseEntry> String	getPreparedSelectCountNotNullSQL(SQLQueryable<? extends T> instance, String[] notNullKeys)
<T extends DatabaseEntry> String	getPreparedSelectCountUniqueSQL(SQLQueryable<? extends T> table, String[][] uniqueKeys, boolean[][] isNull)
<T extends DatabaseEntry> String	getPreparedSelectSQL(SQLQueryable<? extends T> table)
<T extends DatabaseEntry> String	getPreparedSelectUniqueSQL(SQLQueryable<? extends T> table, String[][] uniqueKeys, boolean[][] nullable)
<T extends DatabaseEntry> String	getPreparedUpdateSQL(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> ColumnData[]	getPrimaryKeys(SQLQueryable<? extends T> table)
<T extends DatabaseEntry> Object[]	getPrimaryKeyValues(SQLQueryable<? extends T> table, T data)
<T extends DatabaseEntry> String	getTruncateSQL(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> Pair<String[][],boolean[][]>	getUniqueKeys(SQLQueryable<? extends T> table, T data)
<T extends DatabaseEntry> Map<String,Pair<Object,Boolean>>[]	getUniqueValues(SQLQueryable<? extends T> table, T data)
<T extends DatabaseEntry> ColumnData[]	getUpdateColumns(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> String[]	getUpdateColumnsExpr(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> String[]	getUpdateColumnsNames(AbstractDBTable<? extends T> table)
<T extends DatabaseEntry> ColumnData[]	getUpdateGeneratedColumns(AbstractDBTable<? extends T> table)	Deprecated.
<T extends DatabaseEntry> String[]	getUpdateGeneratedColumnsNames(AbstractDBTable<? extends T> table)	Deprecated.
<T extends DatabaseEntry> Method	getUpdateMethod(Class<T> dataClazz)
DatabaseEntryUtils	loadTypes(ColumnTypeRegistry registry)
DatabaseEntryUtils	loadTypes(EncodingTypeRegistry registry)
<T extends DatabaseEntry> void	prepareDeleteSQL(PreparedStatement stmt, AbstractDBTable<? extends T> table, T data)
<T extends DatabaseEntry> void	prepareInsertSQL(PreparedStatement stmt, AbstractDBTable<? extends T> table, T data)
<T extends DatabaseEntry> void	prepareSelectCountNotNullSQL(PreparedStatement stmt, SQLQueryable<? extends T> table, String[] notNullKeys, T data)
<T extends DatabaseEntry> void	prepareSelectCountUniqueSQL(PreparedStatement stmt, SQLQueryable<? extends T> table, String[][] uniqueKeys, boolean[][] nullable, T data)
<T extends DatabaseEntry> void	prepareSelectSQL(PreparedStatement stmt, SQLQueryable<? extends T> table, T data)
<T extends DatabaseEntry> void	prepareSelectUniqueSQL(PreparedStatement stmt, SQLQueryable<? extends T> table, String[][] uniqueKeys, boolean[][] nullable, T data)
<T extends DatabaseEntry> void	prepareUpdateSQL(PreparedStatement stmt, AbstractDBTable<? extends T> table, T data)
<T extends DatabaseEntry> String	resolveSQLQualifiers(SQLQueryable<? extends T> table, String input, Map<String,String> data, Function<String,Optional<String>> func)
List<Field>	sortFields(Field[] fields)
Map<String,Object>	toMap()

Methods inherited from class java.lang.Object

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

Methods inherited from interface lu.kbra.pclib.db.utils.impl.DatabaseEntryUtils

fieldToColumnName, fieldToColumnName, getColumnFor, getColumnForMember, getColumnTypeProvider, getDatabaseScanner, getDbmsQualifierName, getEncodingTypeProvider, getEntryInstanceProvider, getForeignKeyNames, getForeignKeyNames, getForeignKeys, getForeignKeys, getFunctionResolver, getHintScanner, getNullValues, getPrimaryKeyNames, getPrimaryKeyNames, getPrimaryKeys, getQueryableHookManager, getStructureVisitor, getTypeFor, getUniqueKeys, matchesDbmsQualifier, parameterToColumnName, resolveSQLQualifiers, resolveSQLQualifiers, setColumnTypeProvider, setDatabaseScanner, setEntryInstanceProvider, setFunctionResolver, setHintScanner, setQueryableHookManager, setStructureVisitor

Methods inherited from interface lu.kbra.pclib.db.utils.impl.DatabaseEntryUtilsOptionsOwner

getOption, getOptionOrDefault, getOptionOrDefault, getOptions, hasOption, isFailOnDuplicateFactoryMethod, isForceDefaultValueOnNonNull, isLazyConstructorScan, setOption, setOptions, unsertOption

Methods inherited from interface lu.kbra.pclib.db.domain.table.TreeStringConvertible

toTreeString

Field Details

dbmsQualifierName

protected final String dbmsQualifierName

hintScanner

protected HintScanner hintScanner

columnTypeProvider

protected ColumnTypeProvider columnTypeProvider

entryInstanceProvider

protected EntryInstanceProvider entryInstanceProvider

functionResolver

protected SQLFunctionResolver functionResolver

structureVisitor

protected SQLStructureVisitor structureVisitor

queryableHookManager

protected SQLQueryableHookManager queryableHookManager

databaseScanner

protected DatabaseScanner databaseScanner

options

protected Map<String,Object> options

Constructor Details

BaseDatabaseEntryUtils

public BaseDatabaseEntryUtils(ColumnTypeRegistry columnTypeRegistry,
 EncodingTypeRegistry encodingTypeRegistry,
 String protocolName)

BaseDatabaseEntryUtils

public BaseDatabaseEntryUtils(ColumnTypeRegistry columnTypeRegistry,
 EncodingTypeRegistry encodingTypeRegistry,
 String protocolName,
 SQLStructureVisitor structureVisitor,
 SQLFunctionResolver functionResolver)

BaseDatabaseEntryUtils

public BaseDatabaseEntryUtils(String protocolName)

Method Details

appendColumnTypes

public void appendColumnTypes(ColumnTypeRegistry columnTypeRegistry)

Specified by:

appendColumnTypes in interface DatabaseEntryUtils

appendEncodingTypes

public void appendEncodingTypes(EncodingTypeRegistry encodingTypeRegistry)

Specified by:

appendEncodingTypes in interface DatabaseEntryUtils

fillInsert

public <T extends DatabaseEntry> void fillInsert(AbstractDBTable<? extends T> table,
 T data,
 ResultSet rs)
                                          throws SQLException

Description copied from interface: DatabaseEntryUtils

Only reload generated keys

Specified by:

fillInsert in interface DatabaseEntryUtils

Throws:

SQLException

fillLoad

public <T extends DatabaseEntry> void fillLoad(SQLQueryable<? extends T> table,
 T data,
 ResultSet rs)
                                        throws SQLException

Description copied from interface: DatabaseEntryUtils

Full reload

Specified by:

fillLoad in interface DatabaseEntryUtils

Throws:

SQLException

fillLoadAll

public <T extends DatabaseEntry> void fillLoadAll(SQLQueryable<? extends T> table,
 Class<T> entryClazz,
 ResultSet rs,
 Consumer<T> listExporter)
                                           throws SQLException

Specified by:

fillLoadAll in interface DatabaseEntryUtils

Throws:

SQLException

fillLoad

public <T extends DatabaseEntry> T fillLoad(Class<T> entryClazz,
 ResultSet rs,
 EntryInstanceProvider.FactoryMethod factoryMethod)
                                     throws SQLException

Specified by:

fillLoad in interface DatabaseEntryUtils

Throws:

SQLException

getColumnFor

public ColumnData getColumnFor(SQLQueryableStructure structure,
 String localName)

Specified by:

getColumnFor in interface DatabaseEntryUtils

getColumnForMember

public ColumnData getColumnForMember(SQLQueryableStructure structure,
 String fieldName)

Specified by:

getColumnForMember in interface DatabaseEntryUtils

getInsertGeneratedColumns

@Deprecated
public <T extends DatabaseEntry> ColumnData[] getInsertGeneratedColumns(AbstractDBTable<? extends T> table)

Deprecated.

Specified by:

getInsertGeneratedColumns in interface DatabaseEntryUtils

getInsertGeneratedColumnNames

@Deprecated
public <T extends DatabaseEntry> String[] getInsertGeneratedColumnNames(AbstractDBTable<? extends T> table)

Deprecated.

Specified by:

getInsertGeneratedColumnNames in interface DatabaseEntryUtils

getInsertMethod

public <T extends DatabaseEntry> Method getInsertMethod(Class<T> dataClazz)

Specified by:

getInsertMethod in interface DatabaseEntryUtils

getLoadMethod

public <T extends DatabaseEntry> Method getLoadMethod(Class<T> dataClazz)

Specified by:

getLoadMethod in interface DatabaseEntryUtils

getNonNullKeys

public <T extends DatabaseEntry> String[] getNonNullKeys(SQLQueryable<? extends T> instance,
 T data)

Description copied from interface: DatabaseEntryUtils

returns the names of the columns that aren't null. ignored primary keys, generated and OnUpdate columns.

Specified by:

getNonNullKeys in interface DatabaseEntryUtils

getNonNullValues

public <T extends DatabaseEntry> Map<String,Object> getNonNullValues(SQLQueryable<? extends T> instance,
 T data)

Specified by:

getNonNullValues in interface DatabaseEntryUtils

getPreparedDeleteSQL

public <T extends DatabaseEntry> String getPreparedDeleteSQL(AbstractDBTable<? extends T> table)

Specified by:

getPreparedDeleteSQL in interface DatabaseEntryUtils

getPreparedInsertSQL

public <T extends DatabaseEntry> String getPreparedInsertSQL(AbstractDBTable<? extends T> table,
 T data)

Specified by:

getPreparedInsertSQL in interface DatabaseEntryUtils

computeInsertColumnMask

public <T extends DatabaseEntry> BitSet computeInsertColumnMask(AbstractDBTable<? extends T> table,
 T data)

Specified by:

computeInsertColumnMask in interface DatabaseEntryUtils

getPreparedSelectCountNotNullSQL

public <T extends DatabaseEntry> String getPreparedSelectCountNotNullSQL(SQLQueryable<? extends T> instance,
 String[] notNullKeys)

Specified by:

getPreparedSelectCountNotNullSQL in interface DatabaseEntryUtils

getPreparedSelectCountUniqueSQL

public <T extends DatabaseEntry> String getPreparedSelectCountUniqueSQL(SQLQueryable<? extends T> table,
 String[][] uniqueKeys,
 boolean[][] isNull)

Specified by:

getPreparedSelectCountUniqueSQL in interface DatabaseEntryUtils

getPreparedSelectSQL

public <T extends DatabaseEntry> String getPreparedSelectSQL(SQLQueryable<? extends T> table)

Specified by:

getPreparedSelectSQL in interface DatabaseEntryUtils

getPreparedSelectAllSQL

public <T extends DatabaseEntry> String getPreparedSelectAllSQL(SQLQueryable<? extends T> table,
 int count)

Specified by:

getPreparedSelectAllSQL in interface DatabaseEntryUtils

getPreparedDeleteAllSQL

public <T extends DatabaseEntry> String getPreparedDeleteAllSQL(AbstractDBTable<? extends T> table,
 int count)

Specified by:

getPreparedDeleteAllSQL in interface DatabaseEntryUtils

getPreparedSelectUniqueSQL

public <T extends DatabaseEntry> String getPreparedSelectUniqueSQL(SQLQueryable<? extends T> table,
 String[][] uniqueKeys,
 boolean[][] nullable)

Specified by:

getPreparedSelectUniqueSQL in interface DatabaseEntryUtils

getPreparedUpdateSQL

public <T extends DatabaseEntry> String getPreparedUpdateSQL(AbstractDBTable<? extends T> table)

Specified by:

getPreparedUpdateSQL in interface DatabaseEntryUtils

getUniqueKeys

public <T extends DatabaseEntry>
Pair<String[][],boolean[][]> getUniqueKeys(SQLQueryable<? extends T> table,
 T data)

Specified by:

getUniqueKeys in interface DatabaseEntryUtils

getUniqueValues

public <T extends DatabaseEntry>
Map<String,Pair<Object,Boolean>>[] getUniqueValues(SQLQueryable<? extends T> table,
 T data)

Specified by:

getUniqueValues in interface DatabaseEntryUtils

getUpdateMethod

public <T extends DatabaseEntry> Method getUpdateMethod(Class<T> dataClazz)

loadTypes

public DatabaseEntryUtils loadTypes(ColumnTypeRegistry registry)

loadTypes

public DatabaseEntryUtils loadTypes(EncodingTypeRegistry registry)

prepareDeleteSQL

public <T extends DatabaseEntry> void prepareDeleteSQL(PreparedStatement stmt,
 AbstractDBTable<? extends T> table,
 T data)
                                                throws SQLException

Specified by:

prepareDeleteSQL in interface DatabaseEntryUtils

Throws:

SQLException

prepareInsertSQL

public <T extends DatabaseEntry> void prepareInsertSQL(PreparedStatement stmt,
 AbstractDBTable<? extends T> table,
 T data)
                                                throws SQLException

Specified by:

prepareInsertSQL in interface DatabaseEntryUtils

Throws:

SQLException

prepareSelectCountNotNullSQL

public <T extends DatabaseEntry> void prepareSelectCountNotNullSQL(PreparedStatement stmt,
 SQLQueryable<? extends T> table,
 String[] notNullKeys,
 T data)
                                                            throws SQLException

Specified by:

prepareSelectCountNotNullSQL in interface DatabaseEntryUtils

Throws:

SQLException

prepareSelectCountUniqueSQL

public <T extends DatabaseEntry> void prepareSelectCountUniqueSQL(PreparedStatement stmt,
 SQLQueryable<? extends T> table,
 String[][] uniqueKeys,
 boolean[][] nullable,
 T data)
                                                           throws SQLException

Specified by:

prepareSelectCountUniqueSQL in interface DatabaseEntryUtils

Throws:

SQLException

prepareSelectSQL

public <T extends DatabaseEntry> void prepareSelectSQL(PreparedStatement stmt,
 SQLQueryable<? extends T> table,
 T data)
                                                throws SQLException

Specified by:

prepareSelectSQL in interface DatabaseEntryUtils

Throws:

SQLException

prepareSelectUniqueSQL

public <T extends DatabaseEntry> void prepareSelectUniqueSQL(PreparedStatement stmt,
 SQLQueryable<? extends T> table,
 String[][] uniqueKeys,
 boolean[][] nullable,
 T data)
                                                      throws SQLException

Specified by:

prepareSelectUniqueSQL in interface DatabaseEntryUtils

Throws:

SQLException

prepareUpdateSQL

public <T extends DatabaseEntry> void prepareUpdateSQL(PreparedStatement stmt,
 AbstractDBTable<? extends T> table,
 T data)
                                                throws SQLException

Specified by:

prepareUpdateSQL in interface DatabaseEntryUtils

Throws:

SQLException

resolveSQLQualifiers

public <T extends DatabaseEntry> String resolveSQLQualifiers(SQLQueryable<? extends T> table,
 String input,
 Map<String,String> data,
 Function<String,Optional<String>> func)

Specified by:

resolveSQLQualifiers in interface DatabaseEntryUtils

sortFields

public List<Field> sortFields(Field[] fields)

computeFactoryMethod

protected Method computeFactoryMethod(Class<?> clazz)

getNonNullColumns

public <T extends DatabaseEntry> ColumnData[] getNonNullColumns(SQLQueryable<? extends T> table)

NOT OnUpdate, NOT PK, NOT Generated

getPreparedDeleteSql

public <T extends DatabaseEntry> String getPreparedDeleteSql(AbstractDBTable<? extends T> table)

getPrimaryKeys

public <T extends DatabaseEntry> ColumnData[] getPrimaryKeys(SQLQueryable<? extends T> table)

Specified by:

getPrimaryKeys in interface DatabaseEntryUtils

getPrimaryKeyValues

public <T extends DatabaseEntry> Object[] getPrimaryKeyValues(SQLQueryable<? extends T> table,
 T data)

Specified by:

getPrimaryKeyValues in interface DatabaseEntryUtils

getUpdateColumnsNames

public <T extends DatabaseEntry> String[] getUpdateColumnsNames(AbstractDBTable<? extends T> table)

Specified by:

getUpdateColumnsNames in interface DatabaseEntryUtils

getUpdateColumnsExpr

public <T extends DatabaseEntry> String[] getUpdateColumnsExpr(AbstractDBTable<? extends T> table)

Specified by:

getUpdateColumnsExpr in interface DatabaseEntryUtils

getUpdateGeneratedColumns

@Deprecated
public <T extends DatabaseEntry> ColumnData[] getUpdateGeneratedColumns(AbstractDBTable<? extends T> table)

Deprecated.

Specified by:

getUpdateGeneratedColumns in interface DatabaseEntryUtils

getUpdateGeneratedColumnsNames

@Deprecated
public <T extends DatabaseEntry> String[] getUpdateGeneratedColumnsNames(AbstractDBTable<? extends T> table)

Deprecated.

Specified by:

getUpdateGeneratedColumnsNames in interface DatabaseEntryUtils

getInsertColumns

public <T extends DatabaseEntry> ColumnData[] getInsertColumns(AbstractDBTable<? extends T> table)

getUpdateColumns

public <T extends DatabaseEntry> ColumnData[] getUpdateColumns(AbstractDBTable<? extends T> table)

getTruncateSQL

public <T extends DatabaseEntry> String getTruncateSQL(AbstractDBTable<? extends T> table)

Specified by:

getTruncateSQL in interface DatabaseEntryUtils

toMap

public Map<String,Object> toMap()

Specified by:

toMap in interface MapConvertible