# PersistenceLogger.java

    /*
    ** Module   : PersistenceLogger.java
    ** Abstract : Logger for persistent statements/queries
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
    ** 001 RAA 20230522 First revision with basic usage.
    ** 002 RAA 20230607 Removed setTimestamp since this is done with CentralLogger.
    */

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

    /**
     * Abstract class responsible with handling some common functions of loggers, such as
     * getting the parent method from the stack trace.
     */
    public abstract class PersistenceLogger
    {
       /**
        * Function for getting the parent method. Some packages are ignored to help debugging.
        * This method was initially in {@link com.goldencode.p2j.aspects.ltw.AdaptiveQueryTraceAspect}.
        *
        * @param   ste
        *          A StackTraceElement array containing the current thread trace
        *          until it reached the trace method.
        *
        * @return  null if there is no parent.
        *          a String value that holds the first parent found in the stack trace.
        */
       public static String getStackMethodParent(StackTraceElement[] ste)
       {
          // packages that should be ignored when searching for the parent method
          // The only package that should be a parent is the package belonging to the
          // converted 4GL application, any other package should be added to the following list.
          String[] ignoredPackages =
          {
             "java.",
             "org.aspectj.runtime.",
             "com.goldencode.p2j.",
             "com.sun.proxy."
          };

          for (StackTraceElement st : ste)
          {
             boolean isStackParent = true;
             String stackParent = st.toString();
             for (String avoidPackage : ignoredPackages)
             {
                if (stackParent.startsWith(avoidPackage))
                {
                   isStackParent = false;
                   break;
                }
             }

             if (isStackParent)
             {
                return stackParent;
             }
          }
          return null;
       }
    }