001: /*
002: * The contents of this file are subject to the terms of the Common Development
003: * and Distribution License (the License). You may not use this file except in
004: * compliance with the License.
005: *
006: * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
007: * or http://www.netbeans.org/cddl.txt.
008: *
009: * When distributing Covered Code, include this CDDL Header Notice in each file
010: * and include the License file at http://www.netbeans.org/cddl.txt.
011: * If applicable, add the following below the CDDL Header, with the fields
012: * enclosed by brackets [] replaced by your own identifying information:
013: * "Portions Copyrighted [year] [name of copyright owner]"
014: *
015: * The Original Software is NetBeans. The Initial Developer of the Original
016: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
017: * Microsystems, Inc. All Rights Reserved.
018: */
019:
020: package org.netbeans.modules.soa.mapper.common.basicmapper.methoid;
021:
022: import org.netbeans.modules.soa.mapper.common.basicmapper.literal.ILiteralUpdater;
023: import org.netbeans.modules.soa.mapper.common.IMapperNode;
024:
025: /**
026: * <p>
027: *
028: * Title: A Methoid Field Node </p> <p>
029: *
030: * Description: Generic interface describe a methoid field node.
031: * FuncotidFieldNode is the base interface for all methoid field node to be
032: * added to the IMethoidNode. </p> <p>
033: *
034: * Copyright: Copyright (c) 2002 </p> <p>
035: *
036: * Company: </p>
037: *
038: * @author Un Seng Leong
039: * @created December 4, 2002
040: * @version 1.0
041: */
042: public interface IFieldNode extends IMapperNode {
043: /**
044: * The property name of the field node name changed.
045: */
046: public static final String NAME_CHANGED = "FieldNode.Name";
047:
048: /**
049: * The property name of the field node type changed.
050: */
051: public static final String TYPE_CHANGED = "FieldNode.Type";
052:
053: /**
054: * The property name of the field node tooltip changed.
055: */
056: public static final String TOOLTIP_CHANGED = "FieldNode.ToolTip";
057:
058: public static final String STYLE_CHANGED = "FieldNode.Style";
059:
060: public static final String FIELD_OBJECT_CHANGED = "FieldNode.ObjectChanged";
061:
062: public static final String STYLE_TYPE_NORMAL = "normal";
063: public static final String STYLE_TYPE_LITERAL = "literal";
064:
065: /**
066: * Return the name of this field.
067: *
068: * @return the name of this field.
069: */
070: public String getName();
071:
072: /**
073: * Set the name of this methoid field node.
074: *
075: * @param name the name of this methoid field node.
076: */
077: public void setName(String name);
078:
079: /**
080: * Return the type name of this field.
081: *
082: * @return the type name of this field.
083: */
084: public String getTypeName();
085:
086: /**
087: * Set the type of this methoid field node.
088: *
089: * @param type the type of this methoid field node.
090: */
091: public void setTypeName(String type);
092:
093: /**
094: * Return the popup tooltip text of this methoid field node.
095: *
096: * @return the popup tooltip text of this methoid field node.
097: */
098: public String getToolTipText();
099:
100: /**
101: * Set the tooptip text of this methoid field node.
102: *
103: * @param tooltip the tooptip text of this methoid field node.
104: */
105: public void setToolTipText(String tooltip);
106:
107: /**
108: * Return the field data in another object repersentation.
109: *
110: * @return the field data in another object repersentation.
111: */
112: public Object getFieldObject();
113:
114: public void setFieldObject(Object fieldObj);
115:
116: /**
117: * Return true if this field is an input field, false otherwise.
118: *
119: * @return true if this field is an input field, false otherwise.
120: */
121: public boolean isInput();
122:
123: /**
124: * Return true if this field is an output field, false otherwise.
125: *
126: * @return true if this field is an output field, false otherwise.
127: */
128: public boolean isOutput();
129:
130: /**
131: * Return the literal name of this methoid field node.
132: * The literal name is the display name of the methoid
133: * field node while the field node has an in-place literal.
134: */
135: public String getLiteralName();
136:
137: /**
138: * Returns whether this field node has an in-place literal.
139: * This represents an unlinked field node that is
140: * tied to literal expression.
141: */
142: public boolean hasInPlaceLiteral();
143:
144: /**
145: * Set the literal name of this methoid field node.
146: */
147: public void setLiteralName(String name);
148:
149: /**
150: * Set the literal name of this methoid field node.
151: * Override the innate literal updater with the specified one.
152: */
153: public void setLiteralName(String name,
154: ILiteralUpdater literalUpdater);
155: }
|