All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jooq.meta.AbstractTableDefinition Maven / Gradle / Ivy

There is a newer version: 3.19.16
Show newest version
/*
 * 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
 *
 *  https://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
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package org.jooq.meta;

import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.jooq.Record;
import org.jooq.Table;
import org.jooq.TableOptions;
import org.jooq.TableOptions.TableType;
import org.jooq.impl.DSL;
import org.jooq.impl.TableImpl;

/**
 * A base implementation for table definitions.
 *
 * @author Lukas Eder
 */
public abstract class AbstractTableDefinition
extends
    AbstractElementContainerDefinition
implements
    TableDefinition
{

    private List   parameters;
    private TableDefinition             parentTable;
    private final List childTables;
    private final TableType             tableType;
    private final SchemaDefinition      referencedSchema;
    private final String                referencedName;
    private TableDefinition             referencedTable;

    public AbstractTableDefinition(SchemaDefinition schema, String name, String comment) {
        this(schema, name, comment, TableType.TABLE, null);
    }

    public AbstractTableDefinition(SchemaDefinition schema, String name, String comment, TableType tableType, String source) {
        this(schema, name, comment, tableType, source, null, null);
    }

    public AbstractTableDefinition(SchemaDefinition schema, String name, String comment, TableType tableType, String source, SchemaDefinition referencedSchema, String referencedName) {
        super(schema, null, name, comment, source);

        this.parentTable = null;
        this.childTables = new ArrayList<>();
        this.tableType = tableType;
        this.referencedSchema = referencedSchema;
        this.referencedName = referencedName;
    }

    @Override
    public /* non-final */ boolean isSynthetic() {
        return false;
    }

    @Override
    public final List getEmbeddables() {
        return getDatabase().getEmbeddables(this);
    }

    @Override
    public final List getReferencedEmbeddables() {
        return getDatabase().getEmbeddablesByReferencingTable(this);
    }

    @Override
    public final UniqueKeyDefinition getPrimaryKey() {
        for (ColumnDefinition column : getColumns())
            if (column.getPrimaryKey() != null)
                return column.getPrimaryKey();

        return null;
    }

    @Override
    public final List getIndexes() {
        return getDatabase().getIndexes(this);
    }

    @Override
    public final List getUniqueKeys() {
        return getDatabase().getRelations().getUniqueKeys(this);
    }

    @Override
    public final UniqueKeyDefinition getUniqueKey(String name) {
        for (UniqueKeyDefinition uk : getUniqueKeys())
            if (uk.getInputName().equals(name))
                return uk;

        return null;
    }

    @Override
    public final List getKeys() {
        return getDatabase().getRelations().getKeys(this);
    }

    @Override
    public final UniqueKeyDefinition getKey(String name) {
        for (UniqueKeyDefinition uk : getKeys())
            if (uk.getInputName().equals(name))
                return uk;

        return null;
    }

    @Override
    public final List getForeignKeys() {
        return getDatabase().getRelations().getForeignKeys(this);
    }

    @Override
    public final List getForeignKeys(TableDefinition referenced) {
        List result = new ArrayList<>();

        for (ForeignKeyDefinition key : getForeignKeys())
            if (referenced.equals(key.getReferencedTable()))
                result.add(key);

        return result;
    }

    @Override
    public final List getInverseForeignKeys() {
        List result = new ArrayList<>();

        for (UniqueKeyDefinition uk : getKeys())
            for (ForeignKeyDefinition fk : uk.getForeignKeys())
                result.add(fk.getInverse());

        return getDatabase().sort(result);
    }

    @Override
    public final List getInverseForeignKeys(TableDefinition referencing) {
        List result = new ArrayList<>();

        for (InverseForeignKeyDefinition key : getInverseForeignKeys())
            if (referencing.equals(key.getReferencingTable()))
                result.add(key);

        return result;
    }

    @Override
    public final List getManyToManyKeys() {
        List result = new ArrayList<>();

        for (InverseForeignKeyDefinition k : getInverseForeignKeys()) {

            ukLoop:
            for (UniqueKeyDefinition uk : k.getReferencingTable().getKeys()) {
                if (!uk.getKeyColumns().containsAll(k.getReferencingColumns()))
                    continue ukLoop;

                fkLoop:
                for (ForeignKeyDefinition fk : k.getReferencingTable().getForeignKeys()) {
                    if (!k.getForeignKey().equals(fk)) {
                        Set columns = new HashSet<>();
                        columns.addAll(k.getForeignKey().getKeyColumns());

                        // [#13639] The two FKs must not overlap
                        for (ColumnDefinition c : fk.getKeyColumns())
                            if (!columns.add(c))
                                continue fkLoop;

                        // [#13639] Require UK = FK1 + FK2
                        if (!columns.equals(new HashSet<>(uk.getKeyColumns())))
                            continue fkLoop;

                        result.add(new DefaultManyToManyKeyDefinition(k.getForeignKey(), uk, fk));
                    }
                }
            }
        }

        return getDatabase().sort(result);
    }

    @Override
    public final List getManyToManyKeys(TableDefinition referencing) {
        List result = new ArrayList<>();

        for (ManyToManyKeyDefinition key : getManyToManyKeys())
            if (referencing.equals(key.getForeignKey2().getReferencedTable()))
                result.add(key);

        return result;
    }

    @Override
    public final List getCheckConstraints() {
        return getDatabase().getRelations().getCheckConstraints(this);
    }










    @Override
    public final IdentityDefinition getIdentity() {
        for (ColumnDefinition column : getColumns())
            if (column.isIdentity())
                return new DefaultIdentityDefinition(column);

        return null;
    }

    public final void setParentTable(TableDefinition parentTable) {
        this.parentTable = parentTable;
    }

    @Override
    public final TableDefinition getParentTable() {
        return parentTable;
    }

    @Override
    public final List getChildTables() {
        return childTables;
    }

    @Override
    public final Table getTable() {
        return new TableImpl<>(getQualifiedNamePart(), null, null, null, DSL.comment(getComment()), getTableOptions());
    }

    @Override
    public final TableOptions getTableOptions() {
        if (isTableValuedFunction())
            return TableOptions.function(getSource());
        else if (isMaterializedView())
            return TableOptions.materializedView(getSource());
        else if (isView())
            return TableOptions.view(getSource());
        else if (isTemporary())
            return TableOptions.temporaryTable();
        else
            return TableOptions.table();
    }

    @Override
    public final List getColumns() {
        return getElements();
    }

    @Override
    public final ColumnDefinition getColumn(String columnName) {
        return getElement(columnName);
    }

    @Override
    public final ColumnDefinition getColumn(String columnName, boolean ignoreCase) {
        return getElement(columnName, ignoreCase);
    }

    @Override
    public final ColumnDefinition getColumn(int columnIndex) {
        return getElement(columnIndex);
    }

    @Override
    public final List getParameters() {
        if (parameters == null)
            parameters = getParameters0();

        return parameters;
    }

    @Override
    public final boolean isTemporary() {
        return tableType == TableType.TEMPORARY;
    }

    @Override
    public final boolean isView() {
        return tableType == TableType.VIEW;
    }

    @Override
    public final boolean isMaterializedView() {
        return tableType == TableType.MATERIALIZED_VIEW;
    }

    @Override
    public final boolean isTableValuedFunction() {
        return tableType == TableType.FUNCTION;
    }

    @Override
    public final TableDefinition getReferencedTable() {
        if (referencedTable == null) {
            if (referencedSchema != null)
                referencedTable = getDatabase().getTable(referencedSchema, referencedName);

            if (referencedTable == null)
                referencedTable = this;
        }

        return referencedTable;
    }

    @Override
    protected List getElements0() throws SQLException {
        return null;
    }

    protected List getParameters0() {
        return Collections.emptyList();
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy