stormify/onl.ycode.stormify/StormifyJ

StormifyJ

class StormifyJ(dataSource: DataSource, registrars: EntityRegistrar)

Entry point for Stormify from Java code. Provides CRUD operations, raw SQL queries, stored procedure calls, and transaction management against a javax.sql.DataSource.

StormifyJ stormify = new StormifyJ(hikariDataSource);
stormify.asDefault();
User u = stormify.findById(User.class, 1);

From Kotlin code, use Stormify directly.

Constructors

StormifyJ

constructor(dataSource: DataSource, vararg registrars: EntityRegistrar)

constructor(jdbcDataSource: DataSource, vararg registrars: EntityRegistrar)

Convenience constructor that accepts any javax.sql.DataSource (HikariCP, plain JDBC driver, etc.).

constructor(dataSource: DataSource)

Single-argument convenience constructor. Exists primarily so Spring XML <constructor-arg ref="dataSource"/> (and similar DI containers that resolve constructors by arity) can pick an unambiguous one-arg match.

constructor(jdbcDataSource: DataSource)

Single-argument javax.sql.DataSource overload — see the primary one-arg constructor for the rationale.

Types

Companion

object Companion

Accessors for the library-wide default StormifyJ wrapper.

Properties

logger

var logger: Logger

The logger used by the underlying Stormify instance.

namingPolicy

var namingPolicy: (String) -> String

Current NamingPolicy. See Stormify.namingPolicy.

sqlDialect

val sqlDialect: SqlDialect

The auto-detected SQL dialect for this data source. See Stormify.sqlDialect.

unmatchedColumnPolicy

var unmatchedColumnPolicy: UnmatchedColumnPolicy

Policy for unmatched result-set columns. See Stormify.unmatchedColumnPolicy.

Functions

addBlacklistField

fun addBlacklistField(name: String)

See Stormify.addBlacklistField.

asDefault

fun asDefault(): StormifyJ

Registers the underlying Stormify instance as the library-wide default and caches this wrapper in StormifyJ.getDefault, so Java callers can retrieve the Java-friendly wrapper (not just the raw Stormify) via a single static call. Returns this wrapper for fluent chaining.

fun asDefault(block: Consumer<StormifyJ>)

Runs block with this wrapper as the default, restoring the previous default when the block exits. Use for scoped overrides such as per-request tenants.

fun <R> asDefault(block: Function<StormifyJ, R>): R

Returning variant of asDefault — see the Consumer overload for semantics.

attach

fun <T : StormifyAware> attach(target: T): T

Attaches the underlying Stormify instance to target so the target can use it for database operations without receiving it as an explicit parameter.

create

fun <T : Any> create(item: T): T

Inserts item into its mapped table and returns the (possibly key-populated) entity.

fun <T : Any> create(items: Collection<T>): List<T>

Batch INSERT of items in a single round trip.

delete

fun delete(deletedItem: Any)

DELETE's the row corresponding to deletedItem using its primary key.

fun <T : Any> delete(items: Collection<T>)

Batch DELETE of items.

executeUpdate

fun executeUpdate(query: String, vararg params: Any?): Int

Executes an INSERT / UPDATE / DELETE and returns the affected row count.

findAll

@JvmOverloads

fun <T : Any> findAll(baseClass: Class<T>, whereClause: String = "", vararg arguments: Any?): List<T>

Convenience over read for SELECT * FROM <table> <whereClause>.

findById

fun <T : Any> findById(baseClass: Class<T>, id: Any): T?

Looks up a single row of baseClass by its primary key id. Returns null if not found.

getDetails

@JvmOverloads

fun <M : Any, T : Any> getDetails(parent: M, detailsClass: Class<T>, propertyName: String? = null): List<T>

Returns the detail rows of type detailsClass that reference parent. Use propertyName to disambiguate when the detail class has multiple foreign keys pointing at the same parent type.

fun <M : Any, T : Any> getDetails(parent: M, detailsClass: Class<T>, referenceField: ReferencePath): List<T>

Type-safe variant of getDetails that accepts an annotation-processor-generated reference path (e.g. Paths.AuditEntry_.createdBy()) instead of a string. The compiler guarantees the referenced property exists on the child type, so typos and renames surface at build time rather than on first query.

getTableInfo

fun getTableInfo(baseClass: Class<*>): TableInfo<Any?>

Returns the TableInfo metadata for baseClass, building it on first access.

populate

fun <T : Any> populate(entity: T): T

Populates entity from the database by its primary key. Used internally by AutoTable.

procedure

fun procedure(name: String, vararg args: Any?)

Invokes the stored procedure name with args. Output and bidirectional parameters should be passed as Sp.Out / Sp.InOut instances; all other values are auto-wrapped as IN.

read

fun <T : Any> read(baseClass: Class<T>, query: String, vararg params: Any?): List<T>

Executes a SELECT and returns the rows as a list of baseClass instances.

fun <T : Any> read(baseClass: Class<T>, query: String, customFields: Map<String, Consumer<Any?>>, vararg params: Any?): List<T>

Executes a SELECT and returns the rows, capturing values from columns named in customFields (e.g. COUNT(*) OVER () AS __total) via the supplied consumers — those columns are not mapped onto the entity. Column names are matched case-insensitively.

readCursor

fun <T : Any> readCursor(baseClass: Class<T>, query: String, consumer: Consumer<T>, vararg params: Any?): Int

Executes a SELECT and streams each row to consumer — avoids materializing the full result.

fun <T : Any> readCursor(baseClass: Class<T>, query: String, customFields: Map<String, Consumer<Any?>>, consumer: Consumer<T>, vararg params: Any?): Int

Streaming variant that captures values from columns named in customFields via the supplied consumers instead of mapping them onto the entity. See the list-returning read overload for the capture semantics.

readOne

fun <T : Any> readOne(baseClass: Class<T>, query: String, vararg params: Any?): T?

Executes a SELECT and returns the first row as a baseClass instance, or null if empty.

registerPrimaryKeyResolver

fun registerPrimaryKeyResolver(priority: Int, resolver: (String, String) -> Boolean)

See Stormify.registerPrimaryKeyResolver.

removeBlacklistField

fun removeBlacklistField(name: String)

See Stormify.removeBlacklistField.

transaction

fun transaction(block: Runnable)

Runs block inside a database transaction. Commits on return, rolls back on any thrown exception. Inside the block, all CRUD/query calls on this wrapper (e.g. stormify.create(user)) transparently run on the transaction's connection via the ambient transaction registry. Nested calls to this method become savepoints automatically.

fun <R> transaction(block: Supplier<R>): R

Returning variant of transaction — see that method for lifecycle semantics.

update

fun <T : Any> update(updatedItem: T): T

UPDATE's the row corresponding to updatedItem using its primary key.

fun <T : Any> update(items: Collection<T>): List<T>

Batch UPDATE of items.