io.github.mmm.orm.spi.access.AbstractDbAccess Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mmm-orm-spi Show documentation
Show all versions of mmm-orm-spi Show documentation
Service Provider API (SPI) for mmm-orm.
package io.github.mmm.orm.spi.access;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Objects;
import java.util.function.Consumer;
import io.github.mmm.entity.bean.EntityBean;
import io.github.mmm.entity.id.Id;
import io.github.mmm.entity.id.sequence.IdSequence;
import io.github.mmm.orm.dialect.AbstractDbDialect;
import io.github.mmm.orm.dialect.DbDialect;
import io.github.mmm.orm.mapping.DbMapper;
import io.github.mmm.orm.mapping.DbMapper2Java;
import io.github.mmm.orm.mapping.Orm;
import io.github.mmm.orm.metadata.DbQualifiedName;
import io.github.mmm.orm.param.AbstractCriteriaParameters;
import io.github.mmm.orm.result.DbResult;
import io.github.mmm.orm.spi.access.impl.DbMapperRetrievalAdapter;
import io.github.mmm.orm.spi.session.DbEntitySession;
import io.github.mmm.orm.spi.session.DbSession;
import io.github.mmm.orm.statement.BasicDbStatementFormatter;
import io.github.mmm.orm.statement.DbStatement;
import io.github.mmm.orm.statement.create.CreateIndexStatement;
import io.github.mmm.orm.statement.create.CreateSequenceStatement;
import io.github.mmm.orm.statement.create.CreateTableStatement;
import io.github.mmm.orm.statement.delete.DeleteClause;
import io.github.mmm.orm.statement.delete.DeleteStatement;
import io.github.mmm.orm.statement.insert.InsertStatement;
import io.github.mmm.orm.statement.merge.MergeStatement;
import io.github.mmm.orm.statement.select.SelectClause;
import io.github.mmm.orm.statement.select.SelectStatement;
import io.github.mmm.orm.statement.update.UpdateStatement;
import io.github.mmm.orm.statement.upsert.UpsertStatement;
/**
* Abstract base implementation of {@link DbAccess}.
*
* @since 1.0.0
*/
public abstract class AbstractDbAccess implements DbAccess {
/**
* @return the current {@link DbSession}.
*/
protected abstract DbSession getSession();
/**
* @return the {@link DbDialect}.
*/
protected AbstractDbDialect getDialect() {
return (AbstractDbDialect) getSession().getConnectionData().getDialect();
}
/**
* Generic method to execute a {@link DbStatement}. Convenient for statements that do not return a {@link DbResult
* result}. Otherwise use {@link #executeStatement(DbStatement, Consumer, boolean)}.
*
* @param statement the {@link DbStatement} to execute.
* @return the number of rows that have been updated or selected.
* @see #executeStatement(DbStatement, Consumer, boolean)
*/
protected long executeStatement(DbStatement statement) {
return executeStatement(statement, null, true);
}
/**
* Generic method to execute a {@link DbStatement}.
*
* @param statement the {@link DbStatement} to execute.
* @param receiver the {@link Consumer} of a potential {@link DbResult} (e.g. for SELECT) or {@code null} if no result
* is expected (e.g. for INSERT or DELETE).
* @param unique {@code true} if a unique {@link DbResult} is expected and an
* {@link io.github.mmm.orm.statement.NonUniqueResultException} should be thrown if multiple results have been
* received.
* @return the number of rows that have been updated or selected.
* @see #executeStatement(DbStatement)
* @see #executeSql(String, AbstractCriteriaParameters, Consumer, boolean)
*/
protected long executeStatement(DbStatement statement, Consumer receiver, boolean unique) {
BasicDbStatementFormatter formatter = getDialect().createFormatter();
String sql = formatter.formatStatement(statement).toString();
AbstractCriteriaParameters parameters = (AbstractCriteriaParameters) formatter.getCriteriaFormatter()
.getParameters();
if (statement.getType().isQuery()) {
Objects.requireNonNull(receiver);
}
return executeSql(sql, parameters, receiver, unique);
}
/**
* Low-level and DB/orm specific method method to execute a query.
*
* @param sql the DB statement as {@link String}. Typically SQL but may be any statement syntax also for NO-SQL
* solutions.
* @param parameters the {@link AbstractCriteriaParameters dynamic parameters} to bind to the given DB statement
* ({@code sql}).
* @param receiver the {@link Consumer} of a potential {@link DbResult} (e.g. for SELECT) or {@code null} if no result
* is expected (e.g. for INSERT or DELETE).
* @param unique {@code true} if a unique {@link DbResult} is expected and an
* {@link io.github.mmm.orm.statement.NonUniqueResultException} should be thrown if multiple results have been
* received.
* @return the number of rows that have been updated or selected.
*/
protected abstract long executeSql(String sql, AbstractCriteriaParameters parameters, Consumer receiver,
boolean unique);
@Override
public void createTable(CreateTableStatement statement) {
executeStatement(statement);
}
@Override
public void createIndex(CreateIndexStatement statement) {
executeStatement(statement);
}
@Override
public void createSequence(CreateSequenceStatement statement) {
executeStatement(statement);
}
@Override
public long delete(DeleteStatement statement) {
return executeStatement(statement);
}
@Override
public boolean deleteById(Id id, E prototype) {
if ((id == null) || (id.getPk() == null)) {
return false;
}
DeleteStatement statement = new DeleteClause().from(prototype).where(prototype.Id().eq(id)).get();
long count = delete(statement);
if (count > 0) {
assert (count == 1);
return true;
} else {
assert (count == 0);
return false;
}
}
@SuppressWarnings("unchecked")
@Override
public int deleteAllById(Iterable> ids, E prototype) {
if (ids == null) {
return 0;
}
Collection> idCollection;
if (ids instanceof Collection c) {
idCollection = c;
} else {
idCollection = new ArrayList<>();
for (Id id : ids) {
idCollection.add(id);
}
}
if (idCollection.isEmpty()) {
return 0;
}
DeleteStatement statement = new DeleteClause().from(prototype).where(prototype.Id().in(idCollection)).get();
long count = executeStatement(statement);
assert (count >= 0) && (count < Integer.MAX_VALUE);
return (int) count;
}
@Override
public long insert(InsertStatement statement) {
return executeStatement(statement);
}
@Override
public long execute(MergeStatement statement) {
return executeStatement(statement);
}
@Override
public long update(UpdateStatement statement) {
return executeStatement(statement);
}
@Override
public long execute(UpsertStatement statement) {
return executeStatement(statement);
}
@SuppressWarnings({ "rawtypes", "unchecked" })
@Override
public Iterable select(SelectStatement statement) {
Orm orm = getDialect().getOrm();
SelectClause select = statement.getSelect();
DbMapper2Java mapper = orm.createMapper(select);
if (select.isSelectEntity()) {
DbEntitySession dbEntitySession = getSession().get((EntityBean) select.getResultBean());
mapper = new DbMapperRetrievalAdapter(mapper, dbEntitySession);
}
DbResultReceiverMultiple receiver = new DbResultReceiverMultiple<>(mapper);
executeStatement(statement, receiver, false);
return receiver.getResults();
}
@Override
public R selectOne(SelectStatement statement) {
Orm orm = getDialect().getOrm();
SelectClause select = statement.getSelect();
DbMapper mapper = orm.createMapper(select);
DbResultReceiverSingle receiver = new DbResultReceiverSingle<>(mapper);
executeStatement(statement, receiver, true);
return receiver.getResult();
}
/**
* @param sequenceName the {@link DbQualifiedName} of the database sequence.
* @return the {@link IdSequence} implementation.
*/
public abstract IdSequence createIdSequence(DbQualifiedName sequenceName);
}