/**

  *    Copyright 2005-2011 Steve McDuff d-duff@users.sourceforge.net

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.deduced.generator.java;

 import java.io.IOException;

 import org.deduced.PropertyCollection;

 /**

  * Interface that abstracts the function to generate java files for a schema

  * 

  * @author Steve McDuff

  */

 public interface JavaSchemaGenerator

 {

         /**

          * generate the Java Schema files from a DeducedModelLayer. Any schema

          * contained in the base property collection list on the model will be

          * generated

          * 

          * @param outputFolderName the folder where Java files will be created

          * @param schemaModelToGenerate the DeducedModelLayer containing some

          *            DeducedSchemaLayer objects

          * @throws IOException any error that occurs while writing the files

          */

         public void generateSchemaFromModel(

                 String outputFolderName, PropertyCollection<?, ?> schemaModelToGenerate)

                 throws IOException;

         /**

          * generate all the files required to use the specified schema. This method

          * will generate the framework, all the interfaces and implementations of

          * types within the schema.

          * 

          * @param model the model hosting the schema

          * @param schema the schema to generate

          * @param outputFolderName the output folder to use

          * @throws IOException any exception that occurs while attempting to write

          *             the file

          */

         public void generateFilesForSchema(

                 PropertyCollection<?, ?> model, PropertyCollection<?, ?> schema,

                 String outputFolderName) throws IOException;

 }