# Attribute.java

    /*
    ** Module   : Attribute.java
    ** Abstract : Column representation for database schema storage and comparison.
    **
    ** Copyright (c) 2022-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
    ** 001 BS  20221103 Created initial version.
    ** 002 BS  20230331 Added support for extent fields.
    */

    /*
    ** 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 com.goldencode.p2j.persist.orm.*;

    /**
     * Column representation for database schema storage and comparison.
     */
    public class Attribute
    extends Element
    {
       /**
        * String representation of column type.
        */
       private final String type;

       /**
        * String representation of column type's precision.
        *
        * Should be null/empty or contain a number of decimals. Although, this is vendor-specific, so may contain
        * various strings.
        */
       private final String precision;

       /**
        * Is nullable?
        */
       private final boolean nullable;

       /**
        * Default value for the column.
        */
       private final String defaultValue;

       /**
        * EXTENT property of the column. This is handled separately (it's stored in a separate table), so requires
        * extra processing once all tables' information is loaded.
        */
       private final int extent;

       /**
        * Default constructor.
        *
        * @param   name
        *          Most basic property of any element - its name
        * @param   table
        *          Table containing the column (parent)
        * @param   type
        *          String representation of column type
        * @param   precision
        *          String representation of column type's precision
        * @param   nullable
        *          Is nullable?
        * @param   defaultValue
        *          Default value for the column
        * @param   extent
        *          EXTENT property of the column
        * @param   comment
        *          Comment for the column
        */
       public Attribute(String name,
                        Table table,
                        String type,
                        String precision,
                        boolean nullable,
                        String defaultValue,
                        int extent,
                        String comment)
       {
          super(name, table, comment);
          this.type = type;
          this.precision = precision;
          this.nullable = nullable;
          this.defaultValue = defaultValue;
          this.extent = extent;
       }

       /**
        * Getter for type.
        *
        * @return String representation of column type
        */
       public String getType()
       {
          return type;
       }

       /**
        * Getter for precision.
        *
        * @return String representation of column type's precision
        */
       public String getPrecision()
       {
          return precision;
       }

       /**
        * Getter for nullable.
        *
        * @return Is nullable?
        */
       public boolean getNullable()
       {
          return nullable;
       }

       /**
        * Getter for defaultValue.
        *
        * @return Default value for the column
        */
       public String getDefaultValue()
       {
          return defaultValue;
       }

       /**
        * Getter for EXTENT property.
        */
       public int getExtent()
       {
          return extent;
       }

       /**
        * Decides whether the column is a part of surrogate primary key. This is important so that surrogate
        * columns are not exposed to the end user.
        *
        * @return  TRUE if column is a part of surrogate primary key
        */
       public boolean isPrimaryKey()
       {
          return getName().equalsIgnoreCase(Session.PK);
       }
    }