com.github.jinahya.sql.database.metadata.bind.UDT 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
bindings for 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#getUDTs(java.lang.String, java.lang.String, java.lang.String, int[])}.
 *
 * @author Jin Kwon <jinahya_at_gmail.com>
 */
@XmlRootElement
@XmlType(
    propOrder = {
        "typeName", "className", "dataType", "remarks", "baseType",
        // ---------------------------------------------------------------------
        "attributes", "superTypes"
    }
)
public class UDT extends AbstractChild implements Comparable {


    // by DATA_TYPE, TYPE_CAT, TYPE_SCHEM and TYPE_NAME.
    @Override
    public int compareTo(final UDT o) {

        return new CompareToBuilder()
            .append(dataType, o.getDataType())
            .append(typeCat, o.getTypeCat())
            .append(typeSchem, o.getTypeSchem())
            .append(typeName, o.getTypeName())
            .build();
    }


    @Override
    public String toString() {

        return super.toString() + "{"
               + "typeCat=" + typeCat
               + ", typeSchem=" + typeSchem
               + ", typeName=" + typeName
               + ", className=" + className
               + ", dataType=" + dataType
               + ", remarks=" + remarks
               + ", baseType=" + baseType
               + "}";
    }


    // ----------------------------------------------------------------- typeCat
    public String getTypeCat() {

        return typeCat;
    }


    public void setTypeCat(final String typeCat) {

        this.typeCat = typeCat;
    }


    // --------------------------------------------------------------- typeSchem
    public String getTypeSchem() {

        return typeSchem;
    }


    public void setTypeSchem(final String typeSchem) {

        this.typeSchem = typeSchem;
    }


    // ---------------------------------------------------------------- typeName
    public String getTypeName() {

        return typeName;
    }


    public void setTypeName(final String typeName) {

        this.typeName = typeName;
    }


    // --------------------------------------------------------------- className
    public String getClassName() {

        return className;
    }


    public void setClassName(final String className) {

        this.className = className;
    }


    // ---------------------------------------------------------------- dataType
    public int getDataType() {

        return dataType;
    }


    public void setDataType(final int dataType) {

        this.dataType = dataType;
    }


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

        return remarks;
    }


    public void setRemarks(final String remarks) {

        this.remarks = remarks;
    }


    // ---------------------------------------------------------------- baseType
    public Short getBaseType() {

        return baseType;
    }


    public void setBaseType(final Short baseType) {

        this.baseType = baseType;
    }


    // -------------------------------------------------------------- attributes
    public List getAttributes() {

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

        return attributes;
    }


    // -------------------------------------------------------------- superTypes
    public List getSuperTypes() {

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

        return superTypes;
    }


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

        return getParent();
    }


//    public void setSchema(final Schema schema) {
//
//        setParent(schema);
//    }
    // -------------------------------------------------------------------------
    @Label("TYPE_CAT")
    @NillableBySpecification
    @XmlAttribute
    private String typeCat;


    @Label("TYPE_SCHEM")
    @NillableBySpecification
    @XmlAttribute
    private String typeSchem;


    @Label("TYPE_NAME")
    @XmlElement(required = true)
    private String typeName;


    @Label("CLASS_NAME")
    @XmlElement(required = true)
    private String className;


    @Label("DATA_TYPE")
    @XmlElement(required = true)
    private int dataType;


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


    @Label("BASE_TYPE")
    @NillableBySpecification
    @XmlElement(nillable = true, required = true)
    private Short baseType;


    @Invocation(
        name = "getAttributes",
        types = {String.class, String.class, String.class, String.class},
        argsarr = {
            @InvocationArgs({":typeCat", ":typeSchem", ":typeName", "null"})
        }
    )
    @XmlElementRef
    private List attributes;


    @Invocation(
        name = "getSuperTypes",
        types = {String.class, String.class, String.class},
        argsarr = {
            @InvocationArgs({":typeCat", ":typeSchem", ":typeName"})
        }
    )
    @XmlElementRef
    private List superTypes;

}