src.main.java.com.aceql.client.metadata.Table Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aceql-http-client-sdk Show documentation

The AceQL Java Client SDK allows to wrap the AceQL HTTP APIs and eliminate the tedious works of handling communications errors and parsing JSON results. Android and Java Desktop application developers can access remote SQL databases and/or SQL databases in the cloud by simply including standard JDBC calls in their code, just like they would for a local database.

There is a newer version: 5.1

Show newest version

/*
 * This file is part of AceQL Client SDK.
 * AceQL Client SDK: Remote JDBC access over HTTP with AceQL HTTP.
 * Copyright (C) 2020,  KawanSoft SAS
 * (http://www.kawansoft.com). All rights reserved.
 *
 * 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.aceql.client.metadata;

import java.util.List;

/**
 * A SQL Table with it's defining elements.
 * @author Nicolas de Pomereu.
 */

public class Table {

    public static final String TABLE = "TABLE";
    public static final String VIEW = "VIEW";

	/**
	 * 	 * 
	 	   1.TABLE_CAT String = table catalog (may be null)
	 	   2.TABLE_SCHEM String = table schema (may be null)
	 	   3.TABLE_NAME String =  table name
	 	   4.TABLE_TYPE String =  table type. Typical types are "TABLE","VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY","LOCAL TEMPORARY", "ALIAS", "SYNONYM".
	 	   5.REMARKS String =  explanatory comment on the table
	 	   6.TYPE_CAT String = the types catalog (may be null)
	 	   7.TYPE_SCHEM String = the types schema (may be null)
	 	   8.TYPE_NAME String =  type name (may be null)
	 	   9.SELF_REFERENCING_COL_NAME String =  name of the designated "identifier" column of a typed table (may be null)
	 	   10.REF_GENERATION String = specifies how values inSELF_REFERENCING_COL_NAME are created. Values are"SYSTEM", "USER", "DERIVED". (may be null)
	
	 * 
	 */

    private String tableName = null;
    private String tableType = null;
    private String remarks = null;

      // No! Not implemented
//    private String typeCatalog = null;
//    private String typeSchema= null;
//    private String typeName = null;
//    private String selfReferencingColName = null;
//    private String refGeneration = null;

    private List columns = null;
    private List primaryKeys = null;
    private List indexes = null;

    private List importedforeignKeys = null;
    private List exportedforeignKeys = null;

    private String catalog = null;
    private String schema = null;

    public String getTableName() {
        return tableName;
    }
    public String getTableType() {
        return tableType;
    }
    public String getRemarks() {
        return remarks;
    }
    public List getColumns() {
        return columns;
    }
    public List getPrimaryKeys() {
        return primaryKeys;
    }
    public List getIndexes() {
        return indexes;
    }
    public List getImportedforeignKeys() {
        return importedforeignKeys;
    }
    public List getExportedforeignKeys() {
        return exportedforeignKeys;
    }
    public String getCatalog() {
        return catalog;
    }
    public String getSchema() {
        return schema;
    }
    void setTableName(String tableName) {
        this.tableName = tableName;
    }
    void setTableType(String tableType) {
        this.tableType = tableType;
    }
    void setRemarks(String remarks) {
        this.remarks = remarks;
    }
    void setColumns(List columns) {
        this.columns = columns;
    }
    void setPrimaryKeys(List primaryKeys) {
        this.primaryKeys = primaryKeys;
    }
    void setIndexes(List indexes) {
        this.indexes = indexes;
    }
    void setImportedforeignKeys(List importedforeignKeys) {
        this.importedforeignKeys = importedforeignKeys;
    }
    void setExportedforeignKeys(List exportedforeignKeys) {
        this.exportedforeignKeys = exportedforeignKeys;
    }
    void setCatalog(String catalog) {
        this.catalog = catalog;
    }
    void setSchema(String schema) {
        this.schema = schema;
    }
    @Override
    public int hashCode() {
	final int prime = 31;
	int result = 1;
	result = prime * result + ((catalog == null) ? 0 : catalog.hashCode());
	result = prime * result + ((schema == null) ? 0 : schema.hashCode());
	result = prime * result + ((tableName == null) ? 0 : tableName.hashCode());
	return result;
    }
    @Override
    public boolean equals(Object obj) {
	if (this == obj)
	    return true;
	if (obj == null)
	    return false;
	if (getClass() != obj.getClass())
	    return false;
	Table other = (Table) obj;
	if (catalog == null) {
	    if (other.catalog != null)
		return false;
	} else if (!catalog.equals(other.catalog))
	    return false;
	if (schema == null) {
	    if (other.schema != null)
		return false;
	} else if (!schema.equals(other.schema))
	    return false;
	if (tableName == null) {
	    if (other.tableName != null)
		return false;
	} else if (!tableName.equals(other.tableName))
	    return false;
	return true;
    }
    @Override
    public String toString() {
	return "Table [tableName=" + tableName + ", tableType=" + tableType + ", remarks=" + remarks + ", columns="
		+ columns + ", primaryKeys=" + primaryKeys + ", indexes=" + indexes + ", importedforeignKeys="
		+ importedforeignKeys + ", exportedforeignKeys=" + exportedforeignKeys + ", catalog=" + catalog
		+ ", schema=" + schema + "]";
    }

}