| |||||||||||||||||
Source File | Conditionals | Statements | Methods | TOTAL | |||||||||||||
TypeHandlers\ITypeHandler.cs | - | - | - | - |
|
1 | ||
2 | #region Apache Notice | |
3 | /***************************************************************************** | |
4 | * $Header: $ | |
5 | * $Revision: $ | |
6 | * $Date: $ | |
7 | * | |
8 | * iBATIS.NET Data Mapper | |
9 | * Copyright (C) 2004 - Gilles Bayon | |
10 | * | |
11 | * | |
12 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
13 | * you may not use this file except in compliance with the License. | |
14 | * You may obtain a copy of the License at | |
15 | * | |
16 | * http://www.apache.org/licenses/LICENSE-2.0 | |
17 | * | |
18 | * Unless required by applicable law or agreed to in writing, software | |
19 | * distributed under the License is distributed on an "AS IS" BASIS, | |
20 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
21 | * See the License for the specific language governing permissions and | |
22 | * limitations under the License. | |
23 | * | |
24 | ********************************************************************************/ | |
25 | #endregion | |
26 | ||
27 | #region Using | |
28 | ||
29 | using System; | |
30 | using System.Data; | |
31 | using IBatisNet.DataMapper.Configuration.ParameterMapping; | |
32 | using IBatisNet.DataMapper.Configuration.ResultMapping; | |
33 | #endregion | |
34 | ||
35 | namespace IBatisNet.DataMapper.TypeHandlers | |
36 | { | |
37 | /// <summary> | |
38 | /// Summary description for ITypeHandler. | |
39 | /// </summary> | |
40 | public interface ITypeHandler | |
41 | { | |
42 | ||
43 | /// <summary> | |
44 | /// | |
45 | /// </summary> | |
46 | /// <returns></returns> | |
47 | bool IsSimpleType{get;} | |
48 | ||
49 | /// <summary> | |
50 | /// Gets a column value by the name | |
51 | /// </summary> | |
52 | /// <param name="mapping"></param> | |
53 | /// <param name="dataReader"></param> | |
54 | /// <returns></returns> | |
55 | object GetValueByName(ResultProperty mapping, IDataReader dataReader); | |
56 | ||
57 | /// <summary> | |
58 | /// Gets a column value by the index | |
59 | /// </summary> | |
60 | /// <param name="mapping"></param> | |
61 | /// <param name="dataReader"></param> | |
62 | /// <returns></returns> | |
63 | object GetValueByIndex(ResultProperty mapping, IDataReader dataReader); | |
64 | ||
65 | /// <summary> | |
66 | /// Retrieve ouput database value of an output parameter | |
67 | /// </summary> | |
68 | /// <param name="outputValue">ouput database value</param> | |
69 | /// <param name="parameterType">type used in EnumTypeHandler</param> | |
70 | /// <returns></returns> | |
71 | object GetDataBaseValue(object outputValue, Type parameterType); | |
72 | ||
73 | /// <summary> | |
74 | /// Sets a parameter on a IDbCommand | |
75 | /// </summary> | |
76 | /// <param name="dataParameter">the parameter</param> | |
77 | /// <param name="parameterValue">the parameter value</param> | |
78 | /// <param name="dbType">the dbType of the parameter</param> | |
79 | void SetParameter(IDataParameter dataParameter, object parameterValue, string dbType); | |
80 | ||
81 | /// <summary> | |
82 | /// Converts the String to the type that this handler deals with | |
83 | /// </summary> | |
84 | /// <param name="type">the tyepe of the property (used only for enum conversion)</param> | |
85 | /// <param name="s">the String value</param> | |
86 | /// <returns>the converted value</returns> | |
87 | object ValueOf(Type type, string s); | |
88 | ||
89 | /// <summary> | |
90 | /// Compares two values (that this handler deals with) for equality | |
91 | /// </summary> | |
92 | /// <param name="obj">one of the objects</param> | |
93 | /// <param name="str">the other object as a String</param> | |
94 | /// <returns>true if they are equal</returns> | |
95 | bool Equals(object obj, string str); | |
96 | } | |
97 | } | |
98 |
|