DataSetRelation.java

/*
** Module   : DataSetRelation.java
** Abstract : Definition of a dataset relation for a SOAP dataset parameter.
**
** Copyright (c) 2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20211015 First 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.pattern;

/**
 * Holds the details about a dataset relation, for a SOAP operation's dataset parameter.
 */
class DataSetRelation
{
   /** The relation name. */
   final String name;
   
   /** The parent table name. */
   final String parent;
   
   /** The child table name. */
   final String child;
   
   /** The relation fields pairs. */
   final String pairs;
   
   /** Flag indicating if NESTED option is used. */
   final boolean nested;
   
   /** Flag indicating if FOREIGN-KEY-HIDDEN option is used. */
   final boolean fkHidden;
   
   // TODO: PARENT-ID-RELATION flag
   
   /**
    * Create a new relation.
    * 
    * @param    name
    *           The relation name.
    * @param    parent
    *           The parent table name.
    * @param    child
    *           The child table name.
    * @param    pairs
    *           The relation fields pairs.
    * @param    nested
    *           Flag indicating if NESTED option is used.
    * @param    fkHidden
    *           Flag indicating if FOREIGN-KEY-HIDDEN option is used.
    */
   public DataSetRelation(String  name, 
                          String  parent,
                          String  child,
                          String  pairs,
                          boolean nested,
                          boolean fkHidden)
   {
      this.name = name;
      this.parent = parent;
      this.child = child;
      this.pairs = pairs;
      this.nested = nested;
      this.fkHidden = fkHidden;
   }
}