/*
   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.jdlcode;
   import xbn.named.NamedArray;
   import xbn.array.VWString;
   import xbn.array.primitive.ListPA;

/**
   <P>Manage a set of unique PackageTypes.  See <A HREF="~JD~pt~EJD~">PackageType</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/jdlcode/PTArray.java">PTArray.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 PTArray extends NamedArray  {
   /**
      <P>Create a PTArray.</P>

      @param  a_packageType  The array of PackageTypes.  Must be valid according to the <A HREF="~JD~na#na(n[])~EJD~">super constructor</A>, and must contain at least one PackageType that is <A HREF="~JD~pt~EJD~#isLocal()">local</A>.
    **/
   public PTArray(PackageType[] a_packageType)  {
      super(a_packageType);

      boolean bLocal = false;
      for(int i = 0; i < getLength()  &&  !bLocal; i++)  {
         bLocal = isLocal(i);
      }

      if(!bLocal)  {
         throwAX("constructor:  At least one element in a_packageType must be local (meaning isLocal() equals true).  All elements are currently external or primitive.");
      }
   }

   /**
      <P>Get the PackageType for the requested prefix.</P>

      @param  s_prefix  The prefix of the requested PackageType.  May not be null or zero characters in length.  If <CODE><A HREF="~JD~na#doesExist(s)~EJD~">doesExist</A>(s_prefix)</CODE> equals false, then this prefix is considered primitive, and must contain only lowercase letters.
      @return  <B>The PackageType that has a prefix of s_prefix</B>  if <CODE>doesExist(s_prefix)</CODE> equals true.
      <BR><B>null</B>  if <CODE>doesExist(s_prefix)</CODE> equals false.
    **/
   public final PackageType getPackageType(String s_prefix)  {
      if(doesExist(s_prefix))  {
         return (PackageType)getNamed(s_prefix);
      }
      //The prefix doesn't exist.  It must be primitive.

      for(int i = 0; i < s_prefix.length(); i++)  {
         if(s_prefix.charAt(i) < 'a'  ||  s_prefix.charAt(i) > 'z')  {
            throwAX("getPackageType:  s_prefix ('" + s_prefix + "') is not equal to any existing prefix, but contains characters other than a-z (lowercase), meaning it is also not of primitive type.");
         }
      }

      //It is primitive.
      return null;
   }

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

      @return  <CODE>(<A HREF="~JD~pt~EJD~">PackageType</A>)<A HREF="~JD~na#getNamed(i)~EJD~">getNamed</A>(i_dx)</CODE>
    **/
   public PackageType getPackageType(int i_dx)  {
      return (PackageType)getNamed(i_dx);
   }

   /**
      <P>Is the PackageType having the requested prefix local?</P>

      @return  <CODE><A HREF="~JD~getPackageType(s)~EJD~">getPackageType</A>(s_prefix).<A HREF="~JD~pt~EJD~#isLocal()">isLocal</A>()</CODE>
    **/
   public final boolean isLocal(String s_prefix)  {
      return getPackageType(s_prefix).isLocal();
   }

   /**
      <P>Is the PackageType at the requested array index local?</P>

      @return  <CODE><A HREF="#getPackageType(int)">getPackageType</A>(i_dx).<A HREF="~JD~pt~EJD~#isLocal()">isLocal</A>()</CODE>
    **/
   public boolean isLocal(int i_dx)  {
      return getPackageType(i_dx).isLocal();
   }

   /**
      <P>Is the PackageType having the requested prefix external?</P>

      @return  <CODE><A HREF="~JD~getPackageType(s)~EJD~">getPackageType</A>(s_prefix).<A HREF="~JD~pt~EJD~#isExternal()">isExternal</A>()</CODE>
    **/
   public boolean isExternal(String s_prefix)  {
      return getPackageType(s_prefix).isExternal();
   }

   /**
      <P>Is the PackageType at the requested array index external?</P>

      @return  <CODE><A HREF="#getPackageType(int)">getPackageType</A>(i_dx).<A HREF="~JD~pt~EJD~#isExternal()">isExternal</A>()</CODE>
    **/
   public boolean isExternal(int i_dx)  {
      return getPackageType(i_dx).isExternal();
   }

   /**
      <P>Get the external url for the requested prefix.</P>

      @return  <CODE><A HREF="~JD~getPackageType(s)~EJD~">getPackageType</A>(s_prefix).<A HREF="~JD~pt~EJD~#getExternalUrl()">getExternalUrl</A>()</CODE>
    **/
   public String getExternalUrl(String s_prefix)  {
      return getPackageType(s_prefix).getExternalUrl();
   }

   /**
      <P>Get the external url for the requested array index.</P>

      @return  <CODE><A HREF="#getPackageType(int)">getPackageType</A>(i_dx).<A HREF="~JD~pt~EJD~#getExternalUrl()">getExternalUrl</A>()</CODE>
    **/
   public String getExternalUrl(int i_dx)  {
      return getPackageType(i_dx).getExternalUrl();
   }

   String getNotFoundPrefixList()  {
      VWString vws = null;
      for(int i = 0; i < getLength(); i++)  {
         if(!getPackageType(i).isFound())  {
            if(vws == null)  {
               vws = new VWString();
            }

            vws.add(getPackageType(i).getPrefix());
         }
      }

      if(vws == null)  {
         return null;
      }

      return (new ListPA("'", "', '", "'")).get(vws.getAOString());
   }
}