/*
* 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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq.impl;
import java.util.List;
import org.jooq.Cursor;
import org.jooq.ForeignKey;
import org.jooq.Identity;
import org.jooq.Record;
import org.jooq.Result;
import org.jooq.ResultQuery;
import org.jooq.Schema;
import org.jooq.Table;
import org.jooq.TableRecord;
import org.jooq.UniqueKey;
/**
* A base class for custom {@link Table} implementations in client code.
* <p>
* Client code may provide proper {@link Table} implementations extending this
* useful base class. All necessary parts of the {@link Table} interface are
* already implemented. Only this method needs further implementation:
* <ul>
* <li>{@link #getRecordType()}</li>
* </ul>
* Refer to this method's Javadoc for further details about its expected
* behaviour.
* <p>
* Use this base class when providing custom tables to any of the following
* methods:
* <ul>
* <li>{@link ResultQuery#fetchInto(Table)}</li>
* <li>{@link Cursor#fetchInto(Table)}</li>
* <li>{@link Result#into(Table)}</li>
* <li>{@link Record#into(Table)}</li>
* </ul>
*
* @author Lukas Eder
*/
public abstract class CustomTable<R extends TableRecord<R>> extends TableImpl<R> {
/**
* Generated UID
*/
private static final long serialVersionUID = 4300737872863697213L;
protected CustomTable(String name) {
super(name);
}
protected CustomTable(String name, Schema schema) {
super(name, schema);
}
// -------------------------------------------------------------------------
// Implementation required
// -------------------------------------------------------------------------
/**
* Subclasses must implement this method
* <hr/>
* {@inheritDoc}
*/
@Override
public abstract Class<? extends R> getRecordType();
// -------------------------------------------------------------------------
// Further overrides allowed
// -------------------------------------------------------------------------
@Override
public Identity<R, ?> getIdentity() {
return super.getIdentity();
}
@Override
public UniqueKey<R> getPrimaryKey() {
return super.getPrimaryKey();
}
@Override
public List<UniqueKey<R>> getKeys() {
return super.getKeys();
}
@Override
public List<ForeignKey<R, ?>> getReferences() {
return super.getReferences();
}
// -------------------------------------------------------------------------
// No further overrides allowed
// -------------------------------------------------------------------------
@Override
public final boolean declaresFields() {
return super.declaresFields();
}
@Override
public final boolean declaresTables() {
return super.declaresTables();
}
}