# MassiveContainer.java

    /*
    ** Module   : MassiveContainer.java
    ** Abstract : A container used to serialize a massive data structure (Table or DataSet) and send
    **            it to a remote side.
    **
    ** Copyright (c) 2019, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 OM  20190708 Created 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.persist;

    /**
     * Provides the main mechanism of passing table-like metadata and data which the remote side will
     * interpret as a temporary table. The remote side will use the sent properties (and their other
     * settings, as type and extent) to dynamically build the DMO interface, implementation class and
     * .hbm.xml configuration file.
     * <p>
     * As transport, any instance of this class will be wrapped in a {@link TableWrapper} instance
     * internally by P2J.
     * <p>
     * <strong>Note:</strong> In the process of building the internal data structures for dynamic
     * temp-tables, internal generic indexed names are used for columns. To obtain the expected column
     * name, the metadata will return the column's legacy name instead of internal database name.
     */
    public abstract class MassiveContainer
    {
       /** Flag indicating this table is sent in INPUT or INPUT-OUTPUT mode. */
       protected boolean input;

       /** Flag indicating this table is sent in OUTPUT or INPUT-OUTPUT mode. */
       protected boolean output;

       /** Flag indicating this table is sent in APPEND mode. */
       protected boolean append;

       /** The legacy name of the massive structure. */
       protected String structureName;

       /**
        * Default c'tor, explicitly added to allow instances of this class to be created on
        * deserialization. Not for public use.
        */
       public MassiveContainer()
       {
       }

       /**
        * Create a new instance of this result set.
        *
        * @param    input
        *           Flag indicating this table is sent in INPUT or INPUT-OUTPUT mode.
        * @param    output
        *           Flag indicating this table is sent in OUTPUT or INPUT-OUTPUT mode.
        * @param    append
        *           Flag indicating this table is sent in APPEND mode.
        */
       public MassiveContainer(boolean input, boolean output, boolean append)
       {
          this.input = input;
          this.output = output;
          this.append = append;
       }

       /**
        * Set the structure (dataset or table) name.
        *
        * @param    table
        *           The structure (dataset or table) name.
        */
       public void setStructureName(String table)
       {
          this.structureName = table;
       }

       /**
        * Get the legacy structure (dataset or table) name.
        *
        * @return  The {@link #structureName}.
        */
       public String getStructureName()
       {
          return structureName;
       }

       /**
        * Check if this table is in INPUT or INPUT-OUTPUT mode.
        *
        * @return  The {@link #input} flag.
        */
       public boolean isInput()
       {
          return input;
       }

       /**
        * Check if this table is in OUTPUT or INPUT-OUTPUT mode.
        *
        * @return  The {@link #output} flag.
        */
       public boolean isOutput()
       {
          return output;
       }

       /**
        * Check if this table is in APPEND mode.
        *
        * @return  The {@link #append} flag.
        */
       public boolean isAppend()
       {
          return append;
       }
    }