001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.ecoinformatics.seek.querybuilder;
031
032/**
033 * @author Rod SPears
034 * 
035 *         TODO To change the template for this generated type comment go to
036 *         Window - Preferences - Java - Code Generation - Code and Comments
037 */
038public interface QBBuilderInterface {
039        public static final int STANDARD = 0;
040        public static final int INTERMEDIATE = 1;
041        public static final int ADVANCED = 2;
042
043        /**
044         * 
045         * @return returns the "type" of builder it is as defined by the constants
046         *         in this interface
047         */
048        public int getType();
049
050        /**
051         * A textual name for this builder
052         * 
053         * @return string of the name
054         */
055        public String getName();
056
057        /**
058         * This checks to see if this type of builder can convert the internal SQL
059         * to a more complex or less complex form.
060         * 
061         * This is typically called when switching from a more complex builder to a
062         * less complex builder
063         * 
064         * @param aBldr
065         *            The "receiving" builder, in other words can this builder
066         *            convert the SQL to the new builder
067         * @return true if it can convert it, false if it can not
068         */
069        public boolean canConvertTo(QBBuilderInterface aBldr);
070
071        /**
072         * 
073         * @return Returns a string representing the interal SQL Query
074         */
075        public String createSQL();
076
077        /**
078         * Build UI from the Query Definition Object
079         */
080        public int buildFromQueryDef(DBQueryDef aQueryDef);
081
082        /**
083         * Fill the QueryDef from the Model
084         * 
085         * @param aQueryDef
086         *            the query
087         */
088        public void fillQueryDef(DBQueryDef aQueryDef);
089
090}