mcs/class/System.Data.Linq/src/DbLinq/Schema/INameFormatter.cs

   1 #region MIT license\r
   2 // \r
   3 // MIT license\r
   4 //\r
   5 // Copyright (c) 2007-2008 Jiri Moudry, Pascal Craponne\r
   6 // \r
   7 // Permission is hereby granted, free of charge, to any person obtaining a copy\r
   8 // of this software and associated documentation files (the "Software"), to deal\r
   9 // in the Software without restriction, including without limitation the rights\r
  10 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
  11 // copies of the Software, and to permit persons to whom the Software is\r
  12 // furnished to do so, subject to the following conditions:\r
  13 // \r
  14 // The above copyright notice and this permission notice shall be included in\r
  15 // all copies or substantial portions of the Software.\r
  16 // \r
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  20 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  22 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  23 // THE SOFTWARE.\r
  24 // \r
  25 #endregion\r
  26 \r
  27 namespace DbLinq.Schema\r
  28 {\r
  29     /// <summary>\r
  30     /// Allows to manipulate words\r
  31     /// </summary>\r
  32 #if MONO_STRICT\r
  33     internal\r
  34 #else\r
  35     public\r
  36 #endif\r
  37     interface INameFormatter\r
  38     {\r
  39         /// <summary>\r
  40         /// Gets the name of the schema.\r
  41         /// </summary>\r
  42         /// <param name="dbName">Name of the db.</param>\r
  43         /// <param name="extraction">The extraction.</param>\r
  44         /// <param name="nameFormat">The name format.</param>\r
  45         /// <returns></returns>\r
  46         SchemaName GetSchemaName(string dbName, WordsExtraction extraction, NameFormat nameFormat);\r
  47         /// <summary>\r
  48         /// Gets the name of the procedure.\r
  49         /// </summary>\r
  50         /// <param name="dbName">Name of the db.</param>\r
  51         /// <param name="extraction">The extraction.</param>\r
  52         /// <param name="nameFormat">The name format.</param>\r
  53         /// <returns></returns>\r
  54         ProcedureName GetProcedureName(string dbName, WordsExtraction extraction, NameFormat nameFormat);\r
  55         /// <summary>\r
  56         /// Gets the name of the parameter.\r
  57         /// </summary>\r
  58         /// <param name="dbName">Name of the db.</param>\r
  59         /// <param name="extraction">The extraction.</param>\r
  60         /// <param name="nameFormat">The name format.</param>\r
  61         /// <returns></returns>\r
  62         ParameterName GetParameterName(string dbName, WordsExtraction extraction, NameFormat nameFormat);\r
  63         /// <summary>\r
  64         /// Gets the name of the table.\r
  65         /// </summary>\r
  66         /// <param name="dbName">Name of the db.</param>\r
  67         /// <param name="extraction">The extraction.</param>\r
  68         /// <param name="nameFormat">The name format.</param>\r
  69         /// <returns></returns>\r
  70         TableName GetTableName(string dbName, WordsExtraction extraction, NameFormat nameFormat);\r
  71         /// <summary>\r
  72         /// Gets the name of the column.\r
  73         /// </summary>\r
  74         /// <param name="dbName">Name of the db.</param>\r
  75         /// <param name="extraction">The extraction.</param>\r
  76         /// <param name="nameFormat">The name format.</param>\r
  77         /// <returns></returns>\r
  78         ColumnName GetColumnName(string dbName, WordsExtraction extraction, NameFormat nameFormat);\r
  79         /// <summary>\r
  80         /// Gets the name of the association.\r
  81         /// </summary>\r
  82         /// <param name="dbManyName">Name of the db many.</param>\r
  83         /// <param name="dbOneName">Name of the db one.</param>\r
  84         /// <param name="dbConstraintName">Name of the db constraint.</param>\r
  85         /// <param name="foreignKeyName">Name of the foreign key.</param>\r
  86         /// <param name="extraction">The extraction.</param>\r
  87         /// <param name="nameFormat">The name format.</param>\r
  88         /// <returns></returns>\r
  89         AssociationName GetAssociationName(string dbManyName, string dbOneName,\r
  90                                            string dbConstraintName, string foreignKeyName,\r
  91                                             WordsExtraction extraction, NameFormat nameFormat);\r
  92         // \r
  93         /// <summary>\r
  94         /// Reformats a name by adjusting its case.\r
  95         /// </summary>\r
  96         /// <param name="words">The words.</param>\r
  97         /// <param name="newCase">The new case.</param>\r
  98         /// <returns></returns>\r
  99         string Format(string words, Case newCase);\r
 100     }\r
 101 }\r