# LegacyFieldMetaData.java

    /*
    ** Module   : LegacyFieldMetaData.java
    ** Abstract : Helper class to provide details about a legacy field metadata in the open client.
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 CA  20230221Created initial version.
    */

    /*
    ** 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.util;

    import com.goldencode.p2j.persist.DataSetContainer;
    import com.goldencode.p2j.persist.TableWrapper;

    /**
     * Helper class to provide details about a field's metadata.
     */
    public class LegacyFieldMetaData
    {
       /** The field's index. */
       final int idx;

       /** The field's legacy name. */
       final String name;

       /** The field's extent.  */
       final int extent;

       /**
        * The field's type, a {@link BaseDataType}, {@link DataSetContainer}, {@link TableWrapper} or
        * {@link MemoryBuffer}.
        */
       final Class<?> type;

       /** The field's legacy type, one of the {@link LegacyJavaAppserverApi} <code>TYPE_</code> constants. */
       final int legacyType;

       /** The field's order. */
       final int order;

       /** The field's XML mapping. */
       final int xmlMapping;

       /** In case of denormalized extent, the index in the extent field. */
       Integer extentIndex = null;

       /** The original extent field name, in case of denormalized extent. */
       String extentField = null;

       /**
        * Create a new field metadata, for a legacy field with the given details.
        *
        * @param    idx
        *           The field's index.
        * @param    name
        *           The field's legacy name.
        * @param    extent
        *           The field's extent.
        * @param    type
        *           The field's type, a {@link BaseDataType}, {@link DataSetContainer}, {@link TableWrapper} or
        *           {@link MemoryBuffer}.
        * @param    legacyType
        *           The field's legacy type, one of the {@link LegacyJavaAppserverApi} <code>TYPE_</code> constants.
        * @param    order
        *           The field's order.
        * @param    xmlMapping
        *           The field's XML mapping.
        */
       public LegacyFieldMetaData(int      idx,
                                  String   name,
                                  int      extent,
                                  Class<?> type,
                                  int      legacyType,
                                  int      order,
                                  int      xmlMapping)
       {
          this.idx = idx;
          this.name = name;
          this.extent = extent;
          this.type = type;
          this.legacyType = legacyType;
          this.order = order;
          this.xmlMapping = xmlMapping;

       }

       /**
        * Copy the metadata from another field.
        *
        * @param    field
        *           The source field.
        */
       public LegacyFieldMetaData(LegacyFieldMetaData field)
       {
          this.idx = field.idx;
          this.name = field.name;
          this.extent = field.extent;
          this.type = field.type;
          this.legacyType = field.legacyType;
          this.order = field.order;
          this.xmlMapping = field.xmlMapping;
          this.extentIndex = field.extentIndex;
          this.extentField = field.extentField;
       }

       /**
        * Get the {@link #idx}.
        *
        * @return   See above.
        */
       public int getIdx()
       {
          return idx;
       }

       /**
        * Get the {@link #name}.
        *
        * @return   See above.
        */
       public String getName()
       {
          return name;
       }

       /**
        * Get the {@link #extent}.
        *
        * @return   See above.
        */
       public int getExtent()
       {
          return extent;
       }

       /**
        * Get the {@link #type}.
        *
        * @return   See above.
        */
       public Class<?> getType()
       {
          return type;
       }

       /**
        * Get the {@link #legacyType}.
        *
        * @return   See above.
        */
       public int getLegacyType()
       {
          return legacyType;
       }

       /**
        * Get the {@link #order}.
        *
        * @return   See above.
        */
       public int getOrder()
       {
          return order;
       }

       /**
        * Get the {@link #xmlMapping}.
        *
        * @return   See above.
        */
       public int getXmlMapping()
       {
          return xmlMapping;
       }

       /**
        * Get the {@link #extentIndex}.
        *
        * @return   See above.
        */
       public Integer getExtentIndex()
       {
          return extentIndex;
       }

       /**
        * Get the {@link #extentField}.
        *
        * @return   See above.
        */
       public String getExtentField()
       {
          return extentField;
       }

       /**
        * Set the {@link #extentIndex}.
        *
        * @param    extentIndex
        *           In case of denormalized extent, the index in the extent field.
        */
       public void setExtentIndex(Integer extentIndex)
       {
          this.extentIndex = extentIndex;
       }

       /**
        * Get the {@link #extentField}.
        *
        * @param    extentField
        *           The original extent field name, in case of denormalized extent.
        */
      public void setExtentField(String extentField)
       {
          this.extentField = extentField;
       }
    }