8b9d64dbdf2796b99929d3442073f7b8e704c7ec
[scilab.git] / scilab / modules / external_objects_java / help / en_US / 01-getting-started.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5 * Copyright (C) 2013 - S/E - Sylvestre Ledru
6 * Copyright (C) 2012 - CNES - Simon Billemont
7 *
8  * Copyright (C) 2012 - 2016 - Scilab Enterprises
9  *
10  * This file is hereby licensed under the terms of the GNU GPL v2.0,
11  * pursuant to article 5.3.4 of the CeCILL v.2.1.
12  * This file was originally licensed under the terms of the CeCILL v2.1,
13  * and continues to be available under such terms.
14  * For more information, see the COPYING file which you should have received
15  * along with this program.
16 *
17 *
18 -->
19 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="jims-getting-started">
20     <refnamediv>
21         <refname>Getting started - Beginning</refname>
22         <refpurpose>How to use the Java Scilab binding?</refpurpose>
23     </refnamediv>
24     <refsection>
25         <title>Description</title>
26         <para>The goal is this module is to allow the load and interaction on Java objects and datatypes.
27         </para>
28     </refsection>
29     <refsection>
30         <title>Basic</title>
31         <para>Before starting, it is convenient to know the most important functions and what they do. These frequently used functions are the following Scilab functions:
32             <itemizedlist>
33                 <listitem>
34                     <link linkend="jimport">jimport</link>: Import a Java class
35                 </listitem>
36                 <listitem>
37                     <link linkend="jimport">jinvoke</link>: Invoke a method of a Java object
38                 </listitem>
39             </itemizedlist>
40         </para>
41         <para>
42             jimport is the function that mirrors the functionality of the java statement 'import', and loads the specified class definition/template of a given class in memory. When loaded, this definition is used to accesses static methods/members, and create new objects.
43         </para>
44         <para>
45             jinvoke is a function that calls (invokes) a specified method on a java class or object. This invoke has an optional set of parameters that must coincide with the actual member signature. This means you must pass the same number of arguments, and these arguments must have the correct type.
46         </para>
47     </refsection>
48     <refsection>
49         <title>Example 1: Creating a basic class and calling a simple method</title>
50         <para>In this first example, the three basic pillars of working with Java are treated. The first is to load a class, then an instance is constructed and finally the invocation or calling of one of this methods or members.</para>
51         <para>
52             Consider a basic class as presented in the example <literal>HelloWorld</literal>. It has a default constructor generating a message upon construction and one public method which also shows a message when it has been called. This class should now be compiled into java byte-code. When developing your own code, then this section is usually handled by your IDE (integrated development environment). If you plan to use external libraries, these will available in precompiled form (packed in a JAR).
53         </para>
54         <programlisting role="java"><![CDATA[
55 // Save under the name HelloWorld.java
56 package com.foo;
57 public class HelloWorld {
58    public HelloWorld() {
59       System.err.println("HelloWorld constructed!");
60   }
61
62   public void message() {
63       System.err.println("Hello world!");
64   }
65 }
66       ]]></programlisting>
67         <programlisting role="example"><![CDATA[
68 // How to compile the Java code from Scilab
69 javacode=mgetl(fullfile(TMPDIR, 'HelloWorld.java'));
70 jcompile("com.foo.HelloWorld",javacode);
71       ]]></programlisting>
72         <para>Once the compiled version of this Java class exists, we can start Scilab and try to get Scilab to show us the various messages.
73             Now the HelloWorld class can be imported into our workspace. This is done using the already mentioned jimport:
74             <screen>
75                 -->jimport com.foo.HelloWorld
76
77                 -->HelloWorld
78                 HelloWorld  =
79
80                 class com.foo.HelloWorld
81
82                 -->whos -name HelloWorld
83                 Name                     Type           Size           Bytes
84
85                 HelloWorld               _EClass        ?              168
86             </screen>
87             <para>
88                 Upon competition, an additional variable named HelloWorld has been created. This is equivalent to a Class object in java. From this class object, new objects of the HelloWorld type can be created.
89             </para>
90             <para>
91                 Creating such an object instance can be done by invoking <link linkend="new">new</link> on the class definition. The arguments to this function are the parameters that are delegated to the Java constructor. The result of this operation is a new Java object reference which can be stored in a variable for later use.
92             </para>
93             <screen>
94                 -->object = HelloWorld.new();
95                 HelloWorld constructed!
96
97                 -->object
98                 object  =
99
100                 com.foo.HelloWorld@49aacd5f
101
102                 -->whos -name object
103                 Name                     Type           Size           Bytes
104
105                 object                   _EObj          ?              160
106             </screen>
107             <para>
108                 What one sees when the <link linkend="new">new</link> operator is called on the JClass, it transparently invokes the Java constructor, and our "HelloWorld constructed!" message appears. The resulting HelloWorld object is stored in the "object" variable. When the variable name is reentered in the command line, the details of its reference are shown. This message can be customized by overriding the toString method in the HelloWorld class.
109             </para>
110             <para>
111                 Now that a specific HelloWorld object has been created, one can try to call the public method that has been declared; <literal>HelloWorld\#message()</literal>. The same natural technique as with <link linkend="new">new</link> can then be applied to invoke the method:
112             </para>
113             <screen>
114                 -->object.message();
115                 Hello world!
116             </screen>
117             <para>
118                 The dot operator (dot between object and message) is actually a handy shortcut and expands the following snippet of Scilab code. The use of this shortcut makes it simpler and cleaner to invoke methods/get member variables.
119             </para>
120             <screen>
121                 -->jinvoke(object, 'message');
122                 Hello world!
123             </screen>
124         </para>
125     </refsection>
126     <refsection>
127         <title>Example 2: Exchanging Scilab and Java primitives</title>
128         <para>
129             This example treats the way you can exchange primitive data types and strings between Scilab and Java. We will be passing various types of objects between these two languages.
130         </para>
131         <para>
132             For this an example class (see Class Inspector) has been defined that takes and returns objects.
133             There are two methods defined. The first takes a double does some arithmetic and returns a result: Inspector#eval(double). The other methods takes any object, shows some basic information and returns it: Inspector#inspect(Object).
134         </para>
135         <programlisting role="java"><![CDATA[
136 // Save under the name Inspector.java
137 package com.foo;
138 public class Inspector {
139         public double eval(double x) {
140                 return x / 2.;
141         }
142
143         public Object inspect(Object prototype) {
144                 System.err.println("Inspecting: '" + prototype + "'");
145                 System.err.println("Class: " + prototype.getClass().getSimpleName());
146                 return prototype;
147         }
148 }
149       ]]></programlisting>
150         <para>
151             As in the previous example, this code must be compiled to Java byte-code before it can be used directly.
152         </para>
153         <programlisting role="example"><![CDATA[
154 // How to compile the Java code from Scilab
155 javacode= mgetl(fullfile(TMPDIR, 'Inspector.java'));
156 jcompile("com.foo.Inspector",javacode);
157       ]]></programlisting>
158         To start, import the Inspector class and create an Inspector object:
159         <screen>
160             -->jimport('com.foo.Inspector');
161
162             -->myInspector = Inspector.new()
163             myInspector  =
164
165             com.foo.Inspector@2a788315
166         </screen>
167
168         Now information between the two systems can be passing along. When passing along any of the Scilab data types into Java, it is automatically wrapped (see <link linkend="jwrap">jwrap</link>) to its Java equivalent. First, an example using the most used data type in Scilab; reals (constant) is given. When passing along a real, this type gets automatically mapped to the Scilab type double. Let's try;
169         <screen>
170             -->result = myInspector.eval(12.5)
171             result  =
172
173             6.25
174
175             -->result * 2
176             ans  =
177
178             12.5
179
180             -->whos -name result
181             Name                     Type           Size           Bytes
182
183             result                   constant       1 by 1         24
184         </screen>
185         The automatic convert is controlled by the jautoUnwrap function. Without this function, all the conversions have to be done explicitly.
186         <screen>
187             -->result = myInspector.eval(12.5)
188             result  =
189
190             6.25
191
192             -->result * 2
193             ans  =
194
195             null
196
197             -->whos -name result
198             Name                     Type           Size           Bytes
199
200             result                   _EObj          ?              160
201         </screen>
202         The result that is returned seems to be correct at first glance ($12.5/2=6.25$). However upon closer inspection, notice that what is returned from our function call is not a number. What we received is another Java object (Double in this case). To be able to use the given data in again in Scilab, the already mentioned <link linkend="junwrap">junwrap</link> functionality can be used if the jautoUnwrap is not set to true.
203         This transforms Java types back to there equivalent Scilab form. From then onward we have a normal number again:
204         <screen>
205             -->result = junwrap(result)
206             result  =
207
208             6.25
209
210             -->whos -name result
211             Name                     Type           Size           Bytes
212
213             result                   constant       1 by 1         24
214
215             -->result * 2
216             ans  =
217
218             12.5
219         </screen>
220
221         From this example is clear how doubles get automatically transformed into a Double, which is used by the Java VM and returned back. When calling <link linkend="junwrap">junwrap</link> on the returned variable, it is transformed back into a native Scilab type. But how do other types work? Let's inspect several of the other primitive types;
222         <screen>
223             -->jautoUnwrap(%f) // Make sure we disable the auto Unwrap
224
225             -->result = myInspector.inspect("Hello world!");
226             Inspecting: 'Hello world!'
227             Class: String
228
229             -->whos -name result
230             Name                     Type           Size           Bytes
231
232             result                   _EObj          ?              160
233
234             -->result = junwrap(result)
235             result  =
236
237             Hello world!
238
239             -->whos -name result
240             Name                     Type           Size           Bytes
241
242             result                   string         1 by 1         72
243
244             // An Integer
245             -->result = myInspector.inspect(int32(150));
246             Inspecting: '150'
247             Class: Integer
248
249             -->result = junwrap(result)
250             result  =
251
252             150
253
254             -->whos -name result
255             Name                     Type           Size           Bytes
256
257             result                   int32          1 by 1         40
258
259             // A boolean
260             -->result = myInspector.inspect(%t);
261             Inspecting: 'true'
262             Class: Boolean
263
264             -->result = junwrap(result)
265             result  =
266
267             T
268
269             -->whos -name result
270             Name                     Type           Size           Bytes
271
272             result                   boolean        1 by 1         16
273
274         </screen>
275
276         As can be seen, all relevant data types are can be transformed transparently between Scilab and Java type. However this also extends without any additional effort to matrices;
277         <screen>
278             --> jautoUnwrap(%t) // Make sure we come back in the default mode where Scilab auto unwrap all calls
279
280             -->result = myInspector.inspect(1:5)
281             Inspecting: '[D@b05236'
282             Class: double[]
283             result  =
284
285             1.    2.    3.    4.    5.
286
287             -->whos -name result
288             Name                     Type           Size           Bytes
289
290             result                   constant       1 by 5         56
291
292             -->result = myInspector.inspect(testmatrix('magi',3))
293             Inspecting: '[[D@11d13272'
294             Class: double[][]
295             result  =
296
297             8.    1.    6.
298             3.    5.    7.
299             4.    9.    2.
300
301             -->whos -name result
302             Name                     Type           Size           Bytes
303
304             result                   constant       3 by 3         88
305         </screen>
306         When looking at the class of these wrapped matrices, it is clear that Java stores them as arrays of the appropriate size. When working with 2D matrices, the data in these equivalent Java arrays can be stored in are column-major (default) or row-major mode. In column-major mode, the first array contains a pointer to each of the columns. Whereas in row-major mode, the first array contains the pointers to each row of data. For more information see <link linkend="jautoTranspose">jautoTranspose</link>.
307     </refsection>
308     <refsection>
309         <title>History</title>
310         <revhistory>
311             <revision>
312                 <revnumber>5.5.0</revnumber>
313                 <revremark>
314                     Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
315                 </revremark>
316             </revision>
317         </revhistory>
318     </refsection>
319 </refentry>
320