com.github.jinahya.sql.database.metadata.bind.ColumnPrivilege Maven / Gradle / Ivy

Go to download
/*
 * 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 java.util.List;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.CompareToBuilder;


/**
 * An entity class for binding the result of
 * {@link java.sql.DatabaseMetaData#getColumnPrivileges(java.lang.String, java.lang.String, java.lang.String, java.lang.String)}.
 *
 * @author Jin Kwon <jinahya_at_gmail.com>
 */
@XmlRootElement
@XmlType(
    propOrder = {
        "grantor", "grantee", "privilege", "isGrantable",
        // ---------------------------------------------------------------------
        "unknownResults"
    }
)
public class ColumnPrivilege extends AbstractChild
    implements Comparable {


    // by COLUMN_NAME and PRIVILEGE.
    @Override
    public int compareTo(final ColumnPrivilege o) {

        return new CompareToBuilder()
            .append(columnName, o.getColumnName())
            .append(privilege, o.getPrivilege())
            .build();
    }


    @Override
    public String toString() {

        return super.toString() + "{"
               + "tableCat=" + tableCat
               + ", tableSchem=" + tableSchem
               + ", tableName=" + tableName
               + ", columnName=" + columnName
               + ", grantor=" + grantor
               + ", grantee=" + grantee
               + ", privilege=" + privilege
               + ", isGrantable=" + isGrantable
               + "}";
    }


    // ---------------------------------------------------------------- tableCat
    public String getTableCat() {

        return tableCat;
    }


    public void setTableCat(final String tableCat) {

        this.tableCat = tableCat;
    }


    // -------------------------------------------------------------- tableSchem
    public String getTableSchem() {

        return tableSchem;
    }


    public void setTableSchem(final String tableSchem) {

        this.tableSchem = tableSchem;
    }


    // --------------------------------------------------------------- tableName
    public String getTableName() {

        return tableName;
    }


    public void setTableName(final String tableName) {

        this.tableName = tableName;
    }


    // -------------------------------------------------------------- columnName
    public String getColumnName() {

        return columnName;
    }


    public void setColumnName(final String columnName) {

        this.columnName = columnName;
    }


    // ----------------------------------------------------------------- grantor
    public String getGrantor() {

        return grantor;
    }


    public void setGrantor(final String grantor) {

        this.grantor = grantor;
    }


    // ----------------------------------------------------------------- grantee
    public String getGrantee() {

        return grantee;
    }


    public void setGrantee(String grantee) {

        this.grantee = grantee;
    }


    // --------------------------------------------------------------- privilege
    public String getPrivilege() {

        return privilege;
    }


    public void setPrivilege(final String privilege) {

        this.privilege = privilege;
    }


    // ------------------------------------------------------------- isGrantable
    public String getIsGrantable() {

        return isGrantable;
    }


    public void setIsGrantable(final String isGrantable) {

        this.isGrantable = isGrantable;
    }


    // ------------------------------------------------------------------ column
    // just for class diagram
    private Column getColumn() {

        return getParent();
    }


//    public void setColumn(final Column column) {
//
//        setParent(column);
//    }
    // -------------------------------------------------------------------------
    @Label("TABLE_CAT")
    @NillableBySpecification
    @XmlAttribute
    private String tableCat;


    @Label("TABLE_SCHEM")
    @NillableBySpecification
    @XmlAttribute
    private String tableSchem;


    @Label("TABLE_NAME")
    @XmlAttribute
    private String tableName;


    @Label("COLUMN_NAME")
    @XmlAttribute
    private String columnName;


    @Label("GRANTOR")
    @NillableBySpecification
    @XmlElement(nillable = true, required = true)
    private String grantor;


    @Label("GRANTEE")
    @XmlElement(required = true)
    private String grantee;


    @Label("PRIVILEGE")
    @XmlElement(required = true)
    private String privilege;


    @Label("IS_GRANTABLE")
    @NillableBySpecification
    @XmlElement(nillable = true, required = true)
    private String isGrantable;


    @XmlElement(name = "unknownResult", nillable = true)
    private List unknownResults;


}