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

Go to download
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 lombok.AccessLevel;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.SuperBuilder;

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

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

/**
 * A class for binding results of
 * {@link DatabaseMetaData#getProcedures(java.lang.String, java.lang.String, java.lang.String)} method.
 *
 * @author Jin Kwon <jinahya_at_gmail.com>
 * @see DatabaseMetaData#getProcedures(String, String, String)
 * @see Context#getFunctionColumns(String, String, String, String)
 * @see ProcedureColumn
 */
@_ParentOf(ProcedureColumn.class)
@_ChildOf(Schema.class)
@Setter
@Getter
@ToString(callSuper = true)
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@SuperBuilder(toBuilder = true)
public class Procedure extends AbstractMetadataType {

    private static final long serialVersionUID = -6262056388403934829L;

    static final Comparator CASE_INSENSITIVE_ORDER =
            Comparator.comparing(Procedure::getSchemaId, SchemaId.CASE_INSENSITIVE_ORDER)
                    .thenComparing(Procedure::getProcedureName, nullsFirst(String.CASE_INSENSITIVE_ORDER))
                    .thenComparing(Procedure::getSpecificName, nullsFirst(String.CASE_INSENSITIVE_ORDER));

    static final Comparator LEXICOGRAPHIC_ORDER =
            Comparator.comparing(Procedure::getSchemaId, SchemaId.LEXICOGRAPHIC_ORDER)
                    .thenComparing(Procedure::getProcedureName, nullsFirst(naturalOrder()))
                    .thenComparing(Procedure::getSpecificName, nullsFirst(naturalOrder()));

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

    /**
     * A colum label of {@value}.
     * 
     * 

     * kind of procedure:
     * 
     *   {@link DatabaseMetaData#procedureResultUnknown procedureResultUnknown} - Cannot determine if a return value will be returned
     *   {@link DatabaseMetaData#procedureNoResult procedureNoResult} - Does not return a return value
     *   {@link DatabaseMetaData#procedureReturnsResult procedureReturnsResult} - Returns a return value
     * 
     * 
     */
    public static final String COLUMN_LABEL_PROCEDURE_TYPE = "PROCEDURE_TYPE";

    /**
     * Constants for the value of {@value #COLUMN_LABEL_PROCEDURE_TYPE} column.
     */
    public enum ProcedureTypeEnum implements _IntFieldEnum {

        /**
         * A value for
         * {@link DatabaseMetaData#procedureResultUnknown}({@value DatabaseMetaData#procedureResultUnknown}).
         */
        PROCEDURE_RESULT_UNKNOWN(DatabaseMetaData.procedureResultUnknown), // 0

        /**
         * A value for {@link DatabaseMetaData#procedureNoResult}({@value DatabaseMetaData#procedureNoResult}).
         */
        PROCEDURE_NO_RESULT(DatabaseMetaData.procedureNoResult), // 1

        /**
         * A value for
         * {@link DatabaseMetaData#procedureReturnsResult}({@value DatabaseMetaData#procedureReturnsResult}).
         */
        PROCEDURE_RETURNS_RESULT(DatabaseMetaData.procedureReturnsResult); // 2

        /**
         * Returns the value whose {@link #fieldValueAsInt() fieldValue} matches to specified value.
         *
         * @param fieldValue the value of {@link #fieldValueAsInt() fieldValue} to match.
         * @return a matched value.
         */
        public static ProcedureTypeEnum valueOfFieldValue(final int fieldValue) {
            return _IntFieldEnum.valueOfFieldValue(ProcedureTypeEnum.class, fieldValue);
        }

        private ProcedureTypeEnum(final int fieldValue) {
            this.fieldValue = fieldValue;
        }

        @Override
        public int fieldValueAsInt() {
            return fieldValue;
        }

        private int fieldValue;
    }

    /**
     * A colum label of {@value}.
     * 
     * 
The
     * name which uniquely identifies this procedure within its schema.
     */
    public static final String COLUMN_LABEL_SPECIFIC_NAME = "SPECIFIC_NAME";

    // -----------------------------------------------------------------------------------------------------------------
    @Override
    public boolean equals(final Object obj) {
        if (this == obj) return true;
        if (!(obj instanceof Procedure)) return false;
        final Procedure that = (Procedure) obj;
        return Objects.equals(procedureCat, that.procedureCat) &&
               Objects.equals(procedureSchem, that.procedureSchem) &&
               Objects.equals(procedureName, that.procedureName) &&
               Objects.equals(specificName, that.specificName);
    }

    @Override
    public int hashCode() {
        return Objects.hash(
                procedureCat,
                procedureSchem,
                procedureName,
                specificName
        );
    }

    // -----------------------------------------------------------------------------------------------------------------
    public void setProcedureCat(final String procedureCat) {
        this.procedureCat = procedureCat;
        procedureId = null;
    }

    public void setProcedureSchem(final String procedureSchem) {
        this.procedureSchem = procedureSchem;
        procedureId = null;
    }

    ProcedureTypeEnum getProcedureTypeAsEnum() {
        return ProcedureTypeEnum.valueOfFieldValue(getProcedureType());
    }

    void setProcedureTypeAsEnum(final ProcedureTypeEnum procedureTypeAsEnum) {
        Objects.requireNonNull(procedureTypeAsEnum, "procedureTypeAsEnum is null");
        setProcedureType(procedureTypeAsEnum.fieldValueAsInt());
    }

    public void setSpecificName(final String specificName) {
        this.specificName = specificName;
        procedureId = null;
    }

    // -----------------------------------------------------------------------------------------------------------------
    @_NullableBySpecification
    @_ColumnLabel("PROCEDURE_CAT")
    private String procedureCat;

    @_NullableBySpecification
    @_ColumnLabel("PROCEDURE_SCHEM")
    private String procedureSchem;

    @_ColumnLabel("PROCEDURE_NAME")
    private String procedureName;

    @_NullableByVendor("HSQL")
    @_ColumnLabel("REMARKS")
    private String remarks;

    @_ColumnLabel("PROCEDURE_TYPE")
    private int procedureType;

    @_ColumnLabel(COLUMN_LABEL_SPECIFIC_NAME)
    private String specificName;

    // -----------------------------------------------------------------------------------------------------------------
    String getProcedureCatNonNull() {
        if (procedureCat == null) {
            return Catalog.COLUMN_VALUE_TABLE_CAT_EMPTY;
        }
        return procedureCat;
    }

    String getProcedureSchemNonNull() {
        if (procedureSchem == null) {
            return Schema.COLUMN_VALUE_TABLE_SCHEM_EMPTY;
        }
        return procedureSchem;
    }

    ProcedureId getProcedureId() {
        if (procedureId == null) {
            procedureId = ProcedureId.of(
                    SchemaId.of(
                            getProcedureCatNonNull(),
                            getProcedureSchemNonNull()
                    ),
                    getSpecificName()
            );
        }
        return procedureId;
    }

    private SchemaId getSchemaId() {
        return getProcedureId().getSchemaId();
    }

    @EqualsAndHashCode.Exclude
    @ToString.Exclude
    private transient ProcedureId procedureId;
}