com.github.jinahya.sql.database.metadata.bind.ExportedKey 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

There is a newer version: 4.2.9

Show newest version

/*
 * Copyright 2013 Jin Kwon .
 *
 * 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.
 */


package com.github.jinahya.sql.database.metadata.bind;


import javax.xml.bind.annotation.XmlRootElement;
import org.apache.commons.lang3.builder.CompareToBuilder;


/**
 * An entity class for binding the result of
 * {@link java.sql.DatabaseMetaData#getExportedKeys(java.lang.String, java.lang.String, java.lang.String)}.
 *
 * @author Jin Kwon <jinahya_at_gmail.com>
 * @see java.sql.DatabaseMetaData#getExportedKeys(java.lang.String,
 * java.lang.String, java.lang.String)
 * @see MetadataContext#getExportedKeys(java.lang.String, java.lang.String,
 * java.lang.String)
 */
@XmlRootElement
public class ExportedKey extends TableKey {


    // by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
    @Override
    public int compareTo(final ExportedKey o) {

        return new CompareToBuilder()
            .append(getFktableCat(), o.getFktableCat())
            .append(getFktableSchem(), o.getFktableSchem())
            .append(getFktableName(), o.getFktableName())
            .append(getKeySeq(), o.getKeySeq())
            .build();
    }


    // ------------------------------------------------------------------- table
    // just for class diagram
    private Table getTable() {

        return getParent();
    }

}