added japanese translation of java external object.
[scilab.git] / scilab / modules / external_objects_java / help / ja_JP / jcreatejar.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4 *
5 *  ======================================================================
6 *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
7 *  Copyright (C) 2013 - Scilab Enterprises - Simon MARCHETTO
8 *
9 *  This file is distributed under the same license as the Scilab package.
10 * =======================================================================
11 *
12 -->
13
14 <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="ja" xml:id="jcreatejar">
15     
16     <refnamediv>
17         
18         <refname>jcreatejar</refname>
19         
20         <refpurpose>
21             
22             ファイル/ディレクトリからJava ARchive (JAR) を作成
23             
24         </refpurpose>
25         
26     </refnamediv>
27     
28     <refsynopsisdiv>
29         
30         <title>呼び出し手順</title>
31         
32         <synopsis>
33             
34             jcreatejar(jarFilePath, filePaths[, rootPath[, manifestFilePath]])
35             
36         </synopsis>
37         
38     </refsynopsisdiv>
39     
40     <refsection>
41         
42         <title>パラメータ</title>
43         
44         <variablelist>
45             
46             <varlistentry>
47                 
48                 <term>jarFilePath</term>
49                 
50                 <listitem>
51                     
52                     <para>
53                         
54                         JARのファイルパスの説明を有する文字列.
55                         
56                     </para>
57                     
58                 </listitem>
59                 
60             </varlistentry>
61             
62             <varlistentry>
63                 
64                 <term>filePaths</term>
65                 
66                 <listitem>
67                     
68                     <para>
69                         
70                         JARに含まれる
71                         
72                         入力ファイル/ディレクトリのパスを有する
73                         
74                         行/列文字列行列
75                         
76                     </para>
77                     
78                 </listitem>
79                 
80             </varlistentry>
81             
82             <varlistentry>
83                 
84                 <term>rootPath</term>
85                 
86                 <listitem>
87                     
88                     <para>
89                         
90                         オプションの文字列で,
91                         
92                         全ての入力ファイル/ディレクトリのJARにおける
93                         
94                         相対パスを計算する際に使用されるパスを設定.
95                         
96                     </para>
97                     
98                 </listitem>
99                 
100             </varlistentry>
101             
102             <varlistentry>
103                 
104                 <term>manifestFilePath</term>
105                 
106                 <listitem>
107                     
108                     <para>
109                         
110                         オプション文字列で,
111                         
112                         JARに含まれるmanifestデータのファイルパスを指定.
113                         
114                     </para>
115                     
116                 </listitem>
117                 
118             </varlistentry>
119             
120         </variablelist>
121         
122     </refsection>
123     
124     <refsection>
125         
126         <title>説明</title>
127         
128         <para>
129             
130             一連の入力ファイル/ディレクトリからJAR (Java ARchive) ファイルを
131             
132             作成します.
133             
134             典型的な使用例は, (Javaクラスを含む) Javaパッケージです.
135             
136             例えば, 関数 
137             
138             <link linkend="ilib_build_jar">ilib_build_jar</link> は
139             
140             Javaソースを有するツールボックスを構築する際に
141             
142             <literal>jcreatejar</literal>を使用します.
143             
144             しかし, <literal>jcreatejar</literal> は任意の型の
145             
146             ファイルを圧縮する際にも使用できます
147             
148             (例えば, ネットワーク経由でファイルを送信する場合).
149             
150         </para>
151         
152         <para>
153             
154             多くの場合, JARファイルは単一のファイルツリーから作成され,
155             
156             JARファイル内のパスツリーは入力パスツリーと同じです.
157             
158             このため, <literal>jcreatejar</literal>に 
159             
160             一連のファイルとディレクトリが指定された場合,
161             
162             これらのファイル/ディレクトリのルートパスを自動的に求め,
163             
164             ルートパスに対して相対的にJAR内のパスを設定します.
165             
166             ルートパスは<literal>rootPath</literal>引数により
167             
168             明示的に指定することも可能です.
169             
170         </para>
171         
172         <para>
173             
174             JARファイルはJARの内容を記述するデータを含むmanifestを有します.
175             
176             JAR内では, このmanifestは<literal>META-INF</literal>フォルダの
177             
178             ファイル<literal>MANIFEST.MF</literal> です.
179             
180             このmanifestファイルは自動的に入力ツリーのこの場所で見つけるか,
181             
182             <literal>manifestFilePath</literal> 引数でmanifestのパスを
183             
184             指定することができます.
185             
186             manifestファイルが見つからない場合,デフォルトのmanifestが
187             
188             JAR内で作成されます.
189             
190             注意: manifestが指定された場合, version 属性を有する必要があります.
191             
192             そうでない場合, JAR内のmanifestは空になります.
193             
194         </para>
195         
196         <para>
197             
198             引数 <literal>jarFilePath</literal> に保存された
199             
200             JARディストリビューションのファイルパスは
201             
202             は拡張子 <literal>.jar</literal>を有している必要があります.
203             
204             出力先のJARファイルが既に存在している場合,
205             
206             上書きされます.
207             
208         </para>
209         
210     </refsection>
211     
212     <refsection>
213         
214         <title>例</title>
215         
216         <programlisting role="example"><![CDATA[
217 // Example of jcreatejar: create a JAR containing a Java package
218
219 // Create a directory for package sources
220 jar_src_path = fullfile(TMPDIR, 'jarPackageExample');
221 mkdir(jar_src_path);
222
223 // Create a Java source and compiles it to a Java class
224 function createJavaClass(class_name, code)
225     class_src_path = fullfile(jar_src_path, class_name + '.java');
226     fd = mopen(class_src_path, 'wt');
227     mputl(code, fd);
228     mclose(fd);
229     jcompile(class_src_path);
230 endfunction
231
232 // Create a class in the root of the package
233 createJavaClass('Class1', msprintf( ..
234     'package jarPackageExample;\n' + ..
235     'public class Class1 {}'));
236
237 // Create another class in a folder of the package
238 mkdir(fullfile(jar_src_path, 'folder'));
239 createJavaClass('folder/Class2', msprintf( ..
240     'package jarPackageExample.folder;\n' + ..
241     'public class Class2 {}'));
242
243 // The compiled package is in TMPDIR in JIMS folder
244 jar_tmp_path = fullfile(TMPDIR, 'JIMS/bin/jarPackageExample');
245
246 // Create the package JAR
247 jar_dest_path = fullfile(TMPDIR, 'jarPackageExample.jar');
248 jcreatejar(jar_dest_path, jar_tmp_path);
249       ]]></programlisting>
250         
251         <programlisting role="example"><![CDATA[
252 // Example of jcreatejar: create a JAR containing images, and add a manifest
253
254 // Create the manifest file
255 manifest_path = fullfile(TMPDIR, 'MANIFEST.MF');
256 manifest = msprintf('Manifest-Version: 1.0\nName: Scilab images');
257 fd = mopen(manifest_path, 'wt');
258 mputl(manifest, fd);
259 mclose(fd);
260
261 // Create the JAR
262 jar_src_path = fullfile(SCI, 'modules/gui/images/icons');
263 jar_dest_path = fullfile(TMPDIR, 'jarImagesExample.jar');
264 jcreatejar(jar_dest_path, jar_src_path, '', manifest_path);
265       ]]></programlisting>
266         
267     </refsection>
268     
269     <refsection role="see also">
270         
271         <title>参照</title>
272         
273         <simplelist type="inline">
274             
275             <member>
276                 
277                 <link linkend="jcompile">jcompile</link>
278                 
279             </member>
280             
281             <member>
282                 
283                 <link linkend="javaclasspath">javaclasspath</link>
284                 
285             </member>
286             
287         </simplelist>
288         
289     </refsection>
290     
291     <refsection>
292         
293         <title>履歴</title>
294         
295         <revhistory>
296             
297             <revision>
298                 
299                 <revnumber>5.5.0</revnumber>
300                 
301                 <revremark>
302                     
303                     関数が導入されました.
304                     
305                 </revremark>
306                 
307             </revision>
308             
309         </revhistory>
310         
311     </refsection>
312     
313 </refentry>
314
315
316