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: import org.netbeans.modules.sql.framework.ui.graph.IOperatorXmlInfo;
046:
047: import com.sun.sql.framework.exception.BaseException;
048:
049: /**
050: * Common interface for generic operator and predicate.
051: *
052: * @author Jonathan Giron
053: * @author Ahimanikya Satapathy
054: * @version $Revision$
055: */
056: public interface SQLOperator extends SQLConnectableObject {
057: public static final String ATTR_CUSTOM_OPERATOR = "customOperator";
058:
059: public static final String ATTR_CUSTOM_OPERATOR_NAME = "customOperatorName";
060: /* XML attribute: script ref */
061: public static final String ATTR_SCRIPTREF = "scriptRef";
062:
063: public Object getArgumentValue(String argName) throws BaseException;
064:
065: /**
066: * Returns name of the User specific operator.
067: *
068: * @return
069: */
070: public String getCustomOperatorName();
071:
072: /**
073: * Get the script of this operator.
074: *
075: * @return Return script of this operator.
076: */
077: public SQLOperatorDefinition getOperatorDefinition();
078:
079: /**
080: * Gets canonical operator type, e.g., "concat", "tolowercase", etc..
081: *
082: * @return canonical operator name
083: */
084: public String getOperatorType();
085:
086: public IOperatorXmlInfo getOperatorXmlInfo();
087:
088: /**
089: * Returns True if operator represents user specific operator else false.
090: *
091: * @return
092: */
093: public boolean isCustomOperator();
094:
095: /**
096: * Indicates whether open and close parentheses should be appended upon evaluation of
097: * this operator.
098: *
099: * @return true if parentheses are to be appended, false otherwise
100: */
101: public boolean isShowParenthesis();
102:
103: public void setArgument(String argName, Object val)
104: throws BaseException;
105:
106: public void setArguments(List args) throws BaseException;
107:
108: /**
109: * Sets whether this object represents user specific operator.
110: * @param customOperator
111: */
112: public void setCustomOperator(boolean customOperator);
113:
114: /**
115: * Sets the name of this user specific operator. Which is also used to evaluate.
116: * @param customOperatorName
117: */
118: public void setCustomOperatorName(String customOperatorName);
119:
120: public void setDbSpecificOperator(String dbName)
121: throws BaseException;
122:
123: /**
124: * sets canonical operator type, e.g., "concat", "tolowercase", etc..
125: *
126: * @param opName canonical operator name
127: * @throws com.sun.sql.framework.exception.BaseException
128: */
129: public void setOperatorType(String opName) throws BaseException;
130:
131: public void setOperatorXmlInfo(IOperatorXmlInfo opInfo)
132: throws BaseException;
133:
134: /**
135: * Sets whether parentheses needs to be appended upon evaluation of this operator.
136: *
137: * @param show true if parentheses are to be appended, false otherwise
138: */
139: public void setShowParenthesis(boolean show);
140: }
|