mcs/class/System.Data.Linq/src/DbLinq/Vendor/INameAliases.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.Vendor\r
  28 {\r
  29     /// <summary>\r
  30     /// Represents aliases for table names or types.\r
  31     /// Depending on the implementation, search maybe case insensitive or schema insensitive\r
  32     /// </summary>\r
  33 #if !MONO_STRICT\r
  34     public\r
  35 #endif\r
  36     interface INameAliases\r
  37     {\r
  38         /// <summary>\r
  39         /// Returns a type name for a given table.\r
  40         /// </summary>\r
  41         /// <param name="table">The table to look for</param>\r
  42         /// <param name="schema">An optional schema (or null)</param>\r
  43         /// <returns>Type name or null if no alias found</returns>\r
  44         string GetTableTypeAlias(string table, string schema);\r
  45         /// <summary>\r
  46         /// Returns a member name for a given table (used by the main database classes).\r
  47         /// </summary>\r
  48         /// <param name="table">The table to look for</param>\r
  49         /// <param name="schema">An optional schema (or null)</param>\r
  50         /// <returns>Member name or null if no alias found</returns>\r
  51         string GetTableMemberAlias(string table, string schema);\r
  52         /// <summary>\r
  53         /// Returns a member name for a given column.\r
  54         /// </summary>\r
  55         /// <param name="column">Column name</param>\r
  56         /// <param name="table">The table to look for (parameter may be ignored depending on implementation)</param>\r
  57         /// <param name="schema">An optional schema (or null)</param>\r
  58         /// <returns>Member name or null if no alias found</returns>\r
  59         string GetColumnMemberAlias(string column, string table, string schema);\r
  60         /// <summary>\r
  61         /// Returns a member type for a given column.\r
  62         /// Please note that DbLinq may not handle correctly the forced type\r
  63         /// </summary>\r
  64         /// <param name="column">Column name</param>\r
  65         /// <param name="table">The table to look for (parameter may be ignored depending on implementation)</param>\r
  66         /// <param name="schema">An optional schema (or null)</param>\r
  67         /// <returns>Member type or null if no alias found</returns>\r
  68         string GetColumnForcedType(string column, string table, string schema);\r
  69 \r
  70         string GetDatabaseNameAlias(string databaseName);\r
  71         string GetClassNameAlias(string className);\r
  72     }\r
  73 }\r