/*

  * 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.context;

 /** 

  * Common keys used to lookup values and templates in the context.

  * <p>

  * To allow new keys to be introduced without recompilation,

  * enumeration instances themselves are not used in JavaGen code,

  * but rather their string values. 

  * Propper usage is <code>Keys.KEY_NAME.toString()</code>.

  * 

  * @author Richard Easterling

  */

 public enum Keys {

     //Java bean standard context keys

         PROPERTY("property"),

         REFERENCE("reference"),

         ENTITY("entity"),

         GEN("gen"),

         PK("pk"),

         ENUM("enum"),

         DAO("dao"),

         DAOIMPL("daoImpl"),

         TEST("test"),

         HBM("hbm.xml"),

         CONFIG("config"),

         //SQL standard context keys

         TABLE("table"),

         COLUMN("column"),

         FK_CONSTRAINT("fkConstraint"),

     OWNING_SIDE("owningSide"), //owning side of relationship - determines 'mappedBy' location, commit triggers, etc.

     //always pushed into context along with MODEL_NAME

     MODEL(org.javagen.agile.core.context.Keys.MODEL.toString()), //model object should always be available through this key

     //context-based template naming

     MODEL_NAME(org.javagen.agile.core.context.Keys.MODEL_NAME.toString()), //model name is always pushed into the context

          PK_NAME_TEMPLATE("pkNameTemplate"),

         BASE_PACKAGE_NAME(org.javagen.agile.oo.context.Keys.BASE_PACKAGE_NAME.toString()),

         RELATIVE_PACKAGE_NAME(org.javagen.agile.oo.context.Keys.RELATIVE_PACKAGE_NAME.toString()),

         ;

         private String name;

         private Keys(String name) { this.name = name; }

         public String toString() { return name; }

 }