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.generativeframework;
043:
044: import org.dom4j.Node;
045:
046: import org.netbeans.modules.uml.core.metamodel.core.foundation.IElement;
047:
048: public interface ITemplateManager {
049: /**
050: * Expands the passed in template file, using contextElement as the initial element to query against.
051: */
052: public String expandTemplate(String templateFile,
053: IElement contextElement);
054:
055: /**
056: * Expands the passed in template file, using contextNode as the initial element to query against.
057: */
058: public String expandTemplateWithNode(String templateFile,
059: Node contextNode);
060:
061: /**
062: * Gets the IVariableExpander this factory is
063: * @return
064: */
065: public IVariableExpander getVariableExpander();
066:
067: /**
068: * The location of a configuration file that contains Expansion variable definitions.
069: */
070: public String getConfigLocation();
071:
072: /**
073: * The location of a configuration file that contains Expansion variable definitions.
074: */
075: public void setConfigLocation(String value);
076:
077: /**
078: * The VariableFactory this TemplateManager will use.
079: */
080: public IVariableFactory getFactory();
081:
082: /**
083: * The VariableFactory this TemplateManager will use.
084: */
085: public void setFactory(IVariableFactory value);
086:
087: /**
088: * The absolute path to the directory where expansions are taking place.
089: */
090: public String getWorkingDirectory();
091:
092: /**
093: * The absolute path to the directory where expansions are taking place.
094: */
095: public void setWorkingDirectory(String value);
096:
097: public String expandVariable(String varName, IElement contextElement);
098:
099: public String expandVariableWithNode(String varName,
100: Node contextNode);
101:
102: public IVariableExpander createExecutionContext();
103: }
|