001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.sql.framework.model;
042:
043: import java.util.List;
044:
045: /**
046: * This class defines joins on tables
047: *
048: * @author Ritesh Adval
049: * @version $Revision$
050: */
051: public interface SQLJoinOperator extends SQLConnectableObject,
052: SQLCanvasObject {
053:
054: public static final String ATTR_JOINCONDITION_TYPE = "joinConditionType";
055:
056: /** Attribute constant: join type */
057: public static final String ATTR_JOINTYPE = "type";
058:
059: /** Key constant: condition input */
060: public static final String CONDITION = "condition";
061:
062: /** extraction condition tag */
063: public static final String JOIN_CONDITION = "joinCondition";
064:
065: /** Key constant: left argument */
066: public static final String LEFT = "left";
067:
068: public static final int NO_CONDITION = 2;
069:
070: /** Key constant: right argument */
071: public static final String RIGHT = "right";
072:
073: public static final int SYSTEM_DEFINED_CONDITION = 0;
074:
075: public static final int USER_DEFINED_CONDITION = 1;
076:
077: /**
078: * get a list of all tables which are used in this join or any of its input join. This
079: * method recursively goes through LEFT and RIGHT inputs if they are join operator and
080: * finds out all the SourceTables
081: *
082: * @return list of all participating SourceTables for this join
083: */
084: public List<SourceTable> getAllSourceTables();
085:
086: /**
087: * get join condition
088: *
089: * @return join condition
090: */
091: public SQLCondition getJoinCondition();
092:
093: /**
094: * get the type for join condition it will be one of following
095: * SYSTEM_DEFINED_CONDITION USER_DEFINED_CONDITION NO_CONDITION
096: *
097: * @return join condition type
098: */
099: public int getJoinConditionType();
100:
101: /**
102: * Get type of join (inner, left outer, right outer, full outer)
103: *
104: * @return type of join.
105: * @see SQLConstants
106: */
107: public int getJoinType();
108:
109: /**
110: * method isRoot returns true if the root is set.
111: *
112: * @return boolean true if root is set.
113: */
114: public boolean isRoot();
115:
116: /**
117: * set the join condition
118: *
119: * @param condition join condition
120: */
121: public void setJoinCondition(SQLCondition condition);
122:
123: public void setJoinConditionType(int type);
124:
125: /**
126: * Sets the join type to the given value
127: *
128: * @param newType new join type
129: */
130: public void setJoinType(int newType);
131:
132: public String getJoinTypeString();
133:
134: public void setRoot(SQLJoinOperator rJoin);
135:
136: public void setJoinType(String joinType);
137:
138: }
|