View Javadoc

1   /*
2    * Copyright 2006 Outsource Cafe, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the 'License')
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *    http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an 'AS IS' BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.javagen.agile.core.emitter.template;
17  
18  import java.io.File;
19  import java.util.Map;
20  
21  import org.javagen.agile.core.emitter.WriterFactory;
22  
23  /***
24   * Generic interface for triggering templates.
25   *
26   * @author Richard Easterling
27   */
28  public interface TemplateGenerator {
29  
30  	/***
31  	 * Process template
32  	 * 
33  	 * @param templatePath relative to templateBasePath
34  	 * @param outFile output file
35  	 * @param context usualy a combined context based on current model node. 
36  	 */
37  	public void gen(String templatePath, File outFile, Map<String, Object> context);
38  
39  	/***
40  	 * Base path of template locations.
41  	 */
42  	public String getTemplateBasePath();
43      
44      /***
45       * Provide a hook for tools to intercept the output sinks.
46       */
47      void setWriterFactory(WriterFactory writerFactory);
48  }