/*
   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.util.ForLineRetrieval;



/**
   <P>A Template that has a specific set of unique gaps.</P>

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

   <P>When you require that the Template has a specific set of unique gaps in it, use this to enforce it.  This also allows <A HREF="TemplateFiller.html">TemplateFiller</A> to "consider" these unique gaps in a certain order, even if they happen to be in a completely different order in the template text file.</P>

   <P>See TemplateFiller.<A HREF="~JD~tf#fill(s,tog,s[])~EJD~">fill</A>.</P>

   <P>What does this "ordering" buy you?  Let's say you have this template:</P>

<p class="highlightgrey"><CODE>String sTemplate = Hello \~G\~name\~EG\~.  Here is the  \~G\~link\~EG\~ to that website you mentioned.</CODE></P>

   <P>and this sub-template:</P>

<p class="highlightgrey"><CODE>String sSublink = &lt;A HREF=&quot;\~G\~link_url\~EG\~&quot;&gt;\~G\~link_text\~EG\~&lt;/a&gt;</CODE></P>

   <P>Normally, you'd fill this template with the following code:</P>

<p class="highlightgrey"><CODE>Template t = new Template(new FLRString(sTemplate));
<BR>Template tSubLink = new Template(new FLRString(sSublink));
<BR>
<BR>TemplateFiller tf = new TemplateFiller();
<BR>tf.setTemplate(t);
<BR>tf.fill(&quot;name&quot;, &quot;YOUR_NAME_HERE&quot;);
<BR>
<BR>TemplateFiller tfSub = new TemplateFiller();
<BR>tf.setTemplate(tSubLink);
<BR>tfSub.fill(&quot;link_url&quot;, &quot;http://sourceforge.net/projects/xbnjava&quot;);
<BR>tfSub.fill(&quot;link_text&quot;, &quot;way cool link&quot;);
<BR>
<BR>tf.fill(&quot;link&quot;, tfSub.getResult());
<BR>
<BR>String sResult = tf.getResult();</CODE></P>

<P>Where sResult equals</P>

<p class="highlightgrey"><CODE>Hello YOUR_NAME_HERE.  Here is the &lt;A HREF=&quot;http://sourceforge.net/projects/xbnjava&quot;&gt;way cool link&lt;/a&gt; to that website you mentioned.</CODE></P>

<P>Using this class, TemplateOrderedGaps, the code is a more concise:</P>

<p class="highlightgrey"><CODE>Template t = new Template(new FLRString(sTemplate));
<BR>TOGTwo tog2Link = new TOGTwo((new FLRString(sSublink)), "link_url", "link_text");
<BR>
<BR>TemplateFiller tf = new TemplateFiller();
<BR>tf.setTemplate(t);
<BR>tf.fill(&quot;name&quot;, &quot;YOUR_NAME_HERE&quot;);
<BR>tf.fill(&quot;link&quot;, tog2Link, &quot;http://sourceforge.net/projects/xbnjava&quot;, &quot;way cool link&quot;);
<BR>
<BR>String sResult = tf.getResult();</CODE></P>


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

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

      <P>Equal to <CODE><A HREF="~JD~tog(s,flr,ogc)~EJD~">TemplateOrderedGaps</A>(null, flr_srcTxt, og_config)</CODE></P>
    **/
   public TemplateOrderedGaps(ForLineRetrieval flr_srcTxt, OGConfig og_config) throws TemplateFormatException  {
      this(null, flr_srcTxt, og_config);
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog(s,flr,ogc,tpc)~EJD~">TemplateOrderedGaps</A>(null, flr_srcTxt, og_config, tp_config)</CODE></P>
    **/
   public TemplateOrderedGaps(ForLineRetrieval flr_srcTxt, OGConfig og_config, TParseConfig tp_config) throws TemplateFormatException  {
      this(null, flr_srcTxt, og_config, tp_config);
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog(s,flr,ogc,tpc)~EJD~">TemplateOrderedGaps</A>(s_name, flr_srcTxt, og_config, (new <A HREF="~JD~tpc#tpc()~EJD~">TParseConfig</A>()))</CODE></P>
    **/
   public TemplateOrderedGaps(String s_name, ForLineRetrieval flr_srcTxt, OGConfig og_config) throws TemplateFormatException  {
      this(s_name, flr_srcTxt, og_config, (new TParseConfig()));
   }

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

      <P>Equal to <A HREF="~JD~t#t(s,flr,tpc,tfltr)~EJD~">Template</A>(s_name, flr_srcTxt, tp_config, og_config)</P>

      <P>The only difference between this constructor and the super version, is that og_config (the TFilter) may not be null</P>
    **/
   public TemplateOrderedGaps(String s_name, ForLineRetrieval flr_srcTxt, OGConfig og_config, TParseConfig tp_config) throws TemplateFormatException  {
      super(s_name, flr_srcTxt, tp_config, og_config);
      throwAXIfNull(og_config, "og_config", sCNSTR);
   }

   /**
      <P>Create a full copy of the provided TemplateOrderedGaps.</P>

      <P>Equal to <CODE><A HREF="~JD~t#t(t)~EJD~">Template</A>(t_rdrdGaps)</CODE></P>
    **/
   public TemplateOrderedGaps(TemplateOrderedGaps t_rdrdGaps)  {
      super(t_rdrdGaps);
   }

   /**
      <P>Get the OGConfig for direct manipulation.</P>

      @return  <CODE>(<A HREF="~JD~ogc~EJD~">OGConfig</A>)<A HREF="~JD~t~EJD~#getTFilter()">getTFilter</A>()</CODE>
    **/
   public final OGConfig getOGConfig()  {
      return (OGConfig)getTFilter();
   }
}