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:
042: package org.netbeans.modules.uml.core.reverseengineering.reframework.parsingframework;
043:
044: import java.util.List;
045: import org.dom4j.Node;
046: import org.netbeans.modules.uml.core.generativeframework.IExpansionVariable;
047: import org.netbeans.modules.uml.core.support.umlsupport.IStrings;
048: import org.netbeans.modules.uml.core.support.umlutils.ETList;
049:
050: /**
051: * <p>Title: </p>
052: * <p>Description: </p>
053: * <p>Copyright: Copyright (c) 2003</p>
054: * <p>Company: </p>
055: * @author not attributable
056: * @version 1.0
057: */
058:
059: public interface ILanguage {
060:
061: /**
062: * The name of the language that is represented by the ILanguage interface.
063: *
064: * @return The name of the language.
065: */
066: public String getName();
067:
068: /**
069: * The name of the language that is represented by the ILanguage interface.
070: * @param value The name of the language
071: */
072: public void setName(String value);
073:
074: /**
075: * The data types that are supported by the language.
076: * @return the data types
077: */
078: public ETList<ILanguageDataType> getDataTypes();
079:
080: /**
081: * The data types that are supported by the language.
082: *
083: * @param value the data types
084: */
085: public void setDataTypes(ETList<ILanguageDataType> value);
086:
087: /**
088: * The syntax that defines the language. A syntax is made up of a collection
089: * of tokens that together define the syntax.
090: *
091: * @return The syntax object
092: */
093: public ILanguageSyntax getSyntax();
094:
095: /**
096: * The syntax that defines the language. A syntax is made up of a collection
097: * of tokens that together define the syntax.
098: *
099: * @param value The syntax object
100: */
101: public void setSyntax(ILanguageSyntax value);
102:
103: /**
104: * The code generation scripts that will generate source code for the langauge.
105: *
106: * @return a collection of code generation scripts.
107: * @depercated
108: */
109: public ETList<ICodeGenerationScript> getCodeGenerationScripts();
110:
111: /**
112: * The code generation scripts that will generate source code for the langauge.
113: *
114: * @param value A collection of code generation scripts
115: * @depercated
116: */
117: public void setCodeGenerationScripts(
118: ETList<ICodeGenerationScript> value);
119:
120: /**
121: * Retrieve the ILanguageParser for the specified parser type.
122: * @param Type The type of parser <i>examples: default, java5</i>
123: * @return A parser can can be used to parse the language files.
124: */
125: public ILanguageParser getParser(String Type);
126:
127: /**
128: * Add a CLSID that implements the ILangaugeParser interface. The parser
129: * will be used to parser files written in the defined langauge.
130: */
131: public void addParser(String Type, String clsid);
132:
133: /**
134: * Retrieves the CLSID of the parser for the specified parser type.
135: */
136: public String getParserCLSID(String Type);
137:
138: /**
139: * Adds a new context to the the language. Contexts are used by other components to perform langauge specific operations. The interface for each context is defined by the component.
140: */
141: public void addContext(String name, String clsid);
142:
143: /**
144: * Retrieves the CLSID for a context. Contexts are used by other components to perform langauge specific operations. The interface for each context is defined by the component.
145: */
146: public String getContextCLSID(String context);
147:
148: /**
149: * The type used when creating a new attribute.
150: */
151: public ILanguageDataType getAttributeDefaultType();
152:
153: /**
154: * The type used when creating a new attribute.
155: */
156: public void setAttributeDefaultType(ILanguageDataType value);
157:
158: /**
159: * The return type to use when creating a new operation.
160: */
161: public ILanguageDataType getOperationDefaultType();
162:
163: /**
164: * The return type to use when creating a new operation.
165: */
166: public void setOperationDefaultType(ILanguageDataType value);
167:
168: /**
169: * Is the given string the name of a predefined date type? These data types are defined in the Languages.etc file.
170: */
171: public boolean isDataType(String sType);
172:
173: /**
174: * Is the given string the name of a primitve date type? These data types are defined in the Languages.etc file.
175: */
176: public boolean isPrimitive(String sType);
177:
178: /**
179: * Is the given string a reserved word in this language? These reserved tokens are defined in the Languages.etc file.
180: */
181: public boolean isKeyword(String sWord);
182:
183: /**
184: * Get the data type by its name.
185: */
186: public ILanguageDataType getDataType(String sName);
187:
188: /**
189: * Get the token by its name.
190: */
191: public ISyntaxToken getSyntaxToken(String sName);
192:
193: /**
194: * Adds a new library to the language definition.
195: */
196: public void addLibrary(String name, String definitionFile);
197:
198: /**
199: * Retrieve a library definition from the language definition. If the language definition is not registered with the language definition then an empty string is returned.
200: */
201: public String getLibraryDefinition(String name);
202:
203: /**
204: * Retrieve all of the libraries that are registered with the langauge definition.
205: */
206: public IStrings getLibraryNames();
207:
208: /**
209: * Specifies the DOM node that specifies how to format a model elments data.
210: */
211: public void setFormatDefinitions(Node value);
212:
213: /**
214: * Specifies the DOM node that specifies how to format a model elments data.
215: */
216: public Node getFormatDefinition(String elementName);
217:
218: /**
219: * The override expansion variables associated with this Language. ExpansionVariables is the collection type.
220: */
221: public ETList<IExpansionVariable> getExpansionVariables();
222:
223: /**
224: * The override expansion variables associated with this Language. ExpansionVariables is the collection type.
225: */
226: public void setExpansionVariables(ETList<IExpansionVariable> value);
227:
228: /**
229: * Gets a Default setting
230: */
231: public String getDefault(String name);
232:
233: /**
234: * Sets a Default setting
235: */
236: public void setDefault(String name, String Value);
237:
238: /**
239: * Returns the default source code file extension
240: */
241: public String getDefaultSourceFileExtension();
242:
243: /**
244: * Specifies a specific feature is supported.
245: */
246: public boolean isFeatureSupported(String name);
247:
248: /**
249: * Turns on or off a supported feature.
250: */
251: public void setFeatureSupported(String name, boolean newVal);
252:
253: public String getFormatStringFile(String name);
254:
255: public ILanguageManager getLanguageManager();
256:
257: public void setLanguageManager(ILanguageManager pManager);
258:
259: /**
260: * Sets the languages collection types.
261: *
262: * @param types the list of collection types.
263: */
264: public void setCollectionTypes(List<CollectionType> types);
265:
266: /**
267: * Gets the languages collection types.
268: *
269: * @return types the list of collection types.
270: */
271: public List<CollectionType> getCollectionTypes();
272:
273: /**
274: * Checks if a type is a collection type.
275: *
276: * @param typeName the type to check.
277: * @return true if the type is a collection type.
278: */
279: public boolean isCollectionType(String typeName);
280: }
|