Package lu.kbra.pclib.db.utils.impl

Interface DatabaseEntryUtils

All Superinterfaces:

DatabaseEntryUtilsOptionsOwner

All Known Subinterfaces:

ProxyDatabaseEntryUtils

All Known Implementing Classes:

BaseDatabaseEntryUtils, BaseProxyDatabaseEntryUtils

public interface DatabaseEntryUtils
extends DatabaseEntryUtilsOptionsOwner

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DBMS_FILTER_ALL
static final Object[]	EMPTY_ARRAY
static final Map<?,?>	EMPTY_MAP
static final Optional<?>	EMPTY_OPTIONAL
static final Set<?>	EMPTY_SET
static final String	FIELD_NAME_KEY
static final String	FUNCTION_KEY
static final String	MEMBER_KEY	for fields {M:...} or {M:...:...}
static final String	PARAMETER_COLUMN_KEY
static final String	PARAMETER_VALUE_KEY
static final String	PROPERTY_ENVIRONMENT_KEY
static final String	PROPERTY_KEY
static final String	PROPERTY_PROP_KEY
static final String	PROPERTY_QUERYABLE_KEY
static final String	QUALIFIER_KEY
static final String	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

Method Summary

Modifier and Type	Method	Description
void	appendTypes(ColumnTypeRegistry addColumnTypeRegistry)
void	appendTypes(EncodingTypeRegistry encodingTypeRegistry)
<T extends DatabaseEntry> BitSet	computeInsertColumnMask(AbstractDBTable<? extends T> table, T data)
default String	fieldToColumnName(Field field)
default String	fieldToColumnName(String name)
<T extends DatabaseEntry> void	fillInsert(AbstractDBTable<? extends T> table, T data, ResultSet rs)	Only reload generated keys
<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 result, Consumer<T> listExporter)
ColumnData	getColumnFor(SQLQueryableStructure structure, String name)
default <T extends DatabaseEntry> ColumnData	getColumnFor(SQLQueryable<? extends T> table, String name)
ColumnData	getColumnForField(SQLQueryableStructure structure, String fieldName)
default ColumnData	getColumnForField(SQLQueryable<?> table, String fieldName)
SQLColumnTypeProvider	getColumnTypeProvider()
String	getDbmsQualifierName()
SQLEncodingTypeProvider	getEncodingTypeProvider()
EntryInstanceProvider	getEntryInstanceProvider()
default String[]	getForeignKeyNames(SQLQueryableStructure structure)
default <T extends DatabaseEntry> String[]	getForeignKeyNames(SQLQueryable<? extends T> table)
default ColumnData[]	getForeignKeys(SQLQueryableStructure structure)
default <T extends DatabaseEntry> ColumnData[]	getForeignKeys(SQLQueryable<? extends T> table)
SQLFunctionResolver	getFunctionResolver()
HintScanner	getHintScanner()
<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> data)
<T extends DatabaseEntry> Method	getLoadMethod(Class<T> data)
<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> queryable, int size)
<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> queryable, int count)
<T extends DatabaseEntry> String	getPreparedSelectCountNotNullSQL(SQLQueryable<? extends T> instance, String[] notNullKeys)
<T extends DatabaseEntry> String	getPreparedSelectCountUniqueSQL(SQLQueryable<? extends T> instance, String[][] uniqueKeys)
<T extends DatabaseEntry> String	getPreparedSelectSQL(SQLQueryable<? extends T> table)
<T extends DatabaseEntry> String	getPreparedSelectUniqueSQL(SQLQueryable<? extends T> instance, String[][] uniqueKeys)
<T extends DatabaseEntry> String	getPreparedUpdateSQL(AbstractDBTable<? extends T> table)
default String[]	getPrimaryKeyNames(SQLQueryableStructure structure)
default <T extends DatabaseEntry> String[]	getPrimaryKeyNames(SQLQueryable<? extends T> table)
default ColumnData[]	getPrimaryKeys(SQLQueryableStructure structure)
default <T extends DatabaseEntry> ColumnData[]	getPrimaryKeys(SQLQueryable<? extends T> table)
<T extends DatabaseEntry> Object[]	getPrimaryKeyValues(SQLQueryable<? extends T> queryable, T data)
SQLQueryableHookManager	getQueryableHookManager()
SQLStructureVisitor	getStructureVisitor()
<T extends DatabaseEntry> String	getTruncateSQL(AbstractDBTable<? extends T> queryable)
default ColumnType<?,?>	getTypeFor(AnnotatedType parameter)
<T extends DatabaseEntry> String[][]	getUniqueKeys(SQLQueryable<? extends T> table, T data)
<T extends DatabaseEntry> Map<String,Object>[]	getUniqueValues(SQLQueryable<? extends T> table, T data)
<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.
default boolean	matchesDbmsQualifier(String dbms)
default String	parameterToColumnName(Parameter p)
<T extends DatabaseEntry> void	prepareDeleteSQL(PreparedStatement stmt, AbstractDBTable<? extends T> instance, T data)
<T extends DatabaseEntry> void	prepareInsertSQL(PreparedStatement stmt, AbstractDBTable<? extends T> instance, T data)
<T extends DatabaseEntry> void	prepareSelectCountNotNullSQL(PreparedStatement stmt, SQLQueryable<? extends T> instance, String[] notNullKeys, T data)
<T extends DatabaseEntry> void	prepareSelectCountUniqueSQL(PreparedStatement stmt, SQLQueryable<? extends T> instance, String[][] uniqueKeys, T data)
<T extends DatabaseEntry> void	prepareSelectSQL(PreparedStatement stmt, SQLQueryable<? extends T> instance, T data)
<T extends DatabaseEntry> void	prepareSelectUniqueSQL(PreparedStatement stmt, SQLQueryable<? extends T> instance, String[][] uniqueKeys, T data)
<T extends DatabaseEntry> void	prepareUpdateSQL(PreparedStatement stmt, AbstractDBTable<? extends T> instance, T data)
default <T extends DatabaseEntry> String	resolveSQLQualifiers(SQLQueryable<? extends T> table, String value)
default <T extends DatabaseEntry> String	resolveSQLQualifiers(SQLQueryable<? extends T> table, String input, Map<String,String> data)
<T extends DatabaseEntry> String	resolveSQLQualifiers(SQLQueryable<? extends T> table, String input, Map<String,String> data, Function<String,Optional<String>> func)
void	setColumnTypeProvider(SQLColumnTypeProvider columnTypeProvider)
void	setEntryInstanceProvider(EntryInstanceProvider entryInstanceProvider)
void	setFunctionResolver(SQLFunctionResolver functionResolver)
void	setHintScanner(HintScanner hintScanner)
void	setQueryableHookManager(SQLQueryableHookManager queryableHookManager)
void	setStructureVisitor(SQLStructureVisitor structureVisitor)

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

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

Field Details

TABLE_NAME_KEY

static final String TABLE_NAME_KEY

See Also:

• Constant Field Values

FIELD_NAME_KEY

static final String FIELD_NAME_KEY

See Also:

• Constant Field Values

QUALIFIER_KEY

static final String QUALIFIER_KEY

See Also:

• Constant Field Values

FUNCTION_KEY

static final String FUNCTION_KEY

See Also:

• Constant Field Values

PARAMETER_COLUMN_KEY

static final String PARAMETER_COLUMN_KEY

See Also:

• Constant Field Values

PARAMETER_VALUE_KEY

static final String PARAMETER_VALUE_KEY

See Also:

• Constant Field Values

PROPERTY_KEY

static final String PROPERTY_KEY

See Also:

• Constant Field Values

PROPERTY_ENVIRONMENT_KEY

static final String PROPERTY_ENVIRONMENT_KEY

See Also:

• Constant Field Values

PROPERTY_PROP_KEY

static final String PROPERTY_PROP_KEY

See Also:

• Constant Field Values

PROPERTY_QUERYABLE_KEY

static final String PROPERTY_QUERYABLE_KEY

See Also:

• Constant Field Values

MEMBER_KEY

static final String MEMBER_KEY

for fields {M:...} or {M:...:...}

See Also:

• Constant Field Values

DBMS_FILTER_ALL

static final String DBMS_FILTER_ALL

See Also:

• Constant Field Values

EMPTY_SET

static final Set<?> EMPTY_SET

EMPTY_ARRAY

static final Object[] EMPTY_ARRAY

EMPTY_OPTIONAL

static final Optional<?> EMPTY_OPTIONAL

EMPTY_MAP

static final Map<?,?> EMPTY_MAP

Method Details

fieldToColumnName

default String fieldToColumnName(Field field)

fieldToColumnName

default String fieldToColumnName(String name)

fillInsert

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

Only reload generated keys

Throws:

SQLException

fillLoad

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

Full reload

Throws:

SQLException

fillLoadAll

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

Throws:

SQLException

getColumnFor

default <T extends DatabaseEntry> ColumnData getColumnFor(SQLQueryable<? extends T> table,
 String name)

getColumnFor

ColumnData getColumnFor(SQLQueryableStructure structure,
 String name)

getColumnTypeProvider

SQLColumnTypeProvider getColumnTypeProvider()

getEncodingTypeProvider

SQLEncodingTypeProvider getEncodingTypeProvider()

getDbmsQualifierName

String getDbmsQualifierName()

getEntryInstanceProvider

EntryInstanceProvider getEntryInstanceProvider()

getFunctionResolver

SQLFunctionResolver getFunctionResolver()

getInsertGeneratedColumnNames

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

Deprecated.

getInsertGeneratedColumns

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

Deprecated.

getHintScanner

HintScanner getHintScanner()

getInsertMethod

<T extends DatabaseEntry> Method getInsertMethod(Class<T> data)

getLoadMethod

<T extends DatabaseEntry> Method getLoadMethod(Class<T> data)

getNonNullKeys

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

getNonNullValues

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

getPreparedDeleteSQL

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

getPreparedInsertSQL

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

getPreparedSelectCountNotNullSQL

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

getPreparedSelectCountUniqueSQL

<T extends DatabaseEntry> String getPreparedSelectCountUniqueSQL(SQLQueryable<? extends T> instance,
 String[][] uniqueKeys)

getPreparedSelectSQL

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

getPreparedSelectUniqueSQL

<T extends DatabaseEntry> String getPreparedSelectUniqueSQL(SQLQueryable<? extends T> instance,
 String[][] uniqueKeys)

getPreparedUpdateSQL

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

getPrimaryKeyNames

default String[] getPrimaryKeyNames(SQLQueryableStructure structure)

getPrimaryKeyNames

default <T extends DatabaseEntry> String[] getPrimaryKeyNames(SQLQueryable<? extends T> table)

getPrimaryKeys

default ColumnData[] getPrimaryKeys(SQLQueryableStructure structure)

getPrimaryKeys

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

getForeignKeyNames

default String[] getForeignKeyNames(SQLQueryableStructure structure)

getForeignKeyNames

default <T extends DatabaseEntry> String[] getForeignKeyNames(SQLQueryable<? extends T> table)

getForeignKeys

default ColumnData[] getForeignKeys(SQLQueryableStructure structure)

getForeignKeys

default <T extends DatabaseEntry> ColumnData[] getForeignKeys(SQLQueryable<? extends T> table)

getStructureVisitor

SQLStructureVisitor getStructureVisitor()

getTruncateSQL

<T extends DatabaseEntry> String getTruncateSQL(AbstractDBTable<? extends T> queryable)

getTypeFor

default ColumnType<?,?> getTypeFor(AnnotatedType parameter)

getUniqueKeys

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

getUniqueValues

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

getUpdateColumnsNames

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

matchesDbmsQualifier

default boolean matchesDbmsQualifier(String dbms)

parameterToColumnName

default String parameterToColumnName(Parameter p)

prepareDeleteSQL

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

Throws:

SQLException

prepareInsertSQL

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

Throws:

SQLException

prepareSelectCountNotNullSQL

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

Throws:

SQLException

prepareSelectCountUniqueSQL

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

Throws:

SQLException

prepareSelectSQL

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

Throws:

SQLException

prepareSelectUniqueSQL

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

Throws:

SQLException

prepareUpdateSQL

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

Throws:

SQLException

resolveSQLQualifiers

default <T extends DatabaseEntry> String resolveSQLQualifiers(SQLQueryable<? extends T> table,
 String value)

resolveSQLQualifiers

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

resolveSQLQualifiers

default <T extends DatabaseEntry> String resolveSQLQualifiers(SQLQueryable<? extends T> table,
 String input,
 Map<String,String> data)

setColumnTypeProvider

void setColumnTypeProvider(SQLColumnTypeProvider columnTypeProvider)

setEntryInstanceProvider

void setEntryInstanceProvider(EntryInstanceProvider entryInstanceProvider)

setFunctionResolver

void setFunctionResolver(SQLFunctionResolver functionResolver)

setHintScanner

void setHintScanner(HintScanner hintScanner)

setStructureVisitor

void setStructureVisitor(SQLStructureVisitor structureVisitor)

appendTypes

void appendTypes(ColumnTypeRegistry addColumnTypeRegistry)

appendTypes

void appendTypes(EncodingTypeRegistry encodingTypeRegistry)

getColumnForField

default ColumnData getColumnForField(SQLQueryable<?> table,
 String fieldName)

getColumnForField

ColumnData getColumnForField(SQLQueryableStructure structure,
 String fieldName)

getUpdateGeneratedColumns

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

Deprecated.

getUpdateGeneratedColumnsNames

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

Deprecated.

getQueryableHookManager

SQLQueryableHookManager getQueryableHookManager()

setQueryableHookManager

void setQueryableHookManager(SQLQueryableHookManager queryableHookManager)

getUpdateColumnsExpr

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

computeInsertColumnMask

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

getPreparedSelectAllSQL

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

getPreparedDeleteAllSQL

<T extends DatabaseEntry> String getPreparedDeleteAllSQL(AbstractDBTable<? extends T> queryable,
 int size)

getPrimaryKeyValues

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