[dna-commits] DNA SVN: r860 - in trunk/docs: reference/src/main/docbook/en-US/content and 1 other directory.

Author: rhauch Date: 2009-04-28 11:04:22 -0400 (Tue, 28 Apr 2009) New Revision: 860 Modified: trunk/docs/gettingstarted/src/main/docbook/en-US/content/introduction.xml trunk/docs/gettingstarted/src/main/docbook/en-US/content/understanding_dna.xml trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml trunk/docs/reference/src/main/docbook/en-US/content/jcr.xml trunk/docs/reference/src/main/docbook/en-US/content/sequencing.xml Log: DNA-385 Documentation Updates for 0.4 Applied the patch that updated some of the content in the Getting Started and Reference Guide documents. Modified: trunk/docs/gettingstarted/src/main/docbook/en-US/content/introduction.xml =================================================================== --- trunk/docs/gettingstarted/src/main/docbook/en-US/content/introduction.xml 2009-04-28 01:50:54 UTC (rev 859) +++ trunk/docs/gettingstarted/src/main/docbook/en-US/content/introduction.xml 2009-04-28 15:04:22 UTC (rev 860) @@ -95,7 +95,7 @@ </para> <para> JBoss DNA has other features as well. You can create federated repositories that dynamically merge the information from multiple databases, services, applications, and other JCR repositories. JBoss DNA also will allow you to - create customized views based upon the type of data and the role of the user that is accessing the data. And yet another is + create customized views based upon the type of data and the role of the user that is accessing the data. And yet another goal is to create a REST-ful API to allow the JCR content to be accessed easily by other applications written in other languages. </para> <para> Modified: trunk/docs/gettingstarted/src/main/docbook/en-US/content/understanding_dna.xml =================================================================== --- trunk/docs/gettingstarted/src/main/docbook/en-US/content/understanding_dna.xml 2009-04-28 01:50:54 UTC (rev 859) +++ trunk/docs/gettingstarted/src/main/docbook/en-US/content/understanding_dna.xml 2009-04-28 15:04:22 UTC (rev 860) @@ -32,7 +32,7 @@ <para>JBoss DNA is a repository and set of tools that make it easy to capture, version, analyze, and understand the fundamental building blocks of information. As models, service and process definitions, schemas, source code, and other artifacts are added to the repository, JBoss DNA "sequences" the makeup of these components and extracts their structure - and interdependencies. The JBoss DNA web application allows end users to access, visualize, and edit this information in + and interdependencies. The JBoss DNA web application will allow end users to access, visualize, and edit this information in the terminology and structure they are familiar with. Such domain-specific solutions can be easily created with little or no programming.</para> <para> JBoss DNA supports the Java Content Repository (JCR) standard and is able to provide a single integrated view of @@ -356,10 +356,16 @@ <title>Connecting to information sources</title> <para> JBoss DNA uses connectors to interact with different information sources to get at the content - in those systems. Some ideas for connectors include:</para> + in those systems. We already have some connectors, including:</para> <itemizedlist> <listitem> <para> + <emphasis role="strong">In-Memory Connector</emphasis> + - Uses a Map instance as a repository. This is a simple connector that works really well for small and transient graphs. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">JBoss Cache Connector</emphasis> - Uses a JBoss Cache instance as a repository. JBoss Cache is a powerful cache capable of persisting the information and being clustered for concurrent use by multiple processes. @@ -372,28 +378,22 @@ This is a powerful connector that is discussed in more detail in the <link linkend="federated_repositories">next section</link>. </para> </listitem> - </itemizedlist> - <para>There are also a number of connectors that are planned:</para> - <itemizedlist> <listitem> <para> - <emphasis role="strong">JCR Repository Connector</emphasis> - - Connect to and interact with other JCR repositories. - </para> - </listitem> - <listitem> - <para> <emphasis role="strong">File System Connector</emphasis> - Expose the files and directories on a file system through JCR. </para> </listitem> <listitem> <para> - <emphasis role="strong">Maven 2 Repository Connector</emphasis> - - Access and expose the contents of a Maven 2 repository (either on the local file system or via HTTP) through - JCR. + <emphasis role="strong">JDBC Storage Connector</emphasis> + - Store and access information in a relational database through JPA. Also useful for persisting information in the federated + repository not stored elsewhere. </para> </listitem> + </itemizedlist> + <para>We're working on a few other connectors:</para> + <itemizedlist> <listitem> <para> <emphasis role="strong">JDBC Metadata Connector</emphasis> @@ -402,35 +402,44 @@ </listitem> <listitem> <para> - <emphasis role="strong">UDDI Connector</emphasis> - - Interact with UDDI registries to integrate their content into a repository. - </para> - </listitem> - <listitem> - <para> <emphasis role="strong">SVN Connector</emphasis> - Interact with Subversion software configuration management (SCM) repositories to expose the managed resources through JCR. Consider using the <ulink url="http://svnkit.com/">SVNkit</ulink> (dual license) library for an API into Subversion. </para> + </listitem> + </itemizedlist> + <para>And even more connectors that are planned:</para> + <itemizedlist> + <listitem> + <para> + <emphasis role="strong">JCR Repository Connector</emphasis> + - Connect to and interact with other JCR repositories. + </para> </listitem> <listitem> <para> - <emphasis role="strong">CVS Connector</emphasis> - - Interact with CVS software configuration management (SCM) repositories to expose the managed resources through + <emphasis role="strong">Maven 2 Repository Connector</emphasis> + - Access and expose the contents of a Maven 2 repository (either on the local file system or via HTTP) through JCR. </para> </listitem> <listitem> <para> - <emphasis role="strong">JDBC Storage Connector</emphasis> - - Store and access information in a relational database. Also useful for persisting information in the federated - repository not stored elsewhere. + <emphasis role="strong">UDDI Connector</emphasis> + - Interact with UDDI registries to integrate their content into a repository. </para> </listitem> <listitem> <para> + <emphasis role="strong">CVS Connector</emphasis> + - Interact with CVS software configuration management (SCM) repositories to expose the managed resources through + JCR. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">Distributed Database Connector</emphasis> - Store and access information in a <ulink url="http://www.hypertable.org/">Hypertable</ulink> Modified: trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml =================================================================== --- trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml 2009-04-28 01:50:54 UTC (rev 859) +++ trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml 2009-04-28 15:04:22 UTC (rev 860) @@ -50,7 +50,8 @@ <note> <para> You should be able to use the <ulink url="http://java.sun.com/javase/downloads/index.jsp">latest JDK</ulink>, - which is currently JDK 6. We periodically try to build JBoss DNA using JDK 6, but it's not our official JDK (yet). + which is currently JDK 6. It is possible to build JBoss DNA using JDK 6 without any code changes, but it's + not our official JDK (yet). </para> <para> Why do we build using JDK 5 and not 6? The main reason is that if we were to use JDK 6, then JBoss DNA couldn't really be used in any Modified: trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml =================================================================== --- trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml 2009-04-28 01:50:54 UTC (rev 859) +++ trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml 2009-04-28 15:04:22 UTC (rev 860) @@ -179,7 +179,7 @@ </para> <para> JBoss DNA has other features as well. You can create federated repositories that dynamically merge the information from multiple databases, services, applications, and other JCR repositories. JBoss DNA also will allow you to - create customized views based upon the type of data and the role of the user that is accessing the data. And yet another is + create customized views based upon the type of data and the role of the user that is accessing the data. And yet another goal is to create a REST-ful API to allow the JCR content to be accessed easily by other applications written in other languages. </para> </sect1> @@ -289,15 +289,30 @@ </listitem> <listitem> <para> + <emphasis role="strong">dna-cnd</emphasis> + provides a utilities for reading and writing files in the CND (Compact Node Definition) format. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">dna-jcr</emphasis> provides the JBoss DNA implementation of the JCR API, which relies upon a repository connector, such as the Federation Connector (see <code>dna-connector-federation</code> - ). + ). As DNA does not fully implement the JCR 1.0.1 specification, there are a series of tests that are currently commented + out in this module. The <code>dna-jcr-tck</code> module contains all of these tests. </para> </listitem> <listitem> <para> + <emphasis role="strong">dna-jcr-tck</emphasis> + provides a separate testing project that executes all JackRabbit JCR TCK tests on a nightly basis to track implementation + progress against the JCR 1.0 specification. This module will likely be retired when the <code>dna-jcr</code> implementation + is complete. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">dna-integration-tests</emphasis> provides a home for all of the integration tests that involve more components that just unit tests. Integration tests are often more complicated, take longer, and involve testing the integration and functionality of many @@ -313,7 +328,7 @@ <itemizedlist> <listitem> <para> - <emphasis role="strong">dna-maven-classloader</emphasis> + <emphasis role="strong">dna-classloader-maven</emphasis> is a small library that provides a <code>ClassLoaderFactory</code> implementation that can create @@ -324,6 +339,12 @@ </listitem> <listitem> <para> + <emphasis role="strong">dna-common-jdbc</emphasis> + contains several helpful utility classes for interacting with JDBC connections. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">dna-connector-federation</emphasis> is a DNA repository connector that federates, integrates and caches information from multiple sources (via other repository connectors). @@ -331,6 +352,21 @@ </listitem> <listitem> <para> + <emphasis role="strong">dna-connector-filesystem</emphasis> + is a DNA repository connector that provides read-only access to file systems, allowing their structure and data to be + viewed as repository content. + </para> + </listitem> + <listitem> + <para> + <emphasis role="strong">dna-connector-jdbc-metadata</emphasis> + is a prototype DNA repository connector that provides read-only access to metadata from relational databases through a JDBC + connection. + <emphasis>This is still under development.</emphasis> + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">dna-connector-jbosscache</emphasis> is a DNA repository connector that manages content within a <ulink url="http://www.jboss.org/jbosscache/">JBoss Cache</ulink> @@ -340,6 +376,13 @@ </listitem> <listitem> <para> + <emphasis role="strong">dna-connector-store-jpa</emphasis> + is a DNA sequencer that provides for persistent storage and access of DNA content in a relational database. This connector + is based on JPA technology. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">dna-connector-svn</emphasis> is a prototype DNA sequencer that obtains content from a Subversion repository, providing that content in the form of <code>nt:file</code> and <code>nt:folder</code> nodes. @@ -390,8 +433,7 @@ <listitem> <para> <emphasis role="strong">dna-sequencer-cnd</emphasis> - is a prototype DNA sequencer that extracts JCR node definitions from JCR Compact Node Definition (CND) files. - <emphasis>This is still under development.</emphasis> + is a DNA sequencer that extracts JCR node definitions from JCR Compact Node Definition (CND) files. </para> </listitem> <listitem> @@ -403,6 +445,12 @@ </listitem> <listitem> <para> + <emphasis role="strong">dna-sequencer-java</emphasis> + is a DNA sequencer that extracts the structure (methods, fields) from Java source files. + </para> + </listitem> + <listitem> + <para> <emphasis role="strong">dna-mimetype-detector-aperture</emphasis> is a DNA MIME type detector that uses the <ulink url="http://aperture.sourceforge.net/">Aperture</ulink> Modified: trunk/docs/reference/src/main/docbook/en-US/content/jcr.xml =================================================================== --- trunk/docs/reference/src/main/docbook/en-US/content/jcr.xml 2009-04-28 01:50:54 UTC (rev 859) +++ trunk/docs/reference/src/main/docbook/en-US/content/jcr.xml 2009-04-28 15:04:22 UTC (rev 860) @@ -35,7 +35,7 @@ <ulink url="&JSR170;">Content Repository for Java technology API</ulink> provides a standard Java API for working with content repositories. Abbreviated "JCR", this API was developed as part of the Java Community Process under <ulink url="&JSR170;">JSR-170</ulink> (JCR 1.0) and is being revised under <ulink url="&JSR283;">JSR-283</ulink>. - JBoss DNA provides a JCR 1.0 implementation that allows you to work with the contents of a repository using the + JBoss DNA provides a partial JCR 1.0 implementation that allows you to work with the contents of a repository using the JCR API. For information about how to use the JCR API, please see the <ulink url="&JSR170;">JSR-170</ulink> specification. </para> <sect1 id="jcr-repositories"> Modified: trunk/docs/reference/src/main/docbook/en-US/content/sequencing.xml =================================================================== --- trunk/docs/reference/src/main/docbook/en-US/content/sequencing.xml 2009-04-28 01:50:54 UTC (rev 859) +++ trunk/docs/reference/src/main/docbook/en-US/content/sequencing.xml 2009-04-28 15:04:22 UTC (rev 860) @@ -341,17 +341,12 @@ <sect2 id="dna-sequencer-msoffice"> <title>Microsoft Office document sequencer</title> <para> - This sequencer is included in JBoss DNA and processes Microsoft Office documents, including Excel spreadsheets - and PowerPoint presentations. With presentations, the sequencer extracts the slides, titles, text and slide thumbnails. + This sequencer is included in JBoss DNA and processes Microsoft Office documents, including Word documents, Excel spreadsheets, + and PowerPoint presentations. With documents, the sequencer extracts the internal structure based on Heading styles. + With presentations, the sequencer extracts the slides, titles, text and slide thumbnails. With spreadsheets, the sequencer extracts the names of the sheets. And, the sequencer extracts for all the files the general file information, including the name of the author, title, keywords, subject, comments, and various dates. </para> - <note> - <para> - Currently, Word documents are not supported. For more information and the latest status, see - <ulink url="&JIRA;-153">DNA-153</ulink>. - </para> - </note> <para> To use this sequencer, simply include the <code>dna-sequencer-msoffice</code> JAR and all of the <ulink url="http://poi.apache.org/">POI</ulink> JARs @@ -441,10 +436,24 @@ <sect2 id="dna-sequencer-cnd"> <title>JCR Compact Node Definition (CND) file sequencer</title> <para> - This sequencer is incomplete and is not currently usable. The purpose is to sequence JCR Compact Node Definition (CND) files - to extract the node definitions with their property definitions, and inserting these into the repository using JCR standard notation. + This sequencer processes JCR Compact Node Definition (CND) files + to extract the node definitions with their property definitions, and inserts these into the repository using JCR standard notation. </para> </sect2> + <sect2 id="dna-sequencer-jbpm-jpdl"> + <title>jBPM JPDL file sequencer</title> + <para> + This sequencer is incomplete and is not currently usable. The purpose is to sequence jBPM JPDL files to identify metadata + about processes, their actors, and their dependencies. + </para> + </sect2> + <sect2 id="dna-sequencer-xml"> + <title>XML file sequencer</title> + <para> + This sequencer stores the structure and data of an XML file into the repository. + </para> + </sect2> + </sect1> <sect1 id="custom-sequencers"> <title>Creating custom sequencers</title>