/*
   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.named.NamedArray;

/**
   <P>Manage multiple Templates.  See </P>

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

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

      <P>Equal to <CODE><A HREF="~JD~ta(s,t[])~EJD~">TemplateArray</A>(null, a_template)</CODE></P>
    **/
   public TemplateArray(Template[] a_template)  {
      super(null, a_template);
   }

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

      <P>Equal to <CODE><A HREF="~JD~ta(s,t[])~EJD~">TemplateArray</A>(s_name, a_template)</CODE></P>
    **/
   public TemplateArray(String s_name, Template[] a_template)  {
      super(s_name, a_template);
   }

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

      <P>Equal to <CODE><A HREF="~JD~na#na(s,n[],b)~EJD~">NamedArray</A>(s_name, a_template, b_listNames)</CODE></P>
    **/
   public TemplateArray(String s_name, Template[] a_template, boolean b_listNames)  {
      super(s_name, a_template, b_listNames);
   }

   /**
      <P>Get the requested Template for direct manipulation.</P>

      <P>Equal to <CODE>(Template)<A HREF="~JD~na#getNamed(s)~EJD~">getNamed</A>(s_name)</CODE></P>

      @param  s_name  The name of the desired level.  Must equal the name of an existing Template contained in this TemplateArray.
    **/
   public Template getTemplate(String s_name)  {
      return (Template)getNamed(s_name);
   }

   /**
      <P>Get the requested Template for direct manipulation.</P>

      <P>Equal to <CODE>(Template)<A HREF="~JD~na#getNamed(i)~EJD~">getNamed</A>(int)</CODE></P>

      @param  i_dx  The array index of the Template object. Must be between 0 and [<A HREF="~JD~na~EJD~">NamedArray</A>.<A HREF="~JD~na~EJD~#getLength()">getCount</A> - 1], inclusive.
    **/
   public Template getTemplate(int i_dx)  {
      return (Template)getNamed(i_dx);
   }
}