DirtyData.java

/*
** Module   : DirtyData.java
** Abstract : Container for values that were updated in a DMO.
**
** Copyright (c) 2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- -----------------------------------Description-----------------------------------
** 001 AL2 20240903 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.dirty;

import com.goldencode.p2j.util.BaseDataType;

/**
 * A container for the information that should be propagated to the dirty share manager
 * when an insert or update is made. These changes will be honored before doing a save
 * on a DMO snapshot. If such construct won't be used, the DMOs that reach the dirty
 * share manager may not contain the right dirty state (maybe because a flush just occurred,
 * validating the dirty props.)
 */
public class DirtyData
{
   /**
    * Array of names of those DMO properties which were updated.
    * These should represent columns which participate in one or more indexes.
    */
   private final String[] properties;
   
   /** In case of EXTENT fields this array contains their index. Otherwise -1. */
   private final int[] extIndexes;
   
   /** 
    * Updated DMO property values.  Each value in the array
    * corresponds positionally with its matching property name in the
    * <code>properties</code> array. 
    */
   private final BaseDataType[] values;   

   /**
    * Basic constructor.
    * 
    * @param   properties
    *          Array of names of those DMO properties which were updated.
    * @param   extIndexes
    *          In case of EXTENT fields this array contains their index. Otherwise -1.
    * @param   values
    *          Updated DMO property values
    */
   public DirtyData(String[] properties, int[] extIndexes, BaseDataType[] values)
   {
      this.properties = properties;
      this.extIndexes = extIndexes;
      this.values = values;
   }

   /**
    * Basic getter for {@link #properties}
    * 
    * @return   Array of names of those DMO properties which were updated.
    */
   public String[] getProperties()
   {
      return this.properties;
   }

   /**
    * Basic getter for {@link #extIndexes}
    * 
    * @return   In case of EXTENT fields this array contains their index. Otherwise -1.
    */
   public int[] getExtIndexes()
   {
      return this.extIndexes;
   }

   /**
    * Basic getter for {@link #values}
    * 
    * @return   Updated DMO property values.
    */
   public BaseDataType[] getValues()
   {
      return this.values;
   } 

}