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.ui.graph;
042:
043: import java.util.List;
044:
045: import com.sun.sql.framework.exception.BaseException;
046:
047: /**
048: * @author Ritesh Adval
049: * @version $Revision$
050: */
051: public interface IOperatorField {
052:
053: /**
054: * Gets the name of the field.
055: */
056: public String getName();
057:
058: /**
059: * Sets the name of the field.
060: *
061: * @param name
062: */
063: public void setName(String name);
064:
065: /**
066: * Gets display name of the field.
067: *
068: * @return display name
069: */
070: public String getDisplayName();
071:
072: /**
073: * Sets display name of the field.
074: *
075: * @param displayName
076: */
077: public void setDisplayName(String displayName);
078:
079: /**
080: * Gets the value of the attribute.
081: *
082: * @param attrName name of the attribute
083: * @return value of the attribute
084: */
085: public Object getAttributeValue(String attrName);
086:
087: /**
088: * Sets an attributes value.
089: *
090: * @param attrName attribute name
091: * @param val attribute value
092: */
093: public void setAttributeValue(String attrName, Object val);
094:
095: /**
096: * Sets the tool tip.
097: *
098: * @param toolTip toolTip
099: */
100: public void setToolTip(String toolTip);
101:
102: /**
103: * Gets the tool tip.
104: *
105: * @return toolTip
106: */
107: public String getToolTip();
108:
109: /**
110: * Sets whether this is editable.
111: *
112: * @param editable if field is editable
113: */
114: public void setEditable(boolean editable);
115:
116: /**
117: * Indicates whether field is editable.
118: *
119: * @return true if this field is editable, false if field can only have columns or
120: * expressions linked to it
121: */
122: public boolean isEditable();
123:
124: /**
125: * set the field data object
126: */
127: public void setFieldDataObject(Object dObj);
128:
129: /**
130: * get the field data object
131: *
132: * @return
133: */
134: public Object getFieldDataObject();
135:
136: /**
137: * Sets whether this field is static, i.e., it is not linkable and accepts only from a
138: * finite range or set of values.
139: *
140: * @param editable if field is editable
141: */
142: public void setStatic(boolean staticFlag);
143:
144: /**
145: * Indicates whether field is static (not linkable and accepting only from a finite
146: * range or set of values).
147: *
148: * @return true if this field is static, false otherwise
149: */
150: public boolean isStatic();
151:
152: /**
153: * If this field is static, gets List representing acceptable String values, or
154: * Collections.EMPTY_LIST if it is not.
155: *
156: * @return List of acceptable values, possibly Collections.EMPTY_LIST if any value is
157: * valid, or if this field is not editable
158: */
159: public List getAcceptableValues();
160:
161: /**
162: * Sets List representing acceptable String values for this field. If acceptableValues
163: * is null, both getAcceptableValues() and getAcceptableDisplayValues() will return
164: * Collections.EMPTY_LIST.
165: *
166: * @param acceptableValues List of new acceptable String values.
167: */
168: public void setAcceptableValues(List acceptableValues);
169:
170: /**
171: * If this field is static, gets List representing human-readable versions of
172: * acceptable String values, in the same order as the elements returned by
173: * getAcceptableValues().
174: *
175: * @return List of acceptables display values; may be identical to
176: * getAcceptableValues() if no values were set via
177: * setAcceptableDisplayValues();
178: */
179: public List getAcceptableDisplayValues();
180:
181: /**
182: * Sets List representing human-readable versions of acceptable String values for this
183: * field, in the same order as elements returned by getAcceptableValues(). It is the
184: * caller's responsibility to ensure that display values are ordered in the same
185: * sequence as their corresponding acceptable values. If <code>displayValues</code>
186: * is null or empty, getAcceptableDisplayValues() will return
187: *
188: * @param acceptableValues List of new acceptable String values. May be null or empty
189: * to indicate that acceptable values are also displayable, otherwise its size
190: * must match the current size of the list of acceptable values.
191: */
192: public void setAcceptableDisplayValues(List displayValues);
193:
194: /**
195: * Gets default acceptable value for this field. This method only yields meaningful
196: * values if this operator field is a static parameter, i.e., isStatic() returns true.
197: *
198: * @return default acceptable value, if any, for this field.
199: */
200: public String getDefaultValue();
201:
202: /**
203: * Sets default acceptable value for this field. This method is useful only if this
204: * operator operator field is a static parameter, i.e., isStatic() returns true.
205: *
206: * @param newDefault new default value
207: * @throws BaseException if given default is not one of the acceptable values given by
208: * {@link getAcceptableValues()};
209: */
210: public void setDefaultValue(String newDefault) throws BaseException;
211: }
|