/*
   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.array.primitive;
   import xbn.XBNObject;
   import xbn.array.AOSLHashtable;
   import xbn.array.APString;
   import xbn.util.RCLength;
   import xbn.util.Utility;

   import java.util.Hashtable;

/**
   <P>Part of PARString configuring element-related items.  See <A HREF="~JD~pars~EJD~">PARString</A>.</P>

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

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public class PARSElement extends XBNObject implements Cloneable  {
   private boolean bLmntNullOk = false;
   private RCLength rclLmnt = null;

   private String[] asIllegal = null;
   private AOSLHashtable aoslh = null;
   private APString apsIllegal = null;



   /**
      <P>Create an unrestricted PARSElement.</P>

      <P>Equal to <CODE><A HREF="~JD~parse(b)~EJD~">PARSElement</A>(true)</CODE></P>
    **/
   public PARSElement()  {
      this(true);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parse(b,rcl)~EJD~">PARSElement</A>(b_lmntNullOk, (new <A HREF="~JD~rcl#rcl()~EJD~">RCLength</A>()))</CODE></P>
    **/
   public PARSElement(boolean b_lmntNullOk)  {
      this(b_lmntNullOk, (new RCLength()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~parse(b,rcl)~EJD~">PARSElement</A>(true, rcl_lmntLength)</CODE></P>
    **/
   public PARSElement(RCLength rcl_lmntLength)  {
      this(true, rcl_lmntLength);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parse(b,s[])~EJD~">PARSElement</A>(true, as_illegal)</CODE></P>
    **/
   public PARSElement(String[] as_illegal)  {
      this(true, as_illegal);
   }

   /**
      <P>Create a PARSElement with the element-null setting and RCLength.</P>

      <P>Equal to <CODE><A HREF="~JD~parse(b,rcl,s[])~EJD~">PARSElement</A>(b_lmntNullOk, rcl_lmntLength, (new <A HREF="~JD~s~EJD~">String</A>[] {}))</CODE></P>
    **/
   public PARSElement(boolean b_lmntNullOk, RCLength rcl_lmntLength)  {
      this(b_lmntNullOk, rcl_lmntLength, (new String[] {}));
   }

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

      <P>Equal to <CODE><A HREF="~JD~parse(b,rcl,s[])~EJD~">PARSElement</A>(b_lmntNullOk, (new <A HREF="~JD~rcl#rcl()~EJD~">RCLength</A>()), as_illegal)</CODE></P>
    **/
   public PARSElement(boolean b_lmntNullOk, String[] as_illegal)  {
      this(b_lmntNullOk, (new RCLength()), as_illegal);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parse(b,rcl,s[])~EJD~">PARSElement</A>(true, rcl_lmntLength, as_illegal)</CODE></P>
    **/
   public PARSElement(RCLength rcl_lmntLength, String[] as_illegal)  {
      this(true, rcl_lmntLength, as_illegal);
   }
   /**
      <P>Create a PARSElement.</P>

      @param  b_lmntNullOk  If true, then any element in the PrimitiveArrayString may be null.  If false, then no element may be null.
      @param  rcl_lmntLength  The range that each element's length must conform to.  May not be null.
      @param  as_illegal  The array of strings that no element may be equal to.  May not be null.  If zero elements in length, then no strings are considered illegal.  If at least one element in length, then each element's length must be legal according to rcl_lmntLength.<A HREF="~JD~rc#isValid(i)~EJD~">isValid</A>.  Duplicate strings in this array are ignored.
    **/
   public PARSElement(boolean b_lmntNullOk, RCLength rcl_lmntLength, String[] as_illegal)  {
      throwAXIfNull(rcl_lmntLength, "rcl_lmntLength", sCNSTR);
      throwAXIfNull(as_illegal, "as_illegal", sCNSTR);

      //This is optimized only if as_illegal contains no duplicates.
      Hashtable ht = new Hashtable(as_illegal.length, 1);

      if(as_illegal.length > 0)  {
         for(int i = 0; i < as_illegal.length; i++)  {
            if(as_illegal[i] == null  ||  as_illegal[i].length() < 1)  {
               throwAX("constructor:  as_illegal[" + i + "] ('" + as_illegal[i] + "') must be non-null, and at least one character in length.");
            }

            if(!rcl_lmntLength.isValid(as_illegal[i].length()))  {
               throwAX("constructor:  as_illegal[" + i + "] ('" + as_illegal[i] + "') has an illegal length:  [" + rcl_lmntLength.toString() + "].");
            }

            if(!ht.containsKey(as_illegal[i]))  {
               ht.put(as_illegal[i], (new Integer(i)));
            }
         }

         if(ht.size() != as_illegal.length)  {
            //There are duplicates in as_illegal.  Re-optimize the Hashtable.
            ht = (new Utility()).getOptimizedHT(ht);
         }
         aoslh = new AOSLHashtable(ht, bFALSE_IN_PRODUCTION);

      }  else  {
         aoslh = null;
      }


      bLmntNullOk = b_lmntNullOk;
      rclLmnt = rcl_lmntLength;

      asIllegal = as_illegal;
      apsIllegal = new APString(as_illegal);
   }


   /**
      <P>Is a character defined as illegal, should it be found in the char array?</P>

      @return  <B>b_lmntNullOk</B>  Exactly as provided to the <A HREF="~JD~parse(b,rcl,s[])~EJD~">constructor</A>.
    **/
   public final boolean isNullLmntOk()  {
      return bLmntNullOk;
   }

   /**
      <P>What character is defined as illegal, should it be found in the char array?</P>

      @return  <B>rcl_lmntLength</B>  Exactly as provided to the <A HREF="~JD~parse(b,rcl,s[])~EJD~">constructor</A>.
    **/
   public final RCLength getRCLength()  {
      return rclLmnt;
   }

   /**
      <P>Get the AOSLHashtable containing the strings considered illegal.</P>

      @return  An AOSLHashtable containing only those strings in as_illegal (as provided to the <A HREF="~JD~parse(b,rcl,s[])~EJD~">constructor</A>) that are unique.  If as_illegal.length() was zero, then this function will return null.
    **/
   public final AOSLHashtable getAOSLHIllegal()  {
      return aoslh;
   }

   /**
      <P>Is the provided string illegal?</P>

      @param  s_tr  The string to determine illegality of.  May not be null.
      @return  <B>false</B> if <A HREF="#getAOSLHIllegal()">getAOSLHIllegal</A> is null.
      <BR><CODE><A HREF="#getAOSLHIllegal()">getAOSLHIllegal</A>().<A HREF="~JD~aoslh#containsKey(s)~EJD~">containsKey</A>(s_tr)</CODE>  If otherwise.
    **/
   public boolean isIllegal(String s_tr)  {
      if(getAOSLHIllegal() == null)  {
         return false;
      }
      //There is at least one illegal string.

      return getAOSLHIllegal().containsKey(s_tr);
   }

   /**
      <P>Are there strings considered illegal?</P>

      @return  <CODE>(<A HREF="#getAPSIllegal()">getAPSIllegal</A>().<A HREF="~JD~aps~EJD~#getLength()">getLength</A>() &gt; 0)</CODE>
    **/
   public final boolean hasIllegalStrings()  {
      return (getAPSIllegal().getLength() > 0);
   }

   /**
      <P>Get the array of strings considered illegal, as an APString.</P>

      @return  <CODE>(new <A HREF="~JD~aps#aps(s[])~EJD~">APString</A>(as_illegal))</CODE>  Where ai_illegal is exactly as provided to the <A HREF="~JD~parse(b,rcl,s[])~EJD~">constructor</A>.  Note this object is only created once.
    **/
   public final APString getAPSIllegal()  {
      return apsIllegal;
   }



   /**
      <P>Does this PARSEIllegal have <I>any</I> restrictions?</P>

      @return  <CODE>(!<A HREF="#isNullLmntOk()">isNullLmntOk</A>()  ||  <A HREF="#getRCLength()">getRCLength</A>().<A HREF="~JD~rcl~EJD~#isRestricted()">isRestricted</A>()  ||  <A HREF="#hasIllegalStrings()">hasIllegalStrings</A>())</CODE>
    **/
   public boolean isRestricted()  {
      return (!isNullLmntOk()  ||  getRCLength().isRestricted()  ||  hasIllegalStrings());
   }

   /**
      <P>Get some information about this PARSEIllegal.</P>
    **/
   public String toString()  {
      return this.getClass().getName() + ":  isNullLmntOk()=" + isNullLmntOk() + ", [" + getRCLength().toString() + "], getAPSIllegal()=[" + getAPSIllegal().toString() + "]";
   }


   //Cloning...START
      /**
         <P>Get a full (deep) copy of this PARSElement.</P>

         @return  <CODE>(PARSElement)<A HREF="#clone()">clone</A>()</CODE>
       **/
      public final PARSElement getPARSEClone()  {
         try  {
            return (PARSElement)clone();
         }  catch(CloneNotSupportedException cnsx)  {
            throwAX("getPARSEClone [SHOULD NEVER HAPPEN!]:  " + cnsx.toString());
         }

         //Never reached.  Required for compile.
         return null;
      }

      /**
         <P>Get a full (deep) copy of this PARSElement as an Object.</P>
       **/
      protected final Object clone() throws CloneNotSupportedException  {
         return new PARSElement(bLmntNullOk, rclLmnt, asIllegal, aoslh, apsIllegal);
      }

      private PARSElement(boolean b_lmntNullOk, RCLength rcl_lmntLength, String[] as_illegal, AOSLHashtable aosl_hashtable, APString aps_illegal)  {
         bLmntNullOk = b_lmntNullOk;
         rclLmnt = rcl_lmntLength;
         asIllegal = as_illegal;
         aoslh = aosl_hashtable.getAOSLHClone();
         apsIllegal = aps_illegal.getAPSClone();
      }
   //Cloning...END
}