File: import_jar.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (105 lines) | stat: -rw-r--r-- 4,259 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2018 OpenLink Software
 -  
 -  This project is free software; you can redistribute it and/or modify it
 -  under the terms of the GNU General Public License as published by the
 -  Free Software Foundation; only version 2 of the License, dated June 1991.
 -  
 -  This program is distributed in the hope that it will be useful, but
 -  WITHOUT ANY WARRANTY; without even the implied warranty of
 -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 -  General Public License for more details.
 -  
 -  You should have received a copy of the GNU General Public License along
 -  with this program; if not, write to the Free Software Foundation, Inc.,
 -  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 -  
 -  
-->
<refentry id="fn_import_jar">
  <refmeta>
    <refentrytitle>import_jar</refentrytitle>
    <refmiscinfo>type</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>import_jar</refname>
    <refpurpose>Creates SQL wrapper types of selected Java classes</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_import_jar">
      <funcprototype id="fproto_import_jar">
        <funcdef>void <function>import_jar</function></funcdef>
	<paramdef>in <parameter>files</parameter> any</paramdef>
	<paramdef>in <parameter>classes</parameter> any</paramdef>
	<paramdef><optional>in <parameter>security_mode</parameter> integer</optional></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_import_jar">
    <title>Description</title>
    <para>This function calls the <function>jvm_ref_import()</function> function 
    to produce the XML, then transforms it to a set of CREATE TYPE statements 
    and executes them.  The SQL names of the types are generated by retrieving 
    the fully qualified name of the Java class and substituting the . with _ 
    (e.g.: java.lang.System becomes java_lang_System).  The names of the static 
    members observer functions are composed by prepending the name of the 
    static member with 'get' so the static Java member stat_m is mapped to a 
    SQL static method getstat_m().  As a result it creates SQL type wrappers 
    for the specified Java classes.</para>
  </refsect1>
  <refsect1 id="params_import_jar">
    <title>Parameters</title>
    <refsect2><title>files</title>
      <para>Null, string or vector of strings.  This can contain one or many 
      Java .class files, .zip or .jar files to pick classes from.  Null means 
      only the classes specified in the classes argument regardless of their 
      physical location.</para>
    </refsect2>
    <refsect2><title>classes</title>
      <para>Wildcard string or a vector of strings specifying which classes to 
      describe in the resulting XML.</para>
    </refsect2>
    <refsect2><title>security_mode</title>
      <para>This optional parameter defines the access mode as follows:</para>
	  <simplelist>
	    <member><emphasis>0</emphasis> - restricted (default if unspecified)</member>
	    <member><emphasis>1</emphasis> - unrestricted</member>
	  </simplelist>
    </refsect2>
  </refsect1>
  <!--
  <refsect1 id="ret_import_jar"><title>Return Types</title>
    <para></para>
  </refsect1>
  <refsect1 id="errors_import_jar">
    <title>Errors</title>
    <para>This function can generate the following errors:</para>
    <errorcode></errorcode>
  </refsect1>
  -->
  <refsect1 id="examples_import_jar">
    <title>Examples</title>
    <example id="ex_import_jar"><title>Simple example</title>
      <screen><![CDATA[
SQL> import_jar (null, vector ('java.lang.System'));
SQL> select java_lang_System::getProperty('java.vm.name');
callret
NVARCHAR
_______________________________________________________________________________

Java HotSpot(TM) Client VM
]]>
</screen>
    </example>
  </refsect1>
  <refsect1 id="seealso_import_jar">
    <title>See Also</title>
    <para><link linkend="fn_unimport_jar"><function>unimport_jar()</function></link></para>
    <para><link linkend="fn_jvm_ref_import"><function>jvm_ref_import()</function></link></para>
  </refsect1>
</refentry>