/*

  * Copyright 2006 Outsource Cafe, Inc.

  *

  * 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.javagen.revgen.mapping;

 import org.javagen.agile.db.model.Cardinality;

 import org.javagen.agile.db.model.Column;

 import org.javagen.agile.db.model.FkConstraint;

 import org.javagen.agile.db.model.Table;

 import org.javagen.agile.oo.model.Class;

 /**

  * @todo need to clean this up and finish concept

  */

 public interface Db2OOMapper {

     public enum ReferenceNamingStrategy { useTargetClass, useFkColumn, useFkConstraint };

     void setReferenceNamingStrategy(ReferenceNamingStrategy strategy);

     /**

      * Generate a property name from a column.

      */

     String propertyNameSingular(Column column);

     /**

      * Generate a class name from a table.

      */

     String classNameSingular(Table table);

     /**

      * Generate a property type from a column.

      */

         String propertyType(Column column);

     /**

      * Generate a reference type from a foreign key constraint.

      */

         Class referenceType(FkConstraint fkConstraint);

     /**

      * @return an abstract collection name: SET, LIST, MAP, BAG, etc.

      * @see org.javagen.agile.oo.namaing.Collections

      */

         String containerType(FkConstraint fkConstraint);

     /**

      * @return property name for reference.

      */

         String referenceName(FkConstraint fkConstraint);

     /**

      * @return true if FK is not unique

      */

         boolean isManyCardinality(FkConstraint fkConstraint);

     /**

      * @return cardinality based on FkConstraint.

      */

     Cardinality determineCardinality(FkConstraint fkConstraint);

 }