/*
   XBN Java:  Generically useful, non-GUI Java code.
   http://sourceforge.net/projects/xbnjava

   Copyright (C) 1997-2003, Jeff Epstein
   All rights reserved.

   Modifications: No

   Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:

      * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
      * If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.
      * Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

   [NOTE:  This license contains NO advertising clause.]
 */
package xbn.template;
   import xbn.XBNObject;
      import xbn.array.APString;
      import xbn.array.AOSLookup;
      import xbn.array.AOSLHashtable;
      import xbn.array.CACExact;
      import xbn.array.CompareArrays;
      import xbn.array.UtilArray;
      import xbn.array.primitive.PASString;
      import xbn.array.primitive.PARSStrict;

/**
   <P>The configuration for a TemplateOrderedGaps.  See <A HREF="TemplateOrderedGaps.html">TemplateOrderedGaps</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/template/OGConfig.java">OGConfig.java</A>.</I></CODE></P>

   <P>Specifically, this is used as a TFilter, to enforce which gap names exist in a <A HREF="~JD~t~EJD~">Template</A>.</P>

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public class OGConfig extends XBNObject implements TFilter  {

   private APString aps = null;
   private AOSLookup aosl = null;
   private boolean bDupGapsAllowed = false;

   /**
      <P>Create a TemplateOrderedGaps.</P>

      <P>Equal to <CODE><A HREF="~JD~ogc#ogc(s[],i)~EJD~">OGConfig</A>(ms_rdrdGaps, -1)</CODE></P>
    **/
   public OGConfig(String[] as_uniqueGapNames)  {
      this(as_uniqueGapNames, -1);
   }

   /**
      <P>Create a TemplateOrderedGaps.</P>

      <P>Equal to <CODE><A HREF="~JD~ogc#ogc(s[],i,b)~EJD~">OGConfig</A>(ms_rdrdGaps, i_rqdUnqGapCount, true)</CODE></P>
    **/
   public OGConfig(String[] as_uniqueGapNames, int i_rqdUnqGapCount)  {
      this(as_uniqueGapNames, i_rqdUnqGapCount, true);
   }

   /**
      <P>Create a TemplateOrderedGaps.</P>

      <P>Equal to <CODE><A HREF="~JD~ogc#ogc(s[],i,b)~EJD~">OGConfig</A>(ms_rdrdGaps, -1, b_dupGapsAllowed)</CODE></P>
    **/
   public OGConfig(String[] as_uniqueGapNames, boolean b_dupGapsAllowed)  {
      this(as_uniqueGapNames, -1, b_dupGapsAllowed);
   }

   /**
      <P>Create a TemplateOrderedGaps.</P>

      @param  as_uniqueGapNames  The list of unique gap names expected to exist in the <A HREF="~JD~t~EJD~">Template</A>.  May not be null.
      @param  i_rqdUnqGapCount  The number of gaps expected to be in as_uniqueGapNames.  If you don't care how many gaps are in as_uniqueGapNames, set this to -1.  Otherwise, this must be greater than zero.
      @param  b_dupGapsAllowed  If true, then each unique gap may be duplicated any number of times.  If false, then each unique gap must only exist once.
    **/
   public OGConfig(String[] as_uniqueGapNames, int i_rqdUnqGapCount, boolean b_dupGapsAllowed)  {
      PARSStrict parss = (new PARSStrict());
      PASString pass = new PASString(as_uniqueGapNames, parss);
      pass.crashIfBad("xbn.template.OGConfig.constructor", "as_uniqueGapNames");

      aosl = (new UtilArray()).getAOSLFromAOS(as_uniqueGapNames, true);
      aps = new APString(as_uniqueGapNames, true);

      if(i_rqdUnqGapCount == 0  ||  i_rqdUnqGapCount < -1)  {
         throwAX("constructor:  i_rqdUnqGapCount must equal -1, or be greater than or equal to one.  When -1, the length of as_uniqueGapNames does not matter..");
      }

      if(i_rqdUnqGapCount != -1  &&
         	as_uniqueGapNames.length != i_rqdUnqGapCount)  {
         throwAX("constructor:  i_rqdUnqGapCount does not equal -1, but as_uniqueGapNames.length does not equal i_rqdUnqGapCount.  Currently, i_rqdUnqGapCount=" + i_rqdUnqGapCount + " and as_uniqueGapNames.length=" + as_uniqueGapNames.length + ".");
      }

      bDupGapsAllowed = b_dupGapsAllowed;
   }


   /**
      <P>Are duplicate gaps allowed?</P>

      @return  <B>b_dupGapsAllowed</B>, exactly as provided in the <A HREF="~JD~ogc#ogc(s[],i,b)~EJD~">constructor</A>.
    **/
   public boolean areDupGapsAllowed()  {
      return bDupGapsAllowed;
   }

   /**
      <P>Get the AOSLookup for direct manipulation.</P>
    **/
   public final AOSLookup getAOSLookup()  {
      return aosl;
   }

   public final AOSLHashtable getAOSLHashtable()  {
      return getAOSLookup().getAOSLHashtable();
   }

   public final APString getAPString()  {
      return aps;
   }

   /**
      <P>Get the string existing at the requested array index.</P>

      @param  i_dx  The requested array index.
    **/
   public String getString(int i_dx)  {
      return getAPString().getString(i_dx);
   }

   /**
      <P>Get the array index at which the provided string exists.</P>

      @return <CODE><A HREF="#getAOSLHashtable()">getAOSLHashtable</A>().<A HREF="~JD~aoslh#getUniqueString(s)~EJD~">getUniqueString</A>(s_tr).<A HREF="~JD~unqs~EJD~#getUnqArrIdx()">getUnqArrIdx</A>()</CODE>
    **/
   public int getArrIdx(String s_tr)  {
      return getAOSLHashtable().getUniqueString(s_tr).getUnqArrIdx();
   }

   /**
      <P>How many strings exist in the string array?</P>
    **/
   public int getLength()  {
      return getAPString().getLength();
   }

   /**
      <P>Is the provided Template legal?</P>

      @param  t_emplate  The Template to analyze.  May not be null.
      @return  <B>true</B><UL>
         <LI>If t_emplate has exactly the same unique gaps as those in this OGConfig (ordering does not matter) <I>and</I> t_emplate.<A HREF="~JD~t~EJD~#getUSAPAbsolute()">getUSAPAbsolute</A>().<A HREF="~JD~ap~EJD~#getLength()">getLength</A>() equals t_emplate.<a href="~JD~t~EJD~#getUSAPAbsolute()">getUSAPUnique</a>().<A HREF="~JD~ap~EJD~#getLength()">getLength</A>().</LI>
         <LI>If t_emplate has exactly the same unique gaps as those in this OGConfig  and <A HREF="#areDupGapsAllowed()">areDupGapsAllowed</A> equals true, and t_emplate.getAbsoluteGapCount does not equal t_emplate.getUniqueGapCount.</LI>
      </UL>
      <BR><B>false</B><UL>
         <LI>If t_emplate has a different set of unique gaps as exists in this OGConfig.</LI>
         <LI>If t_emplate has the exactly the same set of unique gaps, but areDupGapsAllowed is false, and t_emplate.getAbsoluteGapCount does not equal t_emplate.getUniqueGapCount.</LI>
      </UL>
    **/
   public boolean isTemplateValid(Template t_emplate)  {
      throwAXIfNull(t_emplate, "t_emplate", "isTemplateValid");

      CompareArrays ca = new CompareArrays(new CACExact());
      ca.setAssumePAsValid(true);

      boolean b = ca.hasRqdValues(t_emplate.getUSAPUnique().getUniqueStringPAS(), getAPString().getPASString());

      if(!b)  {
         return false;
      }
      //The template has exactly correct set of gap names.

      if(areDupGapsAllowed())  {
         //There may or may not be duplicate gaps.  Either
         //way, it's legal.
         return true;
      }
      //Duplicate gaps are not allowed.

      //If the absolute gap count is not equal to the unique gap
      //count, return false.  Otherwise, return true.
      return (t_emplate.getUSAPAbsolute().getLength() == t_emplate.getUSAPUnique().getLength());
   }

   /**
      <P>Get some information about this OGConfig.</P>
    **/
   public String toString()  {
      return super.toString() + ", areDupGapsAllowed()=" + areDupGapsAllowed() + ", getAPString().getPASString()=['" + getAPString().getPASString().getList("', '") + "']";
   }
}