summaryrefslogtreecommitdiff
path: root/slips/build/lib/castle/bin/Castle.Components.Binder.xml
blob: 1148ba8148f190e379c28b64cad941cdb49fbb95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Castle.Components.Binder</name>
    </assembly>
    <members>
        <member name="T:Castle.Components.Binder.DataBinder">
            <summary>
            </summary>
        </member>
        <member name="T:Castle.Components.Binder.IDataBinder">
            <summary>
            Defines the contract for a data binder implementation approach.
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.IDataBinder.BindObject(System.Type,System.String,Castle.Components.Binder.CompositeNode)">
            <summary>
            Create an instance of the specified type and binds the properties that
            are available on the datasource.
            </summary>
            <param name="targetType">The target type. Can be an array</param>
            <param name="prefix">The obligatory prefix that distinguishes it on the datasource</param>
            <param name="treeRoot">A hierarchycal representation of flat data</param>
            <returns>an instance of the specified target type</returns>
        </member>
        <member name="M:Castle.Components.Binder.IDataBinder.BindObject(System.Type,System.String,System.String,System.String,Castle.Components.Binder.CompositeNode)">
            <summary>
            Create an instance of the specified type and binds the properties that
            are available on the datasource respecting the white and black list
            </summary>
            <param name="targetType">The target type. Can be an array</param>
            <param name="prefix">The obligatory prefix that distinguishes it on the datasource</param>
            <param name="excludedProperties">A list of comma separated values specifing the properties that should be ignored</param>
            <param name="allowedProperties">A list of comma separated values specifing the properties that should not be ignored</param>
            <param name="treeRoot">A hierarchycal representation of flat data</param>
            <returns>an instance of the specified target type</returns>
        </member>
        <member name="M:Castle.Components.Binder.IDataBinder.BindObjectInstance(System.Object,System.String,Castle.Components.Binder.CompositeNode)">
            <summary>
            Binds the properties that are available on the datasource to the specified object instance.
            </summary>
            <param name="instance">The target instance.</param>
            <param name="prefix">The obligatory prefix that distinguishes it on the datasource</param>
            <param name="treeRoot">A hierarchycal representation of flat data</param>
            <returns>an instance of the specified target type</returns>
        </member>
        <member name="M:Castle.Components.Binder.IDataBinder.BindObjectInstance(System.Object,System.String,System.String,System.String,Castle.Components.Binder.CompositeNode)">
            <summary>
            Binds the properties that
            are available on the datasource respecting the white and black list
            </summary>
            <param name="instance">The target type.</param>
            <param name="prefix">The obligatory prefix that distinguishes it on the datasource</param>
            <param name="excludedProperties">A list of comma separated values specifing the properties that should be ignored</param>
            <param name="allowedProperties">A list of comma separated values specifing the properties that should not be ignored</param>
            <param name="treeRoot">A hierarchycal representation of flat data</param>
            <returns>an instance of the specified target type</returns>
        </member>
        <member name="M:Castle.Components.Binder.IDataBinder.GetValidationSummary(System.Object)">
            <summary>
            Gets the validation error summary.
            </summary>
            <param name="instance">The instance.</param>
        </member>
        <member name="P:Castle.Components.Binder.IDataBinder.ErrorList">
            <summary>
            Represents the databind errors
            </summary>
        </member>
        <member name="P:Castle.Components.Binder.IDataBinder.Translator">
            <summary>
            Exposes the <see cref="T:Castle.Components.Binder.IBinderTranslator"/> implementation
            if one was provided
            </summary>
        </member>
        <member name="P:Castle.Components.Binder.IDataBinder.Converter">
            <summary>
            Exposes the <see cref="T:Castle.Components.Binder.IConverter"/> implementation
            </summary>
        </member>
        <member name="P:Castle.Components.Binder.IDataBinder.Validator">
            <summary>
            Gets or sets the validator runner instance.
            </summary>
            <value>The validator instance.</value>
        </member>
        <member name="E:Castle.Components.Binder.IDataBinder.OnBeforeBinding">
            <summary>
            Invoked before the data binder implementation starts to
            work on a class instance
            </summary>
        </member>
        <member name="E:Castle.Components.Binder.IDataBinder.OnAfterBinding">
            <summary>
            Invoked after the data binder implementation starts to
            work on a class instance
            </summary>
        </member>
        <member name="F:Castle.Components.Binder.DataBinder.errors">
            <summary>Collect the databind errors</summary>
        </member>
        <member name="F:Castle.Components.Binder.DataBinder.excludedPropertyList">
            <summary>Holds a sorted array of properties names that should be ignored</summary>
        </member>
        <member name="F:Castle.Components.Binder.DataBinder.allowedPropertyList">
            <summary>Holds a sorted array of properties names that are on the white list</summary>
        </member>
        <member name="M:Castle.Components.Binder.DataBinder.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Binder.DataBinder"/> class.
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.DataBinder.GetValidationSummary(System.Object)">
            <summary>
            Gets the validation error summary.
            </summary>
            <param name="instance">The instance.</param>
        </member>
        <member name="M:Castle.Components.Binder.DataBinder.SetPropertyValue(System.Object,System.Reflection.PropertyInfo,System.Object)">
            <summary>
            Sets the property value of the object we are binding.
            Databinders that require different ways to access properties
            can override this method.
            </summary>
            <param name="instance"></param>
            <param name="prop"></param>
            <param name="value"></param>
        </member>
        <member name="M:Castle.Components.Binder.DataBinder.BindSpecialObjectInstance(System.Type,System.String,Castle.Components.Binder.Node,System.Boolean@)">
            <summary>
            Implementations will bound the instance itself.
            <seealso cref="M:Castle.Components.Binder.DataBinder.IsSpecialType(System.Type)"/>
            </summary>
            <remarks>
            <seealso cref="M:Castle.Components.Binder.DataBinder.IsSpecialType(System.Type)"/>
            </remarks>
            <param name="instanceType"></param>
            <param name="prefix"></param>
            <param name="node"></param>
            <param name="succeeded"></param>
        </member>
        <member name="M:Castle.Components.Binder.DataBinder.IsSpecialType(System.Type)">
            <summary>
            Invoked during object binding to allow 
            subclasses to have a chance of binding the types itself.
            If the implementation returns <c>true</c>
            the binder will invoke <see cref="M:Castle.Components.Binder.DataBinder.BindSpecialObjectInstance(System.Type,System.String,Castle.Components.Binder.Node,System.Boolean@)"/>
            </summary>
            <param name="instanceType">Type about to be bound</param>
            <returns><c>true</c> if subclass wants to handle binding</returns>
        </member>
        <member name="P:Castle.Components.Binder.DataBinder.ErrorList">
            <summary>
            Represents the databind errors
            </summary>
        </member>
        <member name="T:Castle.Components.Binder.DataBindError">
            <summary>
            Represents an error that occurred when trying to 
            databind a property of an instance.
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.DataBindError.#ctor(System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Binder.DataBindError"/> class.
            </summary>
            <param name="parent">The parent.</param>
            <param name="property">The property.</param>
        </member>
        <member name="M:Castle.Components.Binder.DataBindError.#ctor(System.String,System.String,System.Exception)">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Binder.DataBindError"/> class.
            </summary>
            <param name="parent">The parent.</param>
            <param name="property">The property.</param>
            <param name="exception">The exception.</param>
        </member>
        <member name="M:Castle.Components.Binder.DataBindError.#ctor(System.String,System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Binder.DataBindError"/> class.
            </summary>
            <param name="parent">The parent.</param>
            <param name="property">The property.</param>
            <param name="errorMessage">The error message.</param>
        </member>
        <member name="M:Castle.Components.Binder.DataBindError.ToString">
            <summary>
            Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
            </summary>
            <returns>
            A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
            </returns>
        </member>
        <member name="P:Castle.Components.Binder.DataBindError.Key">
            <summary>
            Gets the key.
            </summary>
            <value>The key.</value>
        </member>
        <member name="P:Castle.Components.Binder.DataBindError.Parent">
            <summary>
            Gets the parent.
            </summary>
            <value>The parent.</value>
        </member>
        <member name="P:Castle.Components.Binder.DataBindError.Property">
            <summary>
            Gets the property.
            </summary>
            <value>The property.</value>
        </member>
        <member name="P:Castle.Components.Binder.DataBindError.ErrorMessage">
            <summary>
            Gets the error message.
            </summary>
            <value>The error message.</value>
        </member>
        <member name="T:Castle.Components.Binder.DataReaderTreeBuilder">
            <summary>
            
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.DataReaderTreeBuilder.BuildSourceNode(System.Data.IDataReader,System.String)">
            <summary>
            
            </summary>
            <param name="reader"></param>
            <param name="prefix"></param>
            <returns></returns>
        </member>
        <member name="M:Castle.Components.Binder.DataReaderTreeBuilder.PopulateTree(Castle.Components.Binder.CompositeNode,System.Data.IDataReader,System.String)">
            <summary>
            
            </summary>
            <param name="root"></param>
            <param name="reader"></param>
            <param name="prefix"></param>
        </member>
        <member name="M:Castle.Components.Binder.DataReaderTreeBuilder.FindDuplicateFields(System.String[])">
            <summary>
            Check the fields for duplicates.
            </summary>
            <param name="fields"></param>
            <returns></returns>
            <remarks>
            I have to add this check as some stored procedures
            return duplicate columns (doh!) and this isn't good
            for the binder.
            </remarks>
        </member>
        <member name="T:Castle.Components.Binder.IConverter">
            <summary>
            Depicts the contract for implementations able to convert an object
            -- usually a string -- to the specified desired type.
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.DefaultConverter.Convert(System.Type,System.Object,System.Boolean@)">
            <summary>
            Convert the input param into the desired type
            </summary>
            <param name="desiredType">Type of the desired</param>
            <param name="input">The input</param>
            <param name="conversionSucceeded">if <c>false</c> the return value must be ignored</param>
            <remarks>
            There are 3 possible cases when trying to convert:
            1) Input data for conversion missing (input is null or an empty String)
            	Returns default conversion value (based on desired type) and set <c>conversionSucceeded = false</c>
            2) Has input data but cannot convert to particular type
            	Throw exception and set <c>conversionSucceeded = false</c>
            3) Has input data and can convert to particular type
            	 Return input converted to desired type and set <c>conversionSucceeded = true</c>
            </remarks>
        </member>
        <member name="M:Castle.Components.Binder.DefaultConverter.FixInputForMonoIfNeeded(System.Type,System.Object)">
            <summary>
            Fix for mod_mono issue where array values are passed as a comma seperated String.
            </summary>
            <param name="elemType"></param>
            <param name="input"></param>
            <returns></returns>
        </member>
        <member name="M:Castle.Components.Binder.DefaultConverter.ConvertUsingTypeConverter(System.Type,System.Object,System.Boolean@)">
            <summary>
            Support for types that specify a TypeConverter, 
            i.e.: NullableTypes
            </summary>
        </member>
        <member name="T:Castle.Components.Binder.ErrorList">
            <summary>
            A useful representation of a set of IPropertyError instances.
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.ErrorList.#ctor(System.Collections.IList)">
            <summary>
            Initializes a new instance of the <see cref="T:Castle.Components.Binder.ErrorList"/> class.
            </summary>
            <param name="initialContents">The initial contents.</param>
        </member>
        <member name="M:Castle.Components.Binder.ErrorList.Contains(System.String)">
            <summary>
            Determines whether [contains] [the specified property].
            </summary>
            <param name="property">The property.</param>
            <returns>
            	<c>true</c> if [contains] [the specified property]; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="P:Castle.Components.Binder.ErrorList.Count">
            <summary>
            Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"></see>.
            </summary>
            <value></value>
            <returns>The number of elements contained in the <see cref="T:System.Collections.ICollection"></see>.</returns>
        </member>
        <member name="P:Castle.Components.Binder.ErrorList.Item(System.String)">
            <summary>
            Gets the <see cref="T:Castle.Components.Binder.DataBindError"/> with the specified property.
            </summary>
            <value></value>
        </member>
        <member name="T:Castle.Components.Binder.IBinderTranslator">
            <summary>
            Provides a way to properties on the binder target
            be bound to a different key in the data source.
            </summary>
        </member>
        <member name="M:Castle.Components.Binder.IBinderTranslator.Translate(System.Type,System.String)">
            <summary>
            Should return the key that gathers the value 
            to fill the property.
            </summary>
            <param name="instanceType">
            The type which is the target of the binder
            </param>
            <param name="paramName">
            The property name in  the target type
            </param>
            <returns>
            A name of the source data that should be used to populate the property
            </returns>
        </member>
        <member name="T:Castle.Components.Binder.TreeBuilder">
            <summary>
            
            </summary>
        </member>
    </members>
</doc>