/*
 * $Source: /usr/cvsroot/melati/maven-dsd-plugin/src/main/java/org/melati/poem/prepro/TableQualifier.java,v $
 * $Revision: 1.14 $
 *
 * Copyright (C) 2000 William Chesters
 *
 * Part of Melati (http://melati.org), a framework for the rapid
 * development of clean, maintainable web applications.
 *
 * Melati is free software; Permission is granted to copy, distribute
 * and/or modify this software under the terms either:
 *
 * a) the GNU General Public License as published by the Free Software
 *    Foundation; either version 2 of the License, or (at your option)
 *    any later version,
 *
 *    or
 *
 * b) any version of the Melati Software License, as published
 *    at http://melati.org
 *
 * You should have received a copy of the GNU General Public License and
 * the Melati Software License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
 * GNU General Public License and visit http://melati.org to obtain the
 * Melati Software License.
 *
 * Feel free to contact the Developers of Melati (http://melati.org),
 * if you would like to work out a different arrangement than the options
 * outlined here.  It is our intention to allow Melati to be used by as
 * wide an audience as possible.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * Contact details for copyright holder:
 *
 *     William Chesters <williamc@paneris.org>
 *     http://paneris.org/~williamc
 *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
 */

package org.melati.poem.prepro;

import java.io.StreamTokenizer;
import java.io.IOException;

/**
 * Abstract class from which all <tt>TableQualifier</TT>s are derived.
 *
 */
public abstract class TableQualifier {

 /**
  * Update the model.
  *
  * @param table the {@link TableDef} to update
  * @throws IllegalityException if there is a semantic error
  */
  public abstract void apply(TableDef table) throws IllegalityException;

 /**
  * Creates the appropriate type of <code>TableQualifier</code> 
  * from the input stream.
  *
  * @param tokens the <code>StreamTokenizer</code> to get tokens from
  *
  * @throws ParsingDSDException if an unexpected token is encountered
  * @throws IOException if something goes wrong with the file system
  * @return the required sub type 
  */
  public static TableQualifier from(StreamTokenizer tokens)
      throws ParsingDSDException, IOException {
    if (tokens.ttype != StreamTokenizer.TT_WORD)
      throw new ParsingDSDException("<table qualifier>", tokens);
    TableQualifier it;
    String kind = tokens.sval;
    tokens.nextToken();
    if (kind.equals("displayname"))
      it = new DisplayNameTableQualifier(tokens);
    else if (kind.equals("description"))
      it = new DescriptionTableQualifier(tokens);
    else if (kind.equals("cachelimit"))
      it = new CacheSizeTableQualifier(tokens);
    else if (kind.equals("seqcached"))
      it = new SeqCachedTableQualifier();
    else if (kind.equals("category"))
      it = new CategoryTableQualifier(tokens);
    else if (kind.equals("displayorder"))
      it = new DisplayOrderTableQualifier(tokens);
    else
      throw new ParsingDSDException("<table qualifier>", kind, tokens);
    return it;
  }
}
