doc/jcc/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta content="Apache Forrest" name="Generator">
   6 <meta name="Forrest-version" content="0.8">
   7 <meta name="Forrest-skin-name" content="pelt">
   8 <title>Welcome to JCC, PyLucene's code generator</title>
   9 <link type="text/css" href="../skin/basic.css" rel="stylesheet">
  10 <link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
  11 <link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
  12 <link type="text/css" href="../skin/profile.css" rel="stylesheet">
  13 <script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
  14 <link rel="shortcut icon" href="../">
  15 </head>
  16 <body onload="init()">
  17 <script type="text/javascript">ndeSetTextSize();</script>
  18 <div id="top">
  19 <!--+
  20     |breadtrail
  21     +-->
  22 <div class="breadtrail">
  23 <a href="http://www.apache.org/">apache</a> &gt; <a href="http://lucene.apache.org/">lucene</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
  24 </div>
  25 <!--+
  26     |header
  27     +-->
  28 <div class="header">
  29 <!--+
  30     |start group logo
  31     +-->
  32 <div class="grouplogo">
  33 <a href="http://lucene.apache.org/"><img class="logoImage" alt="Lucene" src="../images/lucene_green_150.gif" title="Lucene Description"></a>
  34 </div>
  35 <!--+
  36     |end group logo
  37     +-->
  38 <!--+
  39     |start Project Logo
  40     +-->
  41 <div class="projectlogoA1">
  42 <a href="http://lucene.apache.org/pylucene/"><img class="logoImage" alt="PyLucene" src="../images/project.png" title="PyLucene Description"></a>
  43 </div>
  44 <!--+
  45     |end Project Logo
  46     +-->
  47 <!--+
  48     |start Tabs
  49     +-->
  50 <ul id="tabs">
  51 <li>
  52 <a class="unselected" href="../index.html">PyLucene</a>
  53 </li>
  54 <li class="current">
  55 <a class="selected" href="../jcc/index.html">JCC</a>
  56 </li>
  57 </ul>
  58 <!--+
  59     |end Tabs
  60     +-->
  61 </div>
  62 </div>
  63 <div id="main">
  64 <div id="publishedStrip">
  65 <!--+
  66     |start Subtabs
  67     +-->
  68 <div id="level2tabs"></div>
  69 <!--+
  70     |end Endtabs
  71     +-->
  72 <script type="text/javascript"><!--
  73 document.write("Last Published: " + document.lastModified);
  74 //  --></script>
  75 </div>
  76 <!--+
  77     |breadtrail
  78     +-->
  79 <div class="breadtrail">
  80
  81              &nbsp;
  82            </div>
  83 <!--+
  84     |start Menu, mainarea
  85     +-->
  86 <!--+
  87     |start Menu
  88     +-->
  89 <div id="menu">
  90 <div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">JCC</div>
  91 <div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
  92 <div onclick="SwitchMenu('menu_selected_1.1.1', '../skin/')" id="menu_selected_1.1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">About</div>
  93 <div id="menu_selected_1.1.1" class="selectedmenuitemgroup" style="display: block;">
  94 <div class="menupage">
  95 <div class="menupagetitle">Index</div>
  96 </div>
  97 </div>
  98 <div onclick="SwitchMenu('menu_1.1.2', '../skin/')" id="menu_1.1.2Title" class="menutitle">Documentation</div>
  99 <div id="menu_1.1.2" class="menuitemgroup">
 100 <div class="menuitem">
 101 <a href="../jcc/documentation/install.html">Installation</a>
 102 </div>
 103 <div class="menuitem">
 104 <a href="../jcc/documentation/readme.html">Features</a>
 105 </div>
 106 <div class="menuitem">
 107 <a href="../jcc/documentation/javadoc/index.html">Javadoc</a>
 108 </div>
 109 </div>
 110 </div>
 111 <div id="credit">
 112 <hr>
 113 <a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="../images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
 114 </div>
 115 <div id="roundbottom">
 116 <img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
 117 <!--+
 118   |alternative credits
 119   +-->
 120 <div id="credit2"></div>
 121 </div>
 122 <!--+
 123     |end Menu
 124     +-->
 125 <!--+
 126     |start content
 127     +-->
 128 <div id="content">
 129 <div title="Portable Document Format" class="pdflink">
 130 <a class="dida" href="index.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
 131         PDF</a>
 132 </div>
 133 <h1>Welcome to JCC, PyLucene's code generator</h1>
 134 <div id="minitoc-area">
 135 <ul class="minitoc">
 136 <li>
 137 <a href="#introduction">What is JCC ?</a>
 138 </li>
 139 <li>
 140 <a href="#requirements">Requirements</a>
 141 </li>
 142 <li>
 143 <a href="#source">Source Code</a>
 144 </li>
 145 <li>
 146 <a href="#contact">Mailing List</a>
 147 </li>
 148 </ul>
 149 </div>
 150
 151 <a name="N1000D"></a><a name="introduction"></a>
 152 <h2 class="boxed">What is JCC ?</h2>
 153 <div class="section">
 154 <p>
 155         JCC is a C++ code generator that produces a C++ object interface
 156         wrapping a Java library via Java's Native Interface (JNI). JCC
 157         also generates C++ wrappers that conform to Python's C type system
 158         making the instances of Java classes directly available to a Python
 159         interpreter.
 160       </p>
 161 <p>
 162         When generating Python wrappers, JCC produces a complete Python
 163         extension module via the <span class="codefrag">distutils</span>
 164         or <a href="http://pypi.python.org/pypi/setuptools"><span class="codefrag">setuptools</span></a>
 165         packages.
 166       </p>
 167 <p>
 168         See <a href="../jcc/documentation/readme.html">here</a> for more
 169         information and documentation about JCC.
 170       </p>
 171 </div>
 172
 173 <a name="N10029"></a><a name="requirements"></a>
 174 <h2 class="boxed">Requirements</h2>
 175 <div class="section">
 176 <p>
 177         JCC is supported on Mac OS X, Linux, Solaris and Windows.
 178       </p>
 179 <p>
 180         JCC requires Python version 2.x (x &gt;= 3.5) and Java version 1.x
 181         (x &gt;= 4). Building JCC requires a C++ compiler. Use of
 182         <a href="http://pypi.python.org/pypi/setuptools"><span class="codefrag">setuptools</span></a>
 183         is recommended.
 184       </p>
 185 <p>
 186         See the <a href="../jcc/documentation/install.html">installation
 187         instructions</a> for more information about building JCC from sources.
 188       </p>
 189 </div>
 190
 191 <a name="N10042"></a><a name="source"></a>
 192 <h2 class="boxed">Source Code</h2>
 193 <div class="section">
 194 <p>
 195         The source code to JCC is part of PyLucene's and can be obtained with
 196         a subversion client
 197         from <a href="http://svn.apache.org/repos/asf/lucene/pylucene/trunk/jcc">here</a>.
 198       </p>
 199 </div>
 200
 201 <a name="N10050"></a><a name="contact"></a>
 202 <h2 class="boxed">Mailing List</h2>
 203 <div class="section">
 204 <p>
 205         If you'd like to contribute to JCC or are having issues or questions
 206         with JCC, please subscribe to the PyLucene developer <a href="../resources/mailing_lists.html">mailing list</a>.
 207       </p>
 208 </div>
 209
 210 </div>
 211 <!--+
 212     |end content
 213     +-->
 214 <div class="clearboth">&nbsp;</div>
 215 </div>
 216 <div id="footer">
 217 <!--+
 218     |start bottomstrip
 219     +-->
 220 <div class="lastmodified">
 221 <script type="text/javascript"><!--
 222 document.write("Last Published: " + document.lastModified);
 223 //  --></script>
 224 </div>
 225 <div class="copyright">
 226         Copyright &copy;
 227          2009-2011 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
 228 </div>
 229 <div id="logos"></div>
 230 <!--+
 231     |end bottomstrip
 232     +-->
 233 </div>
 234 </body>
 235 </html>