-
Notifications
You must be signed in to change notification settings - Fork 2
/
ISQLData.xml
229 lines (229 loc) · 14.8 KB
/
ISQLData.xml
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
<Type Name="ISQLData" FullName="Java.Sql.ISQLData">
<TypeSignature Language="C#" Value="public interface ISQLData : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ISQLData implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Java.Sql.ISQLData" />
<TypeSignature Language="F#" Value="type ISQLData = interface
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("java/sql/SQLData", "", "Java.Sql.ISQLDataInvoker")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("java/sql/SQLData", "", "Java.Sql.ISQLDataInvoker")>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="1">
<summary>The interface used for the custom mapping of an SQL user-defined type (UDT) to
a class in the Java programming language.</summary>
<remarks>
<para>The interface used for the custom mapping of an SQL user-defined type (UDT) to
a class in the Java programming language. The class object for a class
implementing the <c>SQLData</c> interface will be entered in the
appropriate <c>Connection</c> object's type map along with the SQL
name of the UDT for which it is a custom mapping.</para>
<para>Typically, a <c>SQLData</c> implementation
will define a field for each attribute of an SQL structured type or a
single field for an SQL <c>DISTINCT</c> type. When the UDT is
retrieved from a data source with the <c>ResultSet.getObject</c>
method, it will be mapped as an instance of this class. A programmer
can operate on this class instance just as on any other object in the
Java programming language and then store any changes made to it by
calling the <c>PreparedStatement.setObject</c> method,
which will map it back to the SQL type.</para>
<para>It is expected that the implementation of the class for a custom
mapping will be done by a tool. In a typical implementation, the
programmer would simply supply the name of the SQL UDT, the name of
the class to which it is being mapped, and the names of the fields to
which each of the attributes of the UDT is to be mapped. The tool will use
this information to implement the <c>SQLData.readSQL</c> and
<c>SQLData.writeSQL</c> methods. The <c>readSQL</c> method
calls the appropriate <c>SQLInput</c> methods to read
each attribute from an <c>SQLInput</c> object, and the
<c>writeSQL</c> method calls <c>SQLOutput</c> methods
to write each attribute back to the data source via an
<c>SQLOutput</c> object.</para>
<para>An application programmer will not normally call <c>SQLData</c> methods
directly, and the <c>SQLInput</c> and <c>SQLOutput</c> methods
are called internally by <c>SQLData</c> methods, not by application code.</para>
<para>Added in 1.2.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/SQLData" title="Reference documentation">Java documentation for <code>java.sql.SQLData</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
<Members>
<Member MemberName="ReadSQL">
<MemberSignature Language="C#" Value="public void ReadSQL (Java.Sql.ISQLInput? stream, string? typeName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void ReadSQL(class Java.Sql.ISQLInput stream, string typeName) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Sql.ISQLData.ReadSQL(Java.Sql.ISQLInput,System.String)" />
<MemberSignature Language="F#" Value="abstract member ReadSQL : Java.Sql.ISQLInput * string -> unit" Usage="iSQLData.ReadSQL (stream, typeName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("readSQL", "(Ljava/sql/SQLInput;Ljava/lang/String;)V", "GetReadSQL_Ljava_sql_SQLInput_Ljava_lang_String_Handler:Java.Sql.ISQLDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("readSQL", "(Ljava/sql/SQLInput;Ljava/lang/String;)V", "GetReadSQL_Ljava_sql_SQLInput_Ljava_lang_String_Handler:Java.Sql.ISQLDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="Java.Sql.ISQLInput" />
<Parameter Name="typeName" Type="System.String" />
</Parameters>
<Docs>
<param name="stream">the <c>SQLInput</c> object from which to read the data for
the value that is being custom mapped</param>
<param name="typeName">the SQL type name of the value on the data stream</param>
<summary>Populates this object with data read from the database.</summary>
<remarks>
<para>Populates this object with data read from the database.
The implementation of the method must follow this protocol:
<UL>
<LI>It must read each of the attributes or elements of the SQL
type from the given input stream. This is done
by calling a method of the input stream to read each
item, in the order that they appear in the SQL definition
of the type.
<LI>The method <c>readSQL</c> then
assigns the data to appropriate fields or
elements (of this or other objects).
Specifically, it must call the appropriate <i>reader</i> method
(<c>SQLInput.readString</c>, <c>SQLInput.readBigDecimal</c>,
and so on) method(s) to do the following:
for a distinct type, read its single data element;
for a structured type, read a value for each attribute of the SQL type.
</UL>
The JDBC driver initializes the input stream with a type map
before calling this method, which is used by the appropriate
<c>SQLInput</c> reader method on the stream.</para>
<para>Added in 1.2.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/SQLData#readSQL(java.sql.SQLInput,%20java.lang.String)" title="Reference documentation">Java documentation for <code>java.sql.SQLData.readSQL(java.sql.SQLInput, java.lang.String)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if a database error occurs.</exception>
<altmember cref="T:Java.Sql.ISQLInput" />
</Docs>
</Member>
<Member MemberName="SQLTypeName">
<MemberSignature Language="C#" Value="public string? SQLTypeName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SQLTypeName" />
<MemberSignature Language="DocId" Value="P:Java.Sql.ISQLData.SQLTypeName" />
<MemberSignature Language="F#" Value="member this.SQLTypeName : string" Usage="Java.Sql.ISQLData.SQLTypeName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getSQLTypeName", "()Ljava/lang/String;", "GetGetSQLTypeNameHandler:Java.Sql.ISQLDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getSQLTypeName", "()Ljava/lang/String;", "GetGetSQLTypeNameHandler:Java.Sql.ISQLDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the SQL name of the <format type="text/html"><i>User Defined Type</i></format> (UDT) that this object
represents.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if a database error occurs.
</exception>
</Docs>
</Member>
<Member MemberName="WriteSQL">
<MemberSignature Language="C#" Value="public void WriteSQL (Java.Sql.ISQLOutput? stream);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteSQL(class Java.Sql.ISQLOutput stream) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Sql.ISQLData.WriteSQL(Java.Sql.ISQLOutput)" />
<MemberSignature Language="F#" Value="abstract member WriteSQL : Java.Sql.ISQLOutput -> unit" Usage="iSQLData.WriteSQL stream" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("writeSQL", "(Ljava/sql/SQLOutput;)V", "GetWriteSQL_Ljava_sql_SQLOutput_Handler:Java.Sql.ISQLDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("writeSQL", "(Ljava/sql/SQLOutput;)V", "GetWriteSQL_Ljava_sql_SQLOutput_Handler:Java.Sql.ISQLDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="Java.Sql.ISQLOutput" />
</Parameters>
<Docs>
<param name="stream">the <c>SQLOutput</c> object to which to write the data for
the value that was custom mapped</param>
<summary>Writes this object to the given SQL data stream, converting it back to
its SQL value in the data source.</summary>
<remarks>
<para>Writes this object to the given SQL data stream, converting it back to
its SQL value in the data source.
The implementation of the method must follow this protocol:<BR>
It must write each of the attributes of the SQL type
to the given output stream. This is done by calling a
method of the output stream to write each item, in the order that
they appear in the SQL definition of the type.
Specifically, it must call the appropriate <c>SQLOutput</c> writer
method(s) (<c>writeInt</c>, <c>writeString</c>, and so on)
to do the following: for a Distinct Type, write its single data element;
for a Structured Type, write a value for each attribute of the SQL type.</para>
<para>Added in 1.2.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/SQLData#writeSQL(java.sql.SQLOutput)" title="Reference documentation">Java documentation for <code>java.sql.SQLData.writeSQL(java.sql.SQLOutput)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if a database error occurs.</exception>
<altmember cref="T:Java.Sql.ISQLOutput" />
</Docs>
</Member>
</Members>
</Type>