You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general-cvs@xml.apache.org by vg...@apache.org on 2007/02/24 03:14:29 UTC
svn commit: r511190 [2/17] - in /xml/site/targets/xindice: ./ 1.0/
community/howto/ community/howto/compilation/ community/howto/installation/
dev/ images/ skin/ skin/css/ skin/images/ skin/scripts/ skin/translations/
Modified: xml/site/targets/xindice/1.0/guide-developer.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.0/guide-developer.html?view=diff&rev=511190&r1=511189&r2=511190
==============================================================================
--- xml/site/targets/xindice/1.0/guide-developer.html (original)
+++ xml/site/targets/xindice/1.0/guide-developer.html Fri Feb 23 18:14:25 2007
@@ -1,251 +1,312 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
-<meta name="Forrest-version" content="0.6">
-<meta name="Forrest-skin-name" content="forrest-site">
+<meta name="Forrest-version" content="0.8-dev">
+<meta name="Forrest-skin-name" content="pelt">
<title>Xindice 1.0 Developers Guide</title>
-<link type="text/css" href="../skin/page.css" rel="stylesheet">
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<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>
+<link rel="shortcut icon" href="../">
</head>
-<body text="#000000" bgcolor="#FFFFFF">
-<!--================= start Navigation Path ==================-->
-<table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><a href="http://www.apache.org/">apache</a> > <a href="http://xml.apache.org/">xml.apache</a> > <a href="http://xml.apache.org/xindice/">xindice</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td>
-</tr>
-<tr>
-<td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-</table>
-<!--================= end Navigation Path ==================-->
-<!--================= start Banner ==================-->
-<table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<!--================= start Group Logo ==================-->
-<td bgcolor="#294563"><a href="http://xml.apache.org"><img class="logoImage" alt="XML Apache" src="../images/group-logo.gif"></a></td>
-<!--================= end Group Logo ==================-->
-<!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://xml.apache.org/xindice/"><img class="logoImage" alt="Xindice" src="../images/xindice.gif"></a></td>
-<!--================= end Project Logo ==================-->
-<!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563">
-<form target="_blank" action="http://www.google.com/search" method="get">
-<table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
-<tr>
-<td colspan="3"><img height="10" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap"><input value="xml.apache.org" name="as_sitesearch" type="hidden"><input size="15" name="as_q" id="query" type="text"><img height="1" width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><input name="Search" value="Search" type="submit">
-<br>
-<font face="Arial, Helvetica, Sans-serif" size="2" color="white">
- the Apache XML site
-
-
- </font></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td><img alt="" border="0" height="10" width="9" src="../skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td><img alt="" border="0" height="10" width="9" src="../skin/images/search-right.gif"></td>
-</tr>
-</table>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://xml.apache.org/">xml.apache</a> > <a href="http://xml.apache.org/xindice/">xindice</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://xml.apache.org"><img class="logoImage" alt="XML Apache" src="../images/group-logo.gif" title="Apache XML Project"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://xml.apache.org/xindice/"><img class="logoImage" alt="Xindice" src="../images/xindice.gif" title="Apache Xindice: Native XML database"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="xml.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
</form>
-</td>
-<!--================= end Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td valign="bottom" bgcolor="#294563" colspan="2">
-<!--================= start Tabs ==================-->
-<div class="tab">
-<table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td width="6"><img alt="" height="8" width="6" src="../skin/images/spacer.gif"></td><td valign="bottom">
-<table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a class="base-not-selected" href="../index.html">Home</a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
-</tr>
-<tr>
-<td colspan="3" height="1"></td>
-</tr>
-</table>
-</td><td width="6"><img alt="" height="8" width="6" src="../skin/images/spacer.gif"></td><td valign="bottom">
-<table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a class="base-not-selected" href="../community/howto/index.html">How-Tos</a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
-</tr>
-<tr>
-<td colspan="3" height="1"></td>
-</tr>
-</table>
-</td><td width="6"><img alt="" height="8" width="6" src="../skin/images/spacer.gif"></td><td valign="bottom">
-<table summary="selected tab" style="height: 1.8em" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a class="base-selected" href="../1.0/index.html">1.0</a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-right.gif"></td>
-</tr>
-</table>
-</td><td width="6"><img alt="" height="8" width="6" src="../skin/images/spacer.gif"></td><td valign="bottom">
-<table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a class="base-not-selected" href="../dev/index.html">Dev</a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="../skin/images/tab-right.gif"></td>
-</tr>
-<tr>
-<td colspan="3" height="1"></td>
-</tr>
-</table>
-</td>
-</tr>
-</table>
-</div>
-<!--================= end Tabs ==================-->
-</td><td bgcolor="#294563"></td>
-</tr>
-<tr>
-<td height="10" bgcolor="#4C6C8F" colspan="4"></td>
-</tr>
-</table>
-<!--================= end Banner ==================-->
-<!--================= start Menu, NavBar, Content ==================-->
-<table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td valign="top">
-<table summary="menu" border="0" cellspacing="0" cellpadding="0">
-<tr>
-<!--================= start left top NavBar ==================-->
-<td rowspan="3" valign="top">
-<table summary="blue line" border="0" cellpadding="0" cellspacing="0">
-<tr>
-<td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif"> </font></td>
-</tr>
-<tr>
-<td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-</table>
-</td>
-<!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F">
-<!--================= start Menu items ==================-->
-<div class="menu">
-<ul>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
<li>
-<font color="#CFDCED">Overview</font>
-<ul>
-
+<a class="unselected" href="../index.html">Home</a>
+</li>
<li>
-<a href="../index.html">Back</a>
+<a class="unselected" href="../community/howto/index.html">How-Tos</a>
+</li>
+<li class="current">
+<a class="selected" href="../1.0/index.html">1.0</a>
</li>
-
<li>
+<a class="unselected" href="../dev/index.html">Dev</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
<a href="index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="changes.html">Changes</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="guide-administrator.html">Administrator Guide</a>
+</div>
+<div class="menuitem">
+<a href="guide-user.html">User Guide</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Developer Guide</div>
+</div>
+<div class="menuitem">
+<a href="guide-tools.html">Tool Guide</a>
+</div>
+<div class="menuitem">
+<a href="faq.html">FAQ</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Resources</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<script language="Javascript" type="text/javascript">
+function printit() {
+ if (window.print) {
+ window.focus();
+ window.print();
+ }
+}
+ </script><script language="Javascript" type="text/javascript">
+var NS = (navigator.appName == "Netscape");
+var VERSION = parseInt(navigator.appVersion);
+if (VERSION > 3) {
+ document.write('<div title="Print this Page" class="printlink">');
+ document.write(' <a class="dida" href="javascript:printit()">');
+ document.write(' <img alt="print - icon" src="../skin/images/printer.gif" class="skin">');
+ document.write(' <br>');
+ document.write(' PRINT</a>');
+ document.write('</div>');
+}
+ </script>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="guide-developer.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Xindice 1.0 Developers Guide</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Introduction+to+Programming+Xindice">Introduction to Programming Xindice</a>
+<ul class="minitoc">
+<li>
+<a href="#Accessing+the+Server">Accessing the Server</a>
+<ul class="minitoc">
+<li>
+<a href="#API%27s">API's</a>
+</li>
+</ul>
</li>
-
<li>
-<a href="changes.html">Changes</a>
+<a href="#Introducing+the+XML%3ADB+XML+Database+API">Introducing the XML:DB XML Database API</a>
+</li>
+<li>
+<a href="#Setting+up+Your+Build+Environment">Setting up Your Build Environment</a>
+</li>
+<li>
+<a href="#Preparing+the+Server+For+the+Examples">Preparing the Server For the Examples</a>
+</li>
+<li>
+<a href="#Diving+in+With+an+Example+Program">Diving in With an Example Program</a>
+<ul class="minitoc">
+<li>
+<a href="#Simple+XML%3ADB+Example+Program">Simple XML:DB Example Program</a>
</li>
-
</ul>
</li>
<li>
-<font color="#CFDCED">Documentation</font>
-<ul>
-
+<a href="#Accessing+Xindice+Remotely">Accessing Xindice Remotely</a>
+</li>
+</ul>
+</li>
<li>
-<a href="guide-administrator.html">Administrator Guide</a>
+<a href="#Managing+Documents">Managing Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Creating+a+Collection">Creating a Collection</a>
+<ul class="minitoc">
+<li>
+<a href="#Creating+a+Collection-N101D5">Creating a Collection</a>
+</li>
+</ul>
</li>
-
<li>
-<a href="guide-user.html">User Guide</a>
+<a href="#Working+with+Documents">Working with Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Example+Document">Example Document</a>
</li>
-
<li>
-<span class="sel"><font color="#ffcc00">Developer Guide</font></span>
+<a href="#Adding+an+XML+File+to+the+Database">Adding an XML File to the Database</a>
</li>
-
<li>
-<a href="guide-tools.html">Tool Guide</a>
+<a href="#Retrieving+an+XML+Document+from+the+Database">Retrieving an XML Document from the Database</a>
</li>
-
<li>
-<a href="faq.html">FAQ</a>
+<a href="#Deleting+an+XML+Document+from+the+Database">Deleting an XML Document from the Database</a>
+</li>
+</ul>
</li>
-
</ul>
</li>
<li>
-<font color="#CFDCED">Resources</font>
-<ul>
-
+<a href="#Using+XPath+to+Query+the+Database">Using XPath to Query the Database</a>
+<ul class="minitoc">
<li>
-<a class="external" href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#Using+the+XML%3ADB+Java+API">Using the XML:DB Java API</a>
+<ul class="minitoc">
+<li>
+<a href="#Querying+with+XPath">Querying with XPath</a>
+</li>
+<li>
+<a href="#Query+Results">Query Results</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Using+XUpdate+to+Modify+the+Database">Using XUpdate to Modify the Database</a>
+<ul class="minitoc">
+<li>
+<a href="#Introduction-N10285">Introduction</a>
+<ul class="minitoc">
+<li>
+<a href="#Basic+XUpdate+Insert+Command">Basic XUpdate Insert Command</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#XUpdate+Commands">XUpdate Commands</a>
+</li>
+<li>
+<a href="#XUpdate+Node+Construction">XUpdate Node Construction</a>
+</li>
+<li>
+<a href="#Using+the+XML%3ADB+API+for+XUpdate">Using the XML:DB API for XUpdate</a>
+<ul class="minitoc">
+<li>
+<a href="#Using+XUpdate+to+modify+the+database">Using XUpdate to modify the database</a>
</li>
-
</ul>
</li>
</ul>
+</li>
+<li>
+<a href="#Address+Book+Example+Application">Address Book Example Application</a>
+<ul class="minitoc">
+<li>
+<a href="#"></a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Experimental+Features">Experimental Features</a>
+</li>
+</ul>
</div>
-<!--================= end Menu items ==================-->
-</td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-right.gif"></td>
-</tr>
-<tr>
-<td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-</table>
-</td><td valign="top" width="100%">
-<table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0">
-<!--================= start middle NavBar ==================-->
-<tr>
-<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
-
-
- </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
-
-
- </font><img width="10" height="8" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<tr>
-<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<!--================= end middle NavBar ==================-->
-<!--================= start Content==================-->
-<tr>
-<td align="left" width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td colspan="2" align="left" width="100%">
-<div class="content">
-<table class="title" summary="">
-<tr>
-<td valign="middle">
-<h1>Xindice 1.0 Developers Guide</h1>
-</td><script language="Javascript" type="text/javascript">
-function printit() {
- if (window.print) {
- window.focus();
- window.print();
- }
-}
-</script><script language="Javascript" type="text/javascript">
-var NS = (navigator.appName == "Netscape");
-var VERSION = parseInt(navigator.appVersion);
-if (VERSION > 3) {
- document.write('<td nowrap="nowrap" width="40" align="center">');
- document.write(' <a class="dida" href="javascript:printit()">');
- document.write(' <img alt="Print this Page" src="../skin/images/printer.gif" class="skin"><br>');
- document.write(' print</a>');
- document.write('</td>');
-}
-</script><td nowrap="nowrap" width="40" align="center"><a class="dida" href="guide-developer.pdf"><img alt="PDF" src="../skin/images/pdfdoc.gif" class="skin"><br>
- PDF</a></td>
-</tr>
-</table>
<a name="N10019"></a><a name="Introduction+to+Programming+Xindice"></a>
-<h3>Introduction to Programming Xindice</h3>
-<div style="margin-left: 0 ; border: 2px">
+<h2 class="h3">Introduction to Programming Xindice</h2>
+<div class="section">
<a name="N1001F"></a><a name="Accessing+the+Server"></a>
-<h4>Accessing the Server</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Accessing the Server</h3>
<p>
The Xindice server can be accessed either programmatically through
the server's APIs or from the command line using the provided
@@ -255,8 +316,7 @@
<a href="guide-user.html">Xindice Users Guide</a>.
</p>
<a name="N1002C"></a><a name="API%27s"></a>
-<h5>API's</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>API's</h4>
<p>
Xindice currently offers three layers of APIs that can be used to
develop applications.
@@ -291,11 +351,10 @@
</li>
</ul>
-</div>
<p>
The most common API for end user
applications is the XML:DB XML Database API that was developed
- by the <a class="external" href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>.
+ by the <a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>.
This API is
a vendor neutral API intended to make it possible to build
applications that will work with more then one XML database
@@ -303,7 +362,7 @@
capabilities provided by JDBC for relational databases. More
information about this
API can be found on the XML:DB Initiative web site,
- <a class="external" href="http://xmldb-org.sourceforge.net/">http://xmldb-org.sourceforge.net/</a>. Most
+ <a href="http://xmldb-org.sourceforge.net/">http://xmldb-org.sourceforge.net/</a>. Most
programming examples in this manual will use the XML:DB API. The
Xindice implementation of the API is a Core Level 1 implementation.
</p>
@@ -327,13 +386,11 @@
when looking at the development of XMLObjects.
-->
</p>
-</div>
<a name="N10056"></a><a name="Introducing+the+XML%3ADB+XML+Database+API"></a>
-<h4>Introducing the XML:DB XML Database API</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Introducing the XML:DB XML Database API</h3>
<p>
XML:DB API is being developed by the
- <a class="external" href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a> to
+ <a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a> to
facilitate the development of applications that function with
minimal change on more then one XML database.
This is roughly
@@ -419,10 +476,8 @@
for all the command line tools can be found in
<span class="codefrag">Xindice/java/src/org/apache/xindice/tools/command</span>.
</p>
-</div>
<a name="N1008D"></a><a name="Setting+up+Your+Build+Environment"></a>
-<h4>Setting up Your Build Environment</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Setting up Your Build Environment</h3>
<p>
Before you can build applications for Xindice you need to make sure you
have your build environment properly setup. This mainly consists of
@@ -471,10 +526,8 @@
</li>
</ul>
-</div>
<a name="N100C1"></a><a name="Preparing+the+Server+For+the+Examples"></a>
-<h4>Preparing the Server For the Examples</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Preparing the Server For the Examples</h3>
<p>
Before we get to some example code, we need to do a little work to setup the
server. Don't worry nothing hard.
@@ -512,13 +565,10 @@
<p>
That wasn't so bad and now we're set to look at some example code.
</p>
-</div>
<a name="N100E9"></a><a name="Diving+in+With+an+Example+Program"></a>
-<h4>Diving in With an Example Program</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Diving in With an Example Program</h3>
<a name="N100EF"></a><a name="Simple+XML%3ADB+Example+Program"></a>
-<h5>Simple XML:DB Example Program</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Simple XML:DB Example Program</h4>
<p>
This example simply executes an XPath query against a
collection, retrieves the results as text and prints them out.
@@ -566,7 +616,6 @@
}
}
}</pre>
-</div>
<p>
Before diving into the gory detail of what this program is doing, let's
run it and see what we get back.
@@ -762,10 +811,8 @@
close on the collection will result in a
resource leak within the server.
</p>
-</div>
<a name="N1019D"></a><a name="Accessing+Xindice+Remotely"></a>
-<h4>Accessing Xindice Remotely</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Accessing Xindice Remotely</h3>
<p>
By default Xindice assumes that the client and server are running on
the same machine. In most configurations this will not be the case
@@ -796,11 +843,10 @@
shouldn't have any problems.
</p>
</div>
-</div>
<a name="N101B4"></a><a name="Managing+Documents"></a>
-<h3>Managing Documents</h3>
-<div style="margin-left: 0 ; border: 2px">
+<h2 class="h3">Managing Documents</h2>
+<div class="section">
<p>
In this chapter we'll look at using the XML:DB API to manage documents
within the Xindice server. As part of this we'll look at some sample code
@@ -818,8 +864,7 @@
however Xindice does not implement anything beyond XMLResource.
</p>
<a name="N101C0"></a><a name="Creating+a+Collection"></a>
-<h4>Creating a Collection</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Creating a Collection</h3>
<p>
Before we can work with any data in the database we need to create
a collection to hold our data.
@@ -838,8 +883,7 @@
collection.
</p>
<a name="N101D5"></a><a name="Creating+a+Collection-N101D5"></a>
-<h5>Creating a Collection</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Creating a Collection</h4>
<pre class="code">package org.apache.xindice.examples;
import org.xmldb.api.base.*;
@@ -888,7 +932,6 @@
}
}
}</pre>
-</div>
<p>
With this example you can see a basic example of how to create the
<span class="codefrag">CollectionManager</span> service and use it to create
@@ -907,10 +950,8 @@
and the source code for the command line tools. Future versions of
this documentation will cover this area in more detail.
</p>
-</div>
<a name="N101ED"></a><a name="Working+with+Documents"></a>
-<h4>Working with Documents</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Working with Documents</h3>
<p>
Now that we have a collection to store our data, we need to add
some data to it. We could use the command line tools
@@ -925,8 +966,7 @@
Each address book entry is stored in a seperate XML file.
</p>
<a name="N101F9"></a><a name="Example+Document"></a>
-<h5>Example Document</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Example Document</h4>
<pre class="code"><person>
<fname>John</fname>
<lname>Smith</lname>
@@ -937,14 +977,12 @@
<address type="home">34 S. Colon St.</address>
<address type="work">9967 W. Shrimp Ave.</address>
</person></pre>
-</div>
<p>
If we store this example XML into a file we can then load it into
our addressbook collection using a simple program.
</p>
<a name="N10207"></a><a name="Adding+an+XML+File+to+the+Database"></a>
-<h5>Adding an XML File to the Database</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Adding an XML File to the Database</h4>
<pre class="code">package org.apache.xindice.examples;
import org.xmldb.api.base.*;
@@ -995,7 +1033,6 @@
return new String(fileBuffer);
}
}</pre>
-</div>
<p>
Much of this program is similar to what we've already seen in our
other XML:DB programs. Really the only difference is the code to add
@@ -1030,8 +1067,7 @@
collection from which it was originally created.
</p>
<a name="N10228"></a><a name="Retrieving+an+XML+Document+from+the+Database"></a>
-<h5>Retrieving an XML Document from the Database</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Retrieving an XML Document from the Database</h4>
<pre class="code">package org.apache.xindice.examples;
import org.xmldb.api.base.*;
@@ -1071,10 +1107,8 @@
}
}
}</pre>
-</div>
<a name="N10233"></a><a name="Deleting+an+XML+Document+from+the+Database"></a>
-<h5>Deleting an XML Document from the Database</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Deleting an XML Document from the Database</h4>
<pre class="code">package org.apache.xindice.examples;
import org.xmldb.api.base.*;
@@ -1110,15 +1144,12 @@
}
}</pre>
</div>
-</div>
-</div>
<a name="N10240"></a><a name="Using+XPath+to+Query+the+Database"></a>
-<h3>Using XPath to Query the Database</h3>
-<div style="margin-left: 0 ; border: 2px">
+<h2 class="h3">Using XPath to Query the Database</h2>
+<div class="section">
<a name="N10246"></a><a name="Introduction"></a>
-<h4>Introduction</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Introduction</h3>
<p>
Xindice currently supports XPath as a query language. In many
applications XPath is only applied at the document level but in
@@ -1130,10 +1161,8 @@
particular XPaths to speed up commonly used XPath queries.
</p>
-</div>
<a name="N10250"></a><a name="Using+the+XML%3ADB+Java+API"></a>
-<h4>Using the XML:DB Java API</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Using the XML:DB Java API</h3>
<p>
The XML:DB API defines operations for searching single documents as
well as collections of XML documents using XPath. These operations
@@ -1143,8 +1172,7 @@
collection you use the <span class="codefrag">query()</span> method.
</p>
<a name="N1025F"></a><a name="Querying+with+XPath"></a>
-<h5>Querying with XPath</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Querying with XPath</h4>
<p>This example simply executes an XPath query against a
collection, retrieves the results as text and prints them out.
</p>
@@ -1190,10 +1218,8 @@
}
}
}</pre>
-</div>
<a name="N10270"></a><a name="Query+Results"></a>
-<h5>Query Results</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Query Results</h4>
<p>
XPath queries always return anonymous resources. An anonymous
resource is one that has no Resource ID. If a resource is anonymous,
@@ -1215,17 +1241,14 @@
document, then the ID may be used as a locator of the returned Resource
interchangeably with the XPath query.
</p>
-</div>
<p>TODO: cover namespace support</p>
</div>
-</div>
<a name="N1027F"></a><a name="Using+XUpdate+to+Modify+the+Database"></a>
-<h3>Using XUpdate to Modify the Database</h3>
-<div style="margin-left: 0 ; border: 2px">
+<h2 class="h3">Using XUpdate to Modify the Database</h2>
+<div class="section">
<a name="N10285"></a><a name="Introduction-N10285"></a>
-<h4>Introduction</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Introduction</h3>
<p>
XUpdate is a specification under development by the XML:DB Initiative
to enable simpler updating of XML documents. It is useful within the
@@ -1233,14 +1256,14 @@
for general XML applications. XUpdate gives you a declarative method
to insert nodes, remove nodes, and change nodes within an XML
document. The syntax is specified in the
- <a class="external" href="http://xmldb-org.sourceforge.net/xupdate/xupdate-wd.html">
+ <a href="http://xmldb-org.sourceforge.net/xupdate/xupdate-wd.html">
XUpdate working draft</a> available on the XML:DB
Initiative website.
</p>
<p>
The XUpdate implementation in Xindice is based around the
Lexus XUpdate implementation that was developed by the
- <a class="external" href="http://www.infozone-group.org/">Infozone Group</a>.
+ <a href="http://www.infozone-group.org/">Infozone Group</a>.
</p>
<p>
The general model around XUpdate is to use an
@@ -1256,8 +1279,7 @@
selected nodes.
</p>
<a name="N102A2"></a><a name="Basic+XUpdate+Insert+Command"></a>
-<h5>Basic XUpdate Insert Command</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Basic XUpdate Insert Command</h4>
<pre class="code"><xupdate:modifications version="1.0"
xmlns:xupdate="http://www.xmldb.org/xupdate">
@@ -1272,11 +1294,8 @@
</xupdate:insert-after>
</xupdate:modifications></pre>
-</div>
-</div>
<a name="N102AE"></a><a name="XUpdate+Commands"></a>
-<h4>XUpdate Commands</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">XUpdate Commands</h3>
<ul>
<li>
@@ -1315,10 +1334,8 @@
</li>
</ul>
-</div>
<a name="N102E2"></a><a name="XUpdate+Node+Construction"></a>
-<h4>XUpdate Node Construction</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">XUpdate Node Construction</h3>
<ul>
<li>
@@ -1352,10 +1369,8 @@
</li>
</ul>
-</div>
<a name="N1030D"></a><a name="Using+the+XML%3ADB+API+for+XUpdate"></a>
-<h4>Using the XML:DB API for XUpdate</h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4">Using the XML:DB API for XUpdate</h3>
<p>
The XML:DB API provides an XUpdateQueryService to enable executing
XUpdate commands against single documents or collections of
@@ -1373,8 +1388,7 @@
</p>
<a name="N10325"></a><a name="Using+XUpdate+to+modify+the+database"></a>
-<h5>Using XUpdate to modify the database</h5>
-<div style="margin-left: 0 ; border: 2px">
+<h4>Using XUpdate to modify the database</h4>
<pre class="code">
import org.xmldb.api.base.*;
import org.xmldb.api.modules.*;
@@ -1420,8 +1434,6 @@
}
</pre>
</div>
-</div>
-</div>
<!--
<section>
<title>Using XMLObjects</title>
@@ -1746,11 +1758,10 @@
-->
<a name="N10334"></a><a name="Address+Book+Example+Application"></a>
-<h3>Address Book Example Application</h3>
-<div style="margin-left: 0 ; border: 2px">
+<h2 class="h3">Address Book Example Application</h2>
+<div class="section">
<a name="N1033A"></a>
-<h4></h4>
-<div style="margin-left: 0 ; border: 2px">
+<h3 class="h4"></h3>
<p>
The address book example is a simple servlet based application
constructued using Xindice. For more information on this example look
@@ -1761,11 +1772,10 @@
TODO: Add more detail about building servlet applications.
</p>
</div>
-</div>
<a name="N1034A"></a><a name="Experimental+Features"></a>
-<h3>Experimental Features</h3>
-<div style="margin-left: 0 ; border: 2px">
+<h2 class="h3">Experimental Features</h2>
+<div class="section">
<p>
There are a couple features in Xindice that are definitely
experimental. These features can be interesing to explore to see some
@@ -1774,36 +1784,30 @@
</p>
</div>
-<div class="attribution">by Kimbro Staken; <span class="version">
- version 193056</span>
+<p align="right">
+<font size="-2">by Kimbro Staken</font>
+</p>
</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2001-2007 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
</div>
-</td><td width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
-</tr>
-<!--================= end Content==================-->
-</table>
-</td>
-</tr>
-</table>
-<!--================= end Menu, NavBar, Content ==================-->
-<!--================= start Footer ==================-->
-<table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
-<tr>
-<td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"><a href="../skin/images/label.gif"></a><a href="../skin/images/page.gif"></a><a href="../skin/images/chapter.gif"></a><a href="../skin/images/chapter_open.gif"></a><a href="../skin/images/current.gif"></a></td>
-</tr>
-<tr>
-<td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">
- Copyright © 2001-2003
- The Apache Software Foundation.
- All rights reserved.
- <script type="text/javascript" language="JavaScript"><!--
- document.write(" - "+"Last Published: " + document.lastModified);
- // --></script></font></td>
-</tr>
-<tr>
-<td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
-</tr>
-</table>
-<!--================= end Footer ==================-->
</body>
</html>
Modified: xml/site/targets/xindice/1.0/guide-developer.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.0/guide-developer.pdf?view=diff&rev=511190&r1=511189&r2=511190
==============================================================================
Binary files - no diff available.
---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org