com.github.jinahya.sql.database.metadata.bind.Procedure 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 java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementRef;
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#getProcedures(java.lang.String, java.lang.String, java.lang.String)}.
 *
 * @author Jin Kwon <jinahya_at_gmail.com>
 */
@XmlRootElement
@XmlType(
    propOrder = {
        "procedureName", "remarks", "procedureType", "specificName",
        // ---------------------------------------------------------------------
        "procedureColumns"
    }
)
public class Procedure extends AbstractChild
    implements Comparable {


    // by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME.
    @Override
    public int compareTo(final Procedure o) {

        return new CompareToBuilder()
            .append(procedureCat, o.getProcedureCat())
            .append(procedureSchem, o.getProcedureSchem())
            .append(procedureName, o.getProcedureName())
            .append(specificName, o.getSpecificName())
            .build();
    }


    @Override
    public String toString() {

        return super.toString() + "{"
               + "procedureCat=" + procedureCat
               + ", procedureSchem=" + procedureSchem
               + ", procedureName=" + procedureName
               + ", remarks=" + remarks
               + ", procedureType=" + procedureType
               + ", specificName=" + specificName
               + "}";
    }


    // ------------------------------------------------------------ procedureCat
    public String getProcedureCat() {

        return procedureCat;
    }


    public void setProcedureCat(final String procedureCat) {

        this.procedureCat = procedureCat;
    }


    // ---------------------------------------------------------- procedureSchem
    public String getProcedureSchem() {

        return procedureSchem;
    }


    public void setProcedureSchem(final String procedureSchem) {

        this.procedureSchem = procedureSchem;
    }


    // ----------------------------------------------------------- procedureName
    public String getProcedureName() {

        return procedureName;
    }


    public void setProcedureName(final String procedureName) {

        this.procedureName = procedureName;
    }


    // ----------------------------------------------------------------- remarks
    public String getRemarks() {

        return remarks;
    }


    public void setRemarks(final String remarks) {

        this.remarks = remarks;
    }


    // ----------------------------------------------------------- procedureType
    public short getProcedureType() {

        return procedureType;
    }


    public void setProcedureType(final short procedureType) {

        this.procedureType = procedureType;
    }


    // ------------------------------------------------------------ specificName
    public String getSpecificName() {

        return specificName;
    }


    public void setSpecificName(final String specificName) {

        this.specificName = specificName;
    }


    // ------------------------------------------------------------------ schema
    // just for class diagram
    private Schema getSchema() {

        return getParent();
    }


//    public void setSchema(final Schema schema) {
//
//        setParent(schema);
//    }
    // -------------------------------------------------------- procedureColumns
    public List getProcedureColumns() {

        if (procedureColumns == null) {
            procedureColumns = new ArrayList();
        }

        return procedureColumns;
    }


    public void setProcedureColumns(List procedureColumns) {
        this.procedureColumns = procedureColumns;
    }


    // -------------------------------------------------------------------------
    @Label("PROCEDURE_CAT")
    @NillableBySpecification
    @XmlAttribute
    private String procedureCat;


    @Label("PROCEDURE_SCHEM")
    @NillableBySpecification
    @XmlAttribute
    private String procedureSchem;


    @Label("PROCEDURE_NAME")
    @XmlElement(required = true)
    private String procedureName;


    @Label("REMARKS")
    @XmlElement(required = true)
    private String remarks;


    @Label("PROCEDURE_TYPE")
    @XmlElement(required = true)
    private short procedureType;


    @Label("SPECIFIC_NAME")
    @XmlElement(required = true)
    private String specificName;


    @Invocation(
        name = "getProcedureColumns",
        types = {String.class, String.class, String.class, String.class},
        argsarr = {
            @InvocationArgs({
            ":procedureCat", ":procedureSchem", ":procedureName", "null"
        })
        }
    )
    @XmlElementRef
    private List procedureColumns;

}