Table.java

/*
** Module   : Table.java
** Abstract : Table representation for database schema storage and comparison.
**
** Copyright (c) 2022-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 BS  20221103 Created initial version.
** 002 BS  20230331 Added support for extent fields.
** 003 OM  20240318 Added toString() implementation of easier debugging.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
**
**   0. Attribution Requirement.
**
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
**
**   1. No License To Use Trademarks.
**
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
**
**   2. No Misrepresentation of Affiliation.
**
**     You may not represent yourself as Golden Code Development Corporation or FWD.
**
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
**
**   3. No Misrepresentation of Source or Origin.
**
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.persist.orm.schema.element;

import java.util.*;
import com.goldencode.p2j.persist.*;

/**
 * Table representation for database schema storage and comparison.
 */
public class Table
extends Element
{
   /** Database. */
   private final Database database;
   
   /** List of columns. */
   public final Set<Attribute> attributes = new LinkedHashSet<>();
   
   /** List of indexes. */
   private final Set<Index> indexes = new LinkedHashSet<>();
   
   /**
    * Default constructor.
    * 
    * @param   database
    *          Database containing table.
    * @param   name
    *          Table name.
    */
   public Table(Database database, String name, String comment)
   {
      super(name, comment);
      
      this.database = database;
   }
   
   /**
    * Getter for database.
    * 
    * @return  Database containing table.
    */
   public Database getDatabase()
   {
      return database;
   }
   
   /**
    * Getter for columns.
    * 
    * @return  Collection of columns.
    */
   public Collection<Attribute> getAttributes()
   {
      return attributes;
   }
   
   /**
    * Getter for indexes.
    * 
    * @return  Collection of indexes.
    */
   public Collection<Index> getIndexes()
   {
      return indexes;
   }
   
   /**
    * Constructs and returns a short description of this object, usually needed while debugging.
    * 
    * @return  a {@code String} with a short description of this object (name and fields).
    */
   @Override
   public String toString()
   {
      StringBuilder sb = new StringBuilder();
      sb.append("Table{")
        .append(database.getName())
        .append(".")
        .append(getName())
        .append("(");
      for (Attribute attribute : attributes)
      {
         sb.append(attribute.getName()).append(", ");
      }
      sb.append("}");
      return sb.toString();
   }
}