/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq.impl;
import static java.util.Arrays.asList;
import static java.util.Collections.singletonList;
import static org.jooq.impl.DSL.row;
import static org.jooq.impl.DSL.using;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.jooq.Condition;
import org.jooq.Configuration;
import org.jooq.DAO;
import org.jooq.Field;
import org.jooq.Record;
import org.jooq.RecordMapper;
import org.jooq.SQLDialect;
import org.jooq.Table;
import org.jooq.TableField;
import org.jooq.UniqueKey;
import org.jooq.UpdatableRecord;
import org.jooq.conf.Settings;
/**
* A common base implementation for generated DAO's.
*
* @author Lukas Eder
*/
public abstract class DAOImpl<R extends UpdatableRecord<R>, P, T> implements DAO<R, P, T> {
private final Table<R> table;
private final Class<P> type;
private RecordMapper<R, P> mapper;
private Configuration configuration;
// -------------------------------------------------------------------------
// XXX: Constructors and initialisation
// -------------------------------------------------------------------------
protected DAOImpl(Table<R> table, Class<P> type) {
this(table, type, null);
}
protected DAOImpl(Table<R> table, Class<P> type, Configuration configuration) {
this.table = table;
this.type = type;
setConfiguration(configuration);
}
/**
* Inject a configuration.
* <p>
* This method is maintained to be able to configure a <code>DAO</code>
* using Spring. It is not exposed in the public API.
*/
public final void setConfiguration(Configuration configuration) {
this.configuration = configuration;
this.mapper = Utils.configuration(configuration).recordMapperProvider().provide(table.recordType(), type);
}
@Override
public final Configuration configuration() {
return configuration;
}
@Override
public final Settings settings() {
return Utils.settings(configuration());
}
@Override
public final SQLDialect dialect() {
return Utils.configuration(configuration()).dialect();
}
@Override
public final SQLDialect family() {
return dialect().family();
}
/**
* {@inheritDoc}
* <p>
* Subclasses may override this method to provide custom implementations.
*/
@Override
public /* non-final */ RecordMapper<R, P> mapper() {
return mapper;
}
// -------------------------------------------------------------------------
// XXX: DAO API
// -------------------------------------------------------------------------
@Override
public final void insert(P object) {
insert(singletonList(object));
}
@Override
public final void insert(P... objects) {
insert(asList(objects));
}
@Override
public final void insert(Collection<P> objects) {
// Execute a batch INSERT
if (objects.size() > 1) {
using(configuration).batchInsert(records(objects, false)).execute();
}
// Execute a regular INSERT
else if (objects.size() == 1) {
records(objects, false).get(0).insert();
}
}
@Override
public final void update(P object) {
update(singletonList(object));
}
@Override
public final void update(P... objects) {
update(asList(objects));
}
@Override
public final void update(Collection<P> objects) {
// Execute a batch UPDATE
if (objects.size() > 1) {
using(configuration).batchUpdate(records(objects, true)).execute();
}
// Execute a regular UPDATE
else if (objects.size() == 1) {
records(objects, true).get(0).update();
}
}
@Override
public final void delete(P... objects) {
delete(asList(objects));
}
@Override
public final void delete(Collection<P> objects) {
List<T> ids = new ArrayList<T>();
for (P object : objects) {
ids.add(getId(object));
}
deleteById(ids);
}
@Override
public final void deleteById(T... ids) {
deleteById(asList(ids));
}
@Override
public final void deleteById(Collection<T> ids) {
Field<?>[] pk = pk();
if (pk != null) {
using(configuration).delete(table).where(equal(pk, ids)).execute();
}
}
@Override
public final boolean exists(P object) {
return existsById(getId(object));
}
@Override
public final boolean existsById(T id) {
Field<?>[] pk = pk();
if (pk != null) {
return using(configuration)
.selectCount()
.from(table)
.where(equal(pk, id))
.fetchOne(0, Integer.class) > 0;
}
else {
return false;
}
}
@Override
public final long count() {
return using(configuration)
.selectCount()
.from(table)
.fetchOne(0, Long.class);
}
@Override
public final List<P> findAll() {
return using(configuration)
.selectFrom(table)
.fetch()
.map(mapper());
}
@Override
public final P findById(T id) {
Field<?>[] pk = pk();
R record = null;
if (pk != null) {
record = using(configuration)
.selectFrom(table)
.where(equal(pk, id))
.fetchOne();
}
return mapper().map(record);
}
@Override
public final <Z> List<P> fetch(Field<Z> field, Z... values) {
return using(configuration)
.selectFrom(table)
.where(field.in(values))
.fetch()
.map(mapper());
}
@Override
public final <Z> P fetchOne(Field<Z> field, Z value) {
R record = using(configuration)
.selectFrom(table)
.where(field.equal(value))
.fetchOne();
return mapper().map(record);
}
@Override
public final Table<R> getTable() {
return table;
}
@Override
public final Class<P> getType() {
return type;
}
// ------------------------------------------------------------------------
// XXX: Template methods for generated subclasses
// ------------------------------------------------------------------------
protected abstract T getId(P object);
@SuppressWarnings("unchecked")
protected final T compositeKeyRecord(Object... values) {
UniqueKey<R> key = table.getPrimaryKey();
if (key == null)
return null;
TableField<R, Object>[] fields = (TableField<R, Object>[]) key.getFieldsArray();
Record result = DSL.using(configuration)
.newRecord(fields);
for (int i = 0; i < values.length; i++) {
result.setValue(fields[i], fields[i].getDataType().convert(values[i]));
}
return (T) result;
}
// ------------------------------------------------------------------------
// XXX: Private utility methods
// ------------------------------------------------------------------------
@SuppressWarnings("unchecked")
private final Condition equal(Field<?>[] pk, T id) {
if (pk.length == 1) {
return ((Field<Object>) pk[0]).equal(pk[0].getDataType().convert(id));
}
// [#2573] Composite key T types are of type Record[N]
else {
return row(pk).equal((Record) id);
}
}
@SuppressWarnings("unchecked")
private final Condition equal(Field<?>[] pk, Collection<T> ids) {
if (pk.length == 1) {
if (ids.size() == 1) {
return equal(pk, ids.iterator().next());
}
else {
return ((Field<Object>) pk[0]).in(pk[0].getDataType().convert(ids));
}
}
// [#2573] Composite key T types are of type Record[N]
else {
return row(pk).in(ids.toArray(new Record[ids.size()]));
}
}
private final Field<?>[] pk() {
UniqueKey<?> key = table.getPrimaryKey();
return key == null ? null : key.getFieldsArray();
}
private final List<R> records(Collection<P> objects, boolean forUpdate) {
List<R> result = new ArrayList<R>();
Field<?>[] pk = pk();
for (P object : objects) {
R record = using(configuration).newRecord(table, object);
if (forUpdate && pk != null)
for (Field<?> field : pk)
record.changed(field, false);
Utils.resetChangedOnNotNull(record);
result.add(record);
}
return result;
}
}