com.github.jinahya.database.metadata.bind.CrossReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of database-metadata-bind Show documentation
Class for binding results of java.sql.DatabaseMetaData
The newest version!
package com.github.jinahya.database.metadata.bind;

/*-
 * #%L
 * database-metadata-bind
 * %%
 * Copyright (C) 2011 - 2019 Jinahya, Inc.
 * %%
 * 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.
 * #L%
 */

import jakarta.annotation.Nullable;
import jakarta.validation.constraints.Positive;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

import java.sql.DatabaseMetaData;
import java.util.Comparator;
import java.util.Objects;
import java.util.Optional;

import static java.util.Comparator.naturalOrder;
import static java.util.Comparator.nullsFirst;

/**
 * A class for binding results of the
 * {@link DatabaseMetaData#getCrossReference(String, String, String, String, String, String)} method.
 *
 * @author Jin Kwon <jinahya_at_gmail.com>
 */

@Setter
@Getter
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true, onlyExplicitlyIncluded = true)
public class CrossReference extends AbstractMetadataType {

    private static final long serialVersionUID = -5343386346721125961L;

    // -----------------------------------------------------------------------------------------------------------------
    static final Comparator CASE_INSENSITIVE_ORDER =
            Comparator.comparing(CrossReference::getFktableCat, nullsFirst(String.CASE_INSENSITIVE_ORDER))
                    .thenComparing(CrossReference::getFktableSchem, nullsFirst(String.CASE_INSENSITIVE_ORDER))
                    .thenComparing(CrossReference::getFktableName, nullsFirst(String.CASE_INSENSITIVE_ORDER))
                    .thenComparingInt(CrossReference::getKeySeq);

    static final Comparator LEXICOGRAPHIC_ORDER =
            Comparator.comparing(CrossReference::getFktableCat, nullsFirst(naturalOrder()))
                    .thenComparing(CrossReference::getFktableSchem, nullsFirst(naturalOrder()))
                    .thenComparing(CrossReference::getFktableName, nullsFirst(naturalOrder()))
                    .thenComparingInt(CrossReference::getKeySeq);

    // ----------------------------------------------------------------------------------------------------- UPDATE_RULE

    /**
     * A column label of {@value}.
     */
    public static final String COLUMN_LABEL_UPDATE_RULE = "UPDATE_RULE";

    // -----------------------------------------------------------------------------------------------------------------
    boolean isOfPktable(final Table pktable) {
        return Objects.equals(pktableCat, pktable.getTableCat()) &&
               Objects.equals(pktableSchem, pktable.getTableSchem()) &&
               Objects.equals(pktableName, pktable.getTableName());
    }

    boolean isOfFktable(final Table fktable) {
        return Objects.equals(fktableCat, fktable.getTableCat()) &&
               Objects.equals(fktableSchem, fktable.getTableSchem()) &&
               Objects.equals(fktableName, fktable.getTableName());
    }

    // ------------------------------------------------------------------------------------------------------ pkTableCat

    // ---------------------------------------------------------------------------------------------------- pkTableSchem

    // ------------------------------------------------------------------------------------------------------ fktableCat

    // ---------------------------------------------------------------------------------------------------- fktableSchem

    // ------------------------------------------------------------------------------------------------------ updateRule
    PortedKey.TableKeyUpdateRule getUpdateRuleAsEnum() {
        return Optional.ofNullable(getUpdateRule())
                .map(PortedKey.TableKeyUpdateRule::valueOfFieldValue)
                .orElse(null);
    }

    void setUpdateRuleAsEnum(final PortedKey.TableKeyUpdateRule updateRuleAsEnum) {
        setUpdateRule(
                Optional.ofNullable(updateRuleAsEnum)
                        .map(_IntFieldEnum::fieldValueAsInt)
                        .orElse(null)
        );
    }

    // ------------------------------------------------------------------------------------------------------ deleteRule

    // -----------------------------------------------------------------------------------------------------------------

    @Nullable
    @_NullableBySpecification
    @_ColumnLabel("PKTABLE_CAT")
    private String pktableCat;

    @Nullable
    @_NullableBySpecification
    @_ColumnLabel("PKTABLE_SCHEM")
    private String pktableSchem;

    @_ColumnLabel("PKTABLE_NAME")
    @EqualsAndHashCode.Include
    private String pktableName;

    @_ColumnLabel("PKCOLUMN_NAME")
    @EqualsAndHashCode.Include
    private String pkcolumnName;

    // -----------------------------------------------------------------------------------------------------------------

    @Nullable
    @_NullableBySpecification
    @_ColumnLabel("FKTABLE_CAT")
    private String fktableCat;

    @Nullable
    @_NullableBySpecification
    @_ColumnLabel("FKTABLE_SCHEM")
    private String fktableSchem;

    @_ColumnLabel("FKTABLE_NAME")
    @EqualsAndHashCode.Include
    private String fktableName;

    @_ColumnLabel("FKCOLUMN_NAME")
    @EqualsAndHashCode.Include
    private String fkcolumnName;

    // -----------------------------------------------------------------------------------------------------------------
    @Positive
    @_ColumnLabel("KEY_SEQ")
    private Integer keySeq;

    @_ColumnLabel(COLUMN_LABEL_UPDATE_RULE)
    private Integer updateRule;

    @_ColumnLabel("DELETE_RULE")
    private Integer deleteRule;

    @Nullable
    @_NullableBySpecification
    @_ColumnLabel("FK_NAME")
    private String fkName;

    @Nullable
    @_NullableBySpecification
    @_ColumnLabel("PK_NAME")
    private String pkName;

    @_ColumnLabel("DEFERRABILITY")
    private Integer deferrability;
}