[gatein-commits] gatein SVN: r8093 - in epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR: jcr/backup and 6 other directories.

Author: smumford Date: 2011-11-17 23:01:09 -0500 (Thu, 17 Nov 2011) New Revision: 8093 Removed: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.bk Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-client.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/intro.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/lock-manager-config.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl-ext.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/link-producer.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/ftp.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/webdav.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml Log: Relocate eXoJCR chapter to Part IV and promote sub-sections Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-client.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-client.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-client.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client"> <title><literal>HTTPBackupAgent</literal> and Backup Client</title> <warning> <title>Configuration Persistance</title> @@ -2266,6 +2266,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution"> <title>Backup Console Binary Distribution</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution-Introduction"> <title>Introduction</title> @@ -204,6 +204,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service"> <title>eXo JCR Backup Service</title> <note> <para> @@ -954,6 +954,6 @@ </para> </section> - </section> + </chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Use_external_backup_tool"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Use_external_backup_tool"> <title>Use External Backup Tool</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Use_external_backup_tool-Repository_suspending"> <title>Repository Suspending</title> @@ -77,6 +77,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Advantages_of_eXo_JCR"> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Advantages_of_eXo_JCR"> <title>Advantages of eXo JCR</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Advantages_of_eXo_JCR-Application_Developers"> <title>Application Developers</title> @@ -79,6 +79,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,63 +3,63 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Application_Model"> - <title>eXo JCR Application Model</title> - <para> - The following image illustrates the interaction between Applications and JCR: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/eXoJCR/concepts/jcr-applications.gif" width="444" /> - </imageobject> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Application_Model"> + <title>eXo JCR Application Model</title> + <para> + The following image illustrates the interaction between Applications and JCR: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/eXoJCR/concepts/jcr-applications.gif" width="444" /> + </imageobject> - </mediaobject> - <para> - Every Content (JCR) dependent application interacts with the eXo JCR via JSR-170 and the eXo JCR API extension either directly or through an intermediary Framework. - </para> - <note> - <title>Note:</title> - <para> - Neither the application nor the framework should ever rely on the implementation directly. - </para> + </mediaobject> + <para> + Every Content (JCR) dependent application interacts with the eXo JCR via JSR-170 and the eXo JCR API extension either directly or through an intermediary Framework. + </para> + <note> + <title>Note:</title> + <para> + Neither the application nor the framework should ever rely on the implementation directly. + </para> - </note> - <para> - <emphasis role="bold">Content Application:</emphasis> all applications may use the JCR as a data storage. Some of them are generic and completely decoupled from the JCR API as an interaction protocol (such as a WebDav client) hides Content storage nature. Other applications are partially decoupled (such as Command framework based applications), meaning that they do not use the JCR API directly. Most applications use JSR-170 directly. - </para> - <para> - <emphasis role="bold">Frameworks</emphasis> are a special kind of JCR client that act as an intermediate level between the <literal>Content Repository</literal> and an <literal>End Client Application</literal>. - </para> - <para> - Framworks are categorized as follows: - </para> - <variablelist> - <title></title> - <varlistentry> - <term>Protocol Specific Frameworks</term> - <listitem> - <para> - Frameworks that are specific to a networking protocol include WebDav, RMI and FTP servers. - </para> + </note> + <para> + <emphasis role="bold">Content Application:</emphasis> all applications may use the JCR as a data storage. Some of them are generic and completely decoupled from the JCR API as an interaction protocol (such as a WebDav client) hides Content storage nature. Other applications are partially decoupled (such as Command framework based applications), meaning that they do not use the JCR API directly. Most applications use JSR-170 directly. + </para> + <para> + <emphasis role="bold">Frameworks</emphasis> are a special kind of JCR client that act as an intermediate level between the <literal>Content Repository</literal> and an <literal>End Client Application</literal>. + </para> + <para> + Framworks are categorized as follows: + </para> + <variablelist> + <title></title> + <varlistentry> + <term>Protocol Specific Frameworks</term> + <listitem> + <para> + Frameworks that are specific to a networking protocol include WebDav, RMI and FTP servers. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>Pattern Specific Frameworks</term> - <listitem> - <para> - Frameworks that are pattern specific include Command, Web(servlet), J2EE connector - </para> + </varlistentry> + <varlistentry> + <term>Pattern Specific Frameworks</term> + <listitem> + <para> + Frameworks that are pattern specific include Command, Web(servlet), J2EE connector + </para> - </listitem> + </listitem> - </varlistentry> + </varlistentry> - </variablelist> - <para> - It is possible to build a multi-layered (in framework sense) JCR application, for example Web application uses Web framework that uses Command framework underneath. - </para> -</section> + </variablelist> + <para> + It is possible to build a multi-layered (in framework sense) JCR application, for example Web application uses Web framework that uses Command framework underneath. + </para> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,146 +3,146 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels"> - <title>Compatibility Levels</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Introduction"> - <title>Introduction</title> - <para> - The Java Content Repository specification JSR-170 has been split into two compliance levels as well as a set of optional features. <literal>Level 1</literal> defines a read-only repository while <literal>Level 2</literal> defines methods for writing content and bi-directional interaction with the repository. - </para> - <para> - The eXo JCR supports JSR-170 Level 1 and Level 2 and all optional features. The recent JSR-283 is not yet supported. - </para> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels"> + <title>Compatibility Levels</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Introduction"> + <title>Introduction</title> + <para> + The Java Content Repository specification JSR-170 has been split into two compliance levels as well as a set of optional features. <literal>Level 1</literal> defines a read-only repository while <literal>Level 2</literal> defines methods for writing content and bi-directional interaction with the repository. + </para> + <para> + The eXo JCR supports JSR-170 Level 1 and Level 2 and all optional features. The recent JSR-283 is not yet supported. + </para> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Level_1"> - <title>Level 1</title> - <para> - Level 1 includes read-only functionality for very simple repositories. It is useful to migrate an existing data repository and step through converting it to a more advanced implementation. The JCR uses a well-known Session abstraction to access the repository data. - </para> - <para> - The features of Level 1: - </para> - <itemizedlist> - <listitem> - <para> - Initiating a session calling login method with the name of desired workspace and client credentials. It involves some security mechanisms (JAAS) to authenticate the client and in case the client is authorized to use the data from a particular workspace, it can retrieve the session with a workspace tied to it. - </para> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Level_1"> + <title>Level 1</title> + <para> + Level 1 includes read-only functionality for very simple repositories. It is useful to migrate an existing data repository and step through converting it to a more advanced implementation. The JCR uses a well-known Session abstraction to access the repository data. + </para> + <para> + The features of Level 1: + </para> + <itemizedlist> + <listitem> + <para> + Initiating a session calling login method with the name of desired workspace and client credentials. It involves some security mechanisms (JAAS) to authenticate the client and in case the client is authorized to use the data from a particular workspace, it can retrieve the session with a workspace tied to it. + </para> - </listitem> - <listitem> - <para> - Using the obtained session, the client can retrieve data (items) by traversing the tree, directly accessing a particular item (requesting path or UUID) or traversing the query result. So an application developer can choose the "best" form depending on the content structure and desired operation. - </para> + </listitem> + <listitem> + <para> + Using the obtained session, the client can retrieve data (items) by traversing the tree, directly accessing a particular item (requesting path or UUID) or traversing the query result. So an application developer can choose the "best" form depending on the content structure and desired operation. + </para> - </listitem> - <listitem> - <para> - Reading property values. All content of a repository is ultimately accessed through properties and stored in property values of predefined types (Boolean, Binary Data, Double, Long, String) and special types Name, Reference, and Path. It is possible to read property value without knowing its real name as a primary item. - </para> + </listitem> + <listitem> + <para> + Reading property values. All content of a repository is ultimately accessed through properties and stored in property values of predefined types (Boolean, Binary Data, Double, Long, String) and special types Name, Reference, and Path. It is possible to read property value without knowing its real name as a primary item. + </para> - </listitem> - <listitem> - <para> - Export to XML. The repository supports two XML/JCR data model mappings: <literal>system</literal> and <literal>doc</literal> view. The system view provides complete XML serialization without loss of information and is somewhat difficult for a human to read. In contrast, the document view is human readable but does not completely reflect the state of repository; it is used for Xpath queries. - </para> + </listitem> + <listitem> + <para> + Export to XML. The repository supports two XML/JCR data model mappings: <literal>system</literal> and <literal>doc</literal> view. The system view provides complete XML serialization without loss of information and is somewhat difficult for a human to read. In contrast, the document view is human readable but does not completely reflect the state of repository; it is used for Xpath queries. + </para> - </listitem> - <listitem> - <para> - A query facility with Xpath syntax. Xpath, originally developed for XML, suits the JCR data model as the two models are similar. Xpath is applied to the JCR as it would be applied to the document view of the serialized repository content; returning a table of property names and content matching the query. - </para> + </listitem> + <listitem> + <para> + A query facility with Xpath syntax. Xpath, originally developed for XML, suits the JCR data model as the two models are similar. Xpath is applied to the JCR as it would be applied to the document view of the serialized repository content; returning a table of property names and content matching the query. + </para> - </listitem> - <listitem> - <para> - Discovery of available node types. Every node should have only one primary node type that defines names, types and other characteristics of child nodes and properties. It also can have one or more mixin data types that defines additional characteristics. Level 1 provides methods for discovering available in repository node types and node types of a concrete node. - </para> + </listitem> + <listitem> + <para> + Discovery of available node types. Every node should have only one primary node type that defines names, types and other characteristics of child nodes and properties. It also can have one or more mixin data types that defines additional characteristics. Level 1 provides methods for discovering available in repository node types and node types of a concrete node. + </para> - </listitem> - <listitem> - <para> - Transient namespace remapping. Item name can have prefix, delimited by a single ':' (colon) character that indicates the namespace of this name. It is patterned after XML namespaces, prefix is mapped to URI to minimize names collisions. In Level 1, a prefix can be temporary overridden by another prefix in the scope of a session. - </para> + </listitem> + <listitem> + <para> + Transient namespace remapping. Item name can have prefix, delimited by a single ':' (colon) character that indicates the namespace of this name. It is patterned after XML namespaces, prefix is mapped to URI to minimize names collisions. In Level 1, a prefix can be temporary overridden by another prefix in the scope of a session. + </para> - </listitem> + </listitem> - </itemizedlist> - <mediaobject> - <imageobject> - <imagedata fileref="images/eXoJCR/concepts/level_1.gif" /> - </imageobject> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/eXoJCR/concepts/level_1.gif" /> + </imageobject> - </mediaobject> + </mediaobject> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Level_2"> - <title>Level 2</title> - <para> - JCR Level 2 includes reading and writing of content functionality, importing other sources and managing content definition and structuring using extensible node types. - </para> - <para> - In addition to the features of Level 1, it also supports the following major features: - </para> - <itemizedlist> - <listitem> - <para> - Adding, moving, copying and removing items inside workspace and moving, copying and cloning items between workspaces. The client can also compare the persisted state of an item with its unsaved states and either save the new state or discard it. - </para> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Level_2"> + <title>Level 2</title> + <para> + JCR Level 2 includes reading and writing of content functionality, importing other sources and managing content definition and structuring using extensible node types. + </para> + <para> + In addition to the features of Level 1, it also supports the following major features: + </para> + <itemizedlist> + <listitem> + <para> + Adding, moving, copying and removing items inside workspace and moving, copying and cloning items between workspaces. The client can also compare the persisted state of an item with its unsaved states and either save the new state or discard it. + </para> - </listitem> - <listitem> - <para> - Modifying and writing value of properties. Property types are checked and can be converted to the defined format. - </para> + </listitem> + <listitem> + <para> + Modifying and writing value of properties. Property types are checked and can be converted to the defined format. + </para> - </listitem> - <listitem> - <para> - Importing XML document into the repository as a tree of nodes and properties. If the XML document is an export of JCR system view, the content of repository can be completely restored. If this is not the case, the document is interpreted as a document view and the import procedure builds a tree of JCR nodes and properties that matches the tree structure of the XML document. - </para> + </listitem> + <listitem> + <para> + Importing XML document into the repository as a tree of nodes and properties. If the XML document is an export of JCR system view, the content of repository can be completely restored. If this is not the case, the document is interpreted as a document view and the import procedure builds a tree of JCR nodes and properties that matches the tree structure of the XML document. + </para> - </listitem> - <listitem> - <para> - Assigning node types to nodes. The primary node type is assigned when adding a node. This can be done automatically based on the parent node type definition and mixin node types. - </para> + </listitem> + <listitem> + <para> + Assigning node types to nodes. The primary node type is assigned when adding a node. This can be done automatically based on the parent node type definition and mixin node types. + </para> - </listitem> - <listitem> - <para> - Persistent namespaces changes. Adding, changing and removing namespaces stored in the namespace registry, excluding built-in namespaces required by JCR. - </para> + </listitem> + <listitem> + <para> + Persistent namespaces changes. Adding, changing and removing namespaces stored in the namespace registry, excluding built-in namespaces required by JCR. + </para> - </listitem> + </listitem> - </itemizedlist> - <mediaobject> - <imageobject> - <imagedata fileref="images/eXoJCR/concepts/level_2.gif" /> - </imageobject> + </itemizedlist> + <mediaobject> + <imageobject> + <imagedata fileref="images/eXoJCR/concepts/level_2.gif" /> + </imageobject> - </mediaobject> + </mediaobject> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Optional_features"> - <title>Optional features</title> - <para> - On the top of Level 1 or Level 2, a number of optional features are defined for a more advanced repository functionality. This includes functions such as Versioning, (JTA) Transactions, Query using SQL, Explicit Locking and Content Observation. eXo JCR supports all optional features. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/eXoJCR/concepts/optional.gif" /> - </imageobject> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Optional_features"> + <title>Optional features</title> + <para> + On the top of Level 1 or Level 2, a number of optional features are defined for a more advanced repository functionality. This includes functions such as Versioning, (JTA) Transactions, Query using SQL, Explicit Locking and Content Observation. eXo JCR supports all optional features. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/eXoJCR/concepts/optional.gif" /> + </imageobject> - </mediaobject> + </mediaobject> - </section> - + </section> + -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Implementation"> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Implementation"> <!-- This document was created with Syntext Serna Free. --> <title>Implementation</title> <para> @@ -184,6 +184,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Extensions"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Extensions"> <title>JCR Extensions</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Extensions-JCR_Service_Extensions"> <title>JCR Service Extensions</title> @@ -213,6 +213,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Namespace_Altering"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Namespace_Altering"> <!-- This document was created with Syntext Serna Free. --> <title>Namespace Altering</title> <para> Since version 1.11, the eXo JCR implementation supports namespaces altering. @@ -40,6 +40,6 @@ <programlisting language="Java" role="Java">ExtendedNamespaceRegistry namespaceRegistry = (ExtendedNamespaceRegistry) workspace.getNamespaceRegistry(); namespaceRegistry.registerNamespace("newMapping", "http://dumb.uri/jcr"); namespaceRegistry.unregisterNamespace("newMapping");</programlisting> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,23 +3,23 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service"> - <title>Registry Service</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-Concept"> - <title>Concept</title> - <para> - The Registry Service is one of the key parts of the infrastructure built around eXo JCR. Each JCR that is based on services and applications may have its own configuration, settings, and other data that have to be stored persistently and used by the appropriate service or application (referred to as a <emphasis>Consumer</emphasis>). - </para> - <para> - The service acts as a centralized collector (Registry) for such data. A registry storage is JCR based, that is, it is stored in some JCR workspace (one per Repository) as an Item tree under a <literal>/exo:registry</literal> node. - </para> - <para> - Despite the fact that the structure of the tree is well defined (see the scheme below), it is not recommended for other services to manipulate data using the JCR API directly. So the Registry Service acts as a mediator between a Consumer and its settings. - </para> - <para> - The proposed structure of the Registry Service storage is divided into three logical groups: services, applications and users: - </para> - +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service"> + <title>Registry Service</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-Concept"> + <title>Concept</title> + <para> + The Registry Service is one of the key parts of the infrastructure built around eXo JCR. Each JCR that is based on services and applications may have its own configuration, settings, and other data that have to be stored persistently and used by the appropriate service or application (referred to as a <emphasis>Consumer</emphasis>). + </para> + <para> + The service acts as a centralized collector (Registry) for such data. A registry storage is JCR based, that is, it is stored in some JCR workspace (one per Repository) as an Item tree under a <literal>/exo:registry</literal> node. + </para> + <para> + Despite the fact that the structure of the tree is well defined (see the scheme below), it is not recommended for other services to manipulate data using the JCR API directly. So the Registry Service acts as a mediator between a Consumer and its settings. + </para> + <para> + The proposed structure of the Registry Service storage is divided into three logical groups: services, applications and users: + </para> + <programlisting> exo:registry/ &lt;-- registry "root" (exo:registry) exo:services/ &lt;-- service data storage (exo:registryGroup) service1/ @@ -33,26 +33,26 @@ user1/ Consumer data (exo:registryEntry) ...</programlisting> - <para> - Each upper level Service may store its configuration in the Registry. At first start the service can call its settings from an XML configuration file and, once the settings have been stored, from then on call settings from the Registry. - </para> - <para> - In a configuration file, you can add the <parameter>force-xml-configuration</parameter> parameter to the component to force it to ignore reading parameter initialization from <literal>RegistryService</literal> and to use the configuration file instead: - </para> - + <para> + Each upper level Service may store its configuration in the Registry. At first start the service can call its settings from an XML configuration file and, once the settings have been stored, from then on call settings from the Registry. + </para> + <para> + In a configuration file, you can add the <parameter>force-xml-configuration</parameter> parameter to the component to force it to ignore reading parameter initialization from <literal>RegistryService</literal> and to use the configuration file instead: + </para> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;force-xml-configuration&lt;/name&gt; &lt;value&gt;true&lt;/value&gt; &lt;/value-param&gt;</programlisting> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-The_API"> - <title>The API</title> - <para> - The main functionality of the Registry Service is described in the Registry abstract class as the following: - </para> - + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-The_API"> + <title>The API</title> + <para> + The main functionality of the Registry Service is described in the Registry abstract class as the following: + </para> + <programlisting language="Java" role="Java">public abstract class Registry { /** @@ -84,16 +84,16 @@ */ public abstract void removeEntry(SessionProvider sessionProvider, String groupName, String entryName) throws RepositoryException;</programlisting> - <para> - This is a CRUD interface as the <literal>RegistryEntry</literal> object which wraps registry data for some Consumer as a Registry Entry. The Registry Service itself is unaware of the wrapping data as it is the Consumer's responsibility to manage and use its data in its own way. - </para> - <para> - To create an Entity Consumer you should know how to serialize the data to some XML structure and then create a <literal>RegistryEntry</literal> from these data at once or populate them in a <literal>RegistryEntry</literal> object by using <literal>RegistryEntry(String entryName)</literal> constructor and then obtain and fill a DOM document. - </para> - <para> - An example of <literal>RegistryService</literal> using: - </para> - + <para> + This is a CRUD interface as the <literal>RegistryEntry</literal> object which wraps registry data for some Consumer as a Registry Entry. The Registry Service itself is unaware of the wrapping data as it is the Consumer's responsibility to manage and use its data in its own way. + </para> + <para> + To create an Entity Consumer you should know how to serialize the data to some XML structure and then create a <literal>RegistryEntry</literal> from these data at once or populate them in a <literal>RegistryEntry</literal> object by using <literal>RegistryEntry(String entryName)</literal> constructor and then obtain and fill a DOM document. + </para> + <para> + An example of <literal>RegistryService</literal> using: + </para> + <programlisting language="Java" role="Java"> RegistryService regService = (RegistryService) container .getComponentInstanceOfType(RegistryService.class); @@ -105,14 +105,14 @@ String mySetting = getElementsByTagName("tagname").item(index).getTextContent(); .....</programlisting> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-Configuration"> - <title>Configuration</title> - <para> - <literal>RegistryService</literal> has only one optional properties parameter; <parameter>locations</parameter>. It is used to mention where <literal>exo:registry</literal> is placed for each repository. The name of each property is interpreted as a repository name and its value as a workspace name (a system workspace by default). - </para> - + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-Configuration"> + <title>Configuration</title> + <para> + <literal>RegistryService</literal> has only one optional properties parameter; <parameter>locations</parameter>. It is used to mention where <literal>exo:registry</literal> is placed for each repository. The name of each property is interpreted as a repository name and its value as a workspace name (a system workspace by default). + </para> + <programlisting language="XML" role="XML">&lt;component&gt; &lt;type&gt;org.exoplatform.services.jcr.ext.registry.RegistryService&lt;/type&gt; &lt;init-params&gt; @@ -123,9 +123,9 @@ &lt;/init-params&gt; &lt;/component&gt;</programlisting> - </section> - + </section> + -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Using_The_JCR"> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Using_The_JCR"> <title>Using The JCR</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Using_The_JCR-Obtaining_a_Repository_Object"> <title>Obtaining a Repository Object</title> @@ -247,6 +247,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-NodeType_Registration"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-NodeType_Registration"> <!-- This document was created with Syntext Serna Free. --> <title>NodeType Registration</title> <para> The eXo JCR implementation supports two methods of Nodetypes registration: @@ -546,6 +546,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces"> <title>Node Types and Namespaces</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces-Introduction"> <title>Introduction</title> @@ -146,6 +146,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Java_Content_Repository"> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Java_Content_Repository"> <title>Java Content Repository</title> <para> A Java Content Repository (<abbrev>JCR</abbrev>) is a java interface used to access contents that are not only web contents, but also other hierarchically stored data. The content is stored in a repository. The repository can be a file system, a relational database or an XML document. The internal structure of JCR data looks similar to an XML document; a document tree with nodes and data, however, in a JCR, the data is stored in <literal>property items</literal>. @@ -23,6 +23,6 @@ <para> Roy T. Fielding, <ulink url="http://www.day.com/content/dam/day/whitepapers/JSR_170_White_Pa... 170 Overview: Standardizing the Content Repository Interface</ulink> (March 13, 2005) </para> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister"> <title>JCR Configuration persister</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Concept"> <title>Concept</title> @@ -144,6 +144,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> - <section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_configuration"> + <chapter id="sect-Reference_Guide_eXo_JCR_1.14-JCR_configuration"> <title>JCR configuration</title> <para> @@ -220,7 +220,7 @@ <!--15--> <area coords="61 60" id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout" /> </areaspec> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_Configuration/orig.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_Configuration/orig.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <!--1--> @@ -697,4 +697,4 @@ </orderedlist> </section> </section> - </section> + </chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages"> <title>External Value Storages</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Introduction"> <title>Introduction</title> @@ -40,7 +40,7 @@ </areaspec> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_external-value-storages/default25.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default25.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Tree_File_Value_Storage-id"> <para> @@ -78,7 +78,7 @@ In this example a value matches the 20MB filter <property>min-value-size</property> and will be stored in the path "<literal>data/20Mvalues</literal>". All other filters will be stored in "<literal>data/values</literal>". </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_external-value-storages/default26.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default26.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </section> @@ -95,7 +95,7 @@ <para> Holds Values in flat file system files. <property>path</property> property points to root directory in order to store files </para> -<programlisting language="Java" role="Java"><xi:include parse="text" href="../../../extras/Advanced_Development_JCR_external-value-storages/default27.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="Java" role="Java"><xi:include parse="text" href="../../../../extras/Advanced_Development_JCR_external-value-storages/default27.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <programlisting>&lt;value-storage id="Storage #1" class="org.exoplatform.services.jcr.impl.storage.value.fs.SimpleFileValueStorage"&gt; &lt;properties&gt; &lt;property name="path" value="data/values"/&gt; @@ -146,7 +146,7 @@ To enable CAS support just configure it in the JCR Repositories configuration with other Value Storages. </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_external-value-storages/default28.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default28.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Content_Addressable_Value_storage_CAS_support-CAS_Properties"> <title>CAS Properties</title> <varlistentry> @@ -213,6 +213,6 @@ </warning> </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config"> <title>JDBC Data Container Config</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Introduction"> <title>Introduction</title> @@ -391,7 +391,7 @@ </para> <programlisting language="XML" role="XML"> -<xi:include href="../../../../../extras/Advanced_Development_JCR_Configuration/example-1.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<xi:include href="../../../../extras/Advanced_Development_JCR_Configuration/example-1.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <substeps> <step> <para> @@ -469,7 +469,7 @@ </para> <programlisting language="XML" role="XML"> -<xi:include href="../../../../../extras/Advanced_Development_JCR_Configuration/example-2.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<xi:include href="../../../../extras/Advanced_Development_JCR_Configuration/example-2.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <itemizedlist> <listitem> <para> @@ -523,7 +523,7 @@ <title><parameter>jdbcjcr</parameter> Data Container</title> <programlisting language="XML" role="XML"> -<xi:include href="../../../../../extras/Advanced_Development_JCR_Configuration/example-3.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<xi:include href="../../../../extras/Advanced_Development_JCR_Configuration/example-3.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> <para> Configure repository workspaces with this one database. The <parameter>multi-db</parameter> parameter must be set as <literal>false</literal>. @@ -535,7 +535,7 @@ <title>Example</title> <programlisting language="XML" role="XML"> -<xi:include href="../../../../../extras/Advanced_Development_JCR_Configuration/example-4.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<xi:include href="../../../../extras/Advanced_Development_JCR_Configuration/example-4.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </example> <para> This configures two persistent workspaces in one database (PostgreSQL). @@ -731,6 +731,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,71 +3,71 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB"> - <title>Multi-language Support the JCR RDB</title> - <para> - Whenever a relational database is used to store multilingual text data in the eXo Java Content Repository the configuration must be adapted to support UTF-8 encoding. Dialect is automatically detected for certified database. You can still enforce it in case of failure, see below. - </para> - <para> - The following sections describe enabling UTF-8 support with various databases. - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-Oracle" /> - </para> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB"> + <title>Multi-language Support the JCR RDB</title> + <para> + Whenever a relational database is used to store multilingual text data in the eXo Java Content Repository the configuration must be adapted to support UTF-8 encoding. Dialect is automatically detected for certified database. You can still enforce it in case of failure, see below. + </para> + <para> + The following sections describe enabling UTF-8 support with various databases. + </para> + <itemizedlist> + <listitem> + <para> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-Oracle" /> + </para> - </listitem> - <listitem> - <para> - <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-DB2" /> - </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-DB2" /> + </para> - </listitem> - <listitem> - <para> - <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-MySQL" /> - </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-MySQL" /> + </para> - </listitem> - <listitem> - <para> - <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-PostgreSQL" /> - </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-PostgreSQL" /> + </para> - </listitem> + </listitem> - </itemizedlist> - <note> - <itemizedlist> - <listitem> - <para> - The configuration file to be modified for these changes is <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. - </para> + </itemizedlist> + <note> + <itemizedlist> + <listitem> + <para> + The configuration file to be modified for these changes is <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. + </para> - </listitem> - <listitem> - <para> - The datasource <parameter>jdbcjcr</parameter> used in the following examples can be configured via the <literal>InitialContextInitializer</literal> component. - </para> + </listitem> + <listitem> + <para> + The datasource <parameter>jdbcjcr</parameter> used in the following examples can be configured via the <literal>InitialContextInitializer</literal> component. + </para> - </listitem> + </listitem> - </itemizedlist> + </itemizedlist> - </note> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-Oracle"> - <title>Oracle</title> - <para> - In order to run multilanguage JCR on an Oracle backend Unicode encoding for characters set should be applied to the database. Other Oracle globalization parameters do not have any effect. The property to modify is <literal>NLS_CHARACTERSET</literal>. - </para> - <para> - The <literal>NLS_CHARACTERSET = AL32UTF8</literal> entry has been successfully tested with many European and Asian languages. - </para> - <para> - Example of database configuration: - </para> - + </note> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-Oracle"> + <title>Oracle</title> + <para> + In order to run multilanguage JCR on an Oracle backend Unicode encoding for characters set should be applied to the database. Other Oracle globalization parameters do not have any effect. The property to modify is <literal>NLS_CHARACTERSET</literal>. + </para> + <para> + The <literal>NLS_CHARACTERSET = AL32UTF8</literal> entry has been successfully tested with many European and Asian languages. + </para> + <para> + Example of database configuration: + </para> + <programlisting>NLS_LANGUAGE AMERICAN NLS_TERRITORY AMERICA NLS_CURRENCY $ @@ -87,101 +87,101 @@ NLS_LENGTH_SEMANTICS BYTE NLS_NCHAR_CONV_EXCP FALSE NLS_NCHAR_CHARACTERSET AL16UTF16</programlisting> - <!-- <warning> + <!-- <warning> <para> JCR 1.12.x doesn't use NVARCHAR columns, so that the value of the parameter NLS_NCHAR_CHARACTERSET does not matter for JCR. </para> </warning> --> <para> - Create database with Unicode encoding and use Oracle dialect for the Workspace Container: - </para> - -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_multilanguage-support/default54.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + Create database with Unicode encoding and use Oracle dialect for the Workspace Container: + </para> + +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_multilanguage-support/default54.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-DB2"> - <title>DB2</title> - <para> - DB2 Universal Database (DB2 UDB) supports <ulink url="http://publib.boulder.ibm.com/infocenter/db2luw/v9/index.jsp?to... and UTF-16/UCS-2</ulink>. When a Unicode database is created, <parameter>CHAR</parameter>, <parameter>VARCHAR</parameter> and <parameter>LONG VARCHAR</parameter> data are stored in UTF-8 form. - </para> - <para> - This enables JCR multi-lingual support. - </para> - <para> - Below is an example of creating a UTF-8 database using the <parameter>db2</parameter> dialect for a workspace container with DB2 version 9 and higher: - </para> - + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-DB2"> + <title>DB2</title> + <para> + DB2 Universal Database (DB2 UDB) supports <ulink url="http://publib.boulder.ibm.com/infocenter/db2luw/v9/index.jsp?to... and UTF-16/UCS-2</ulink>. When a Unicode database is created, <parameter>CHAR</parameter>, <parameter>VARCHAR</parameter> and <parameter>LONG VARCHAR</parameter> data are stored in UTF-8 form. + </para> + <para> + This enables JCR multi-lingual support. + </para> + <para> + Below is an example of creating a UTF-8 database using the <parameter>db2</parameter> dialect for a workspace container with DB2 version 9 and higher: + </para> + <programlisting>DB2 CREATE DATABASE dbname USING CODESET UTF-8 TERRITORY US </programlisting> - -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_multilanguage-support/default56.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <note> - <para> - For DB2 version 8.<replaceable>x</replaceable> support change the property "dialect" to db2v8. - </para> + +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_multilanguage-support/default56.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <note> + <para> + For DB2 version 8.<replaceable>x</replaceable> support change the property "dialect" to db2v8. + </para> - </note> + </note> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-MySQL"> - <title>MySQL</title> - <para> - Using JCR with a MySQL-back end requires a special dialect <ulink url="http://jira.exoplatform.org/browse/JCR-375">MySQL-UTF8&... to be used for internationalization support. - </para> - <para> - The database default charset should be <parameter>latin1</parameter> so as to use limited index space effectively (1000 bytes for an <literal>MyISAM</literal> engine and 767 for <literal>InnoDB</literal>). - </para> - <para> - If the database default charset is multibyte, a JCR database initialization error is encountered concerning index creation failure. - </para> - <para> - JCR can work on any single byte default charset of database, with UTF8 supported by MySQL server. However it has only been tested using the <parameter>latin1</parameter> charset. - </para> - <para> - An example entry: - </para> - -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_multilanguage-support/default57.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-MySQL"> + <title>MySQL</title> + <para> + Using JCR with a MySQL-back end requires a special dialect <ulink url="http://jira.exoplatform.org/browse/JCR-375">MySQL-UTF8&... to be used for internationalization support. + </para> + <para> + The database default charset should be <parameter>latin1</parameter> so as to use limited index space effectively (1000 bytes for an <literal>MyISAM</literal> engine and 767 for <literal>InnoDB</literal>). + </para> + <para> + If the database default charset is multibyte, a JCR database initialization error is encountered concerning index creation failure. + </para> + <para> + JCR can work on any single byte default charset of database, with UTF8 supported by MySQL server. However it has only been tested using the <parameter>latin1</parameter> charset. + </para> + <para> + An example entry: + </para> + +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_multilanguage-support/default57.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-PostgreSQL"> - <title>PostgreSQL</title> - <para> - Multilingual support can be enabled with a PostgreSQL-back end in <ulink url="http://www.postgresql.org/docs/8.3/interactive/charset.html&quo... ways</ulink>: - </para> - <orderedlist> - <listitem> - <para> - Using the locale features of the operating system to provide locale-specific collation order, number formatting, translated messages, and other aspects. - </para> - <para> - UTF-8 is widely used on Linux distributions by default, so it can be useful in such cases. - </para> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-PostgreSQL"> + <title>PostgreSQL</title> + <para> + Multilingual support can be enabled with a PostgreSQL-back end in <ulink url="http://www.postgresql.org/docs/8.3/interactive/charset.html&quo... ways</ulink>: + </para> + <orderedlist> + <listitem> + <para> + Using the locale features of the operating system to provide locale-specific collation order, number formatting, translated messages, and other aspects. + </para> + <para> + UTF-8 is widely used on Linux distributions by default, so it can be useful in such cases. + </para> - </listitem> - <listitem> - <para> - Providing a number of different character sets defined in the PostgreSQL server, including multiple-byte character sets, to support storing text any language, and providing character set translation between client and server. - </para> - <para> - Using UTF-8 database charset is recommended as it will allow any-to-any conversations and make this issue transparent for the JCR. - </para> + </listitem> + <listitem> + <para> + Providing a number of different character sets defined in the PostgreSQL server, including multiple-byte character sets, to support storing text any language, and providing character set translation between client and server. + </para> + <para> + Using UTF-8 database charset is recommended as it will allow any-to-any conversations and make this issue transparent for the JCR. + </para> - </listitem> + </listitem> - </orderedlist> - <para> - Example of a database with UTF-8 encoding using PgSQL dialect for the Workspace Container: - </para> - -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_multilanguage-support/default58.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </orderedlist> + <para> + Example of a database with UTF-8 encoding using PgSQL dialect for the Workspace Container: + </para> + +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_multilanguage-support/default58.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> - + </section> + -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-REST_Services_on_Groovy"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-REST_Services_on_Groovy"> <title>REST Services on Groovy</title> <para>Starting from version 1.9, JCR Service supports REST services @@ -39,6 +39,6 @@ &lt;/init-params&gt; &lt;/component&gt;</programlisting> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration"> <title>Search Configuration</title> <para> The search function in JCR can be configured to perform in specific ways. This section will discuss configuring the search function to improve search performance and results. @@ -18,7 +18,7 @@ A code example is included below with a list of the configuration parameters shown below that. </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default61.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default61.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> The table below outlines the Configuration Parameters available, their default setting, which version of eXo JCR they were implemented in and other useful information: </para> @@ -669,7 +669,7 @@ </areaspec> -<programlisting language="Java" role="Java"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default62.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="Java" role="Java"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default62.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-StandardFilter"> <para> @@ -817,7 +817,7 @@ To configure an application to use a new analyzer, add the <parameter>analyzer</parameter> parameter to each query-handler configuration in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;VERSION&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default69.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default69.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> The new <literal>SearchIndex</literal> will start to index contents with the specified filters when the JCR is next started. </para> @@ -850,7 +850,7 @@ With the configuration below only properties named <parameter>Text</parameter> are indexed for <parameter>nt:unstructured</parameter> node types. This configuration also applies to all nodes whose type extends from <parameter>nt:unstructured</parameter>. </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default71.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default71.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <note> <title>Namespace Prefixes</title> <para> @@ -866,12 +866,12 @@ </formalpara> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default72.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default72.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> If you do not wish to boost the complete node, but only certain properties, you can also provide a boost value for the listed properties: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default73.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default73.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <formalpara id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Conditional_Index_Rules"> <title>Conditional Index Rules</title> <para> @@ -880,7 +880,7 @@ </formalpara> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default74.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default74.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> In the above example the first rule only applies if the <parameter>nt:unstructured</parameter> node has a priority property with a value <parameter>high</parameter>. The condition syntax only supports the equals operator and a string literal. </para> @@ -888,12 +888,12 @@ Properties may also be referenced on the condition that are not on the current node: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default75.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default75.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> The indexing configuration allows the type of a node in the condition to be specified. Please note however that the type match must be exact. It does not consider sub types of the specified node type. </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default76.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default76.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <formalpara id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Exclusion_from_the_Node_Scope_Index"> <title>Exclusion from the Node Scope Index</title> <para> @@ -908,7 +908,7 @@ Properties can be explicitly excluded from the node scope index with: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default77.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default77.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <formalpara id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Index_Aggregates"> <title>Index Aggregates</title> <para> @@ -923,22 +923,22 @@ The following example creates an index aggregate on <literal>nt:file</literal> that includes the content of the jcr:content node: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default78.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default78.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> Included nodes can also be restricted to a certain type: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default79.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default79.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> The <emphasis role="bold">*</emphasis> wild-card can be used to match all child nodes: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default80.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default80.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> Nodes to a certain depth below the current node can be included by adding multiple include elements. The <parameter>nt:file</parameter> node may contain a complete XML document under jcr:content for example: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default81.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default81.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <formalpara id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Property_Level_Analyzers"> <title>Property-Level Analyzers</title> <para> @@ -947,7 +947,7 @@ </formalpara> -<programlisting language="XML" role="XML"><xi:include href="../../../../../extras/Advanced_Development_JCR_search-configuration/default82.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_search-configuration/default82.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <para> The configuration above sets lucene <emphasis role="bold">KeywordAnalyzer</emphasis> to index and search the property "<replaceable>mytext</replaceable>" across the entire workspace while the "<replaceable>mytext2</replaceable>" property is searched with the <emphasis role="bold">WhitespaceAnalyzer</emphasis>. </para> @@ -1061,4 +1061,4 @@ </itemizedlist> </section> -</section> \ No newline at end of file +</chapter> \ No newline at end of file Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container"> <title>Workspace Data Container</title> <para> Each Workspace of the JCR has its own persistent storage to hold that workspace's items data. The eXo JCR can be configured so that it can use one or more workspaces that are logical units of the repository content. @@ -158,6 +158,6 @@ </programlistingco> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/intro.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/intro.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/intro.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Introduction"> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-eXoJCR-Introduction"> <title>Introduction</title> <warning> <title>eXo JCR usage</title> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/lock-manager-config.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -18,7 +18,7 @@ For example: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/default47.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/default47.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <section id="sect-Reference_Guide_eXo_JCR_1.14-LockManager-CacheableLockManagerImpl"> <title>CacheableLockManagerImpl</title> @@ -35,7 +35,7 @@ The time-out for LockRemover is set as follows (the default value is 30m): </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/default48.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/default48.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <!-- Doesn't seem necessary <formalpara> <title>Configuration</title> @@ -106,7 +106,7 @@ </areaspec> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/default49.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/default49.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml"> <para> @@ -134,7 +134,7 @@ </areaspec> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/default50.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/default50.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName"> <para> @@ -304,7 +304,7 @@ </areaspec> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/you.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/you.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates"> <para> @@ -331,7 +331,7 @@ </areaspec> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/default51.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/default51.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml"> <para> @@ -360,7 +360,7 @@ <filename>udp-mux.xml</filename>: </para> -<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_lock-manager-config/default52.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_lock-manager-config/default52.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </section> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl-ext.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl-ext.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl-ext.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension"> <title>Access Control Extension</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-Prerequisites"> <title>Prerequisites</title> @@ -154,6 +154,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/acl.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control"> <title>Access Control</title> <para> The eXo JCR component is a complete implementation of the standard JSR 170: <ulink url="http://jcp.org/en/jsr/detail?id=170">Content Repository for Java TM Technology API</ulink>, including <emphasis role="bold">Level 1, Level 2 and Additional Features</emphasis> specified in the JCR Specification. @@ -594,6 +594,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,43 +3,43 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing"> - <title>Binary Values Processing</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Configuration"> - <title>Configuration</title> - <para> - Binary large object (<abbrev>BLOB</abbrev>) properties can be stored in two ways in the eXo JCR; in the database with items information or in an external storage on host file system. These options can be configured at workspace in the repository configuration file (<filename>repository-configuration.xml</filename>). The database storage can not be completely disabled. - </para> - <para> - The first case is optimal for most of cases which you do not use very large values and/or do not have too many BLOBs. The configuration of the BLOBs size and BLOBs quantity in a repository depend on your database features and hardware. - </para> - <para> - The second case is to use an external values storage. The storage can be located on a built-in hard disk or on an attached storage. But in any cases, you should access to the storage as if it was a regular file(s). The external value storage is optional and can be enabled in a database configuration. - </para> - <note> - <para> - The eXo JCR Repository service configuration basics is discussed in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-JCR_configuration" /> - </para> - <para> - Database and workspace persistence storage configuration is discussed in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config" /> - </para> - <para> - Configuration details for <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages" />. - </para> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing"> + <title>Binary Values Processing</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Configuration"> + <title>Configuration</title> + <para> + Binary large object (<abbrev>BLOB</abbrev>) properties can be stored in two ways in the eXo JCR; in the database with items information or in an external storage on host file system. These options can be configured at workspace in the repository configuration file (<filename>repository-configuration.xml</filename>). The database storage can not be completely disabled. + </para> + <para> + The first case is optimal for most of cases which you do not use very large values and/or do not have too many BLOBs. The configuration of the BLOBs size and BLOBs quantity in a repository depend on your database features and hardware. + </para> + <para> + The second case is to use an external values storage. The storage can be located on a built-in hard disk or on an attached storage. But in any cases, you should access to the storage as if it was a regular file(s). The external value storage is optional and can be enabled in a database configuration. + </para> + <note> + <para> + The eXo JCR Repository service configuration basics is discussed in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-JCR_configuration" /> + </para> + <para> + Database and workspace persistence storage configuration is discussed in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config" /> + </para> + <para> + Configuration details for <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages" />. + </para> - </note> + </note> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Usage"> - <title>Usage</title> - <para> - In both of the cases, a developer can set or update the binary Property via <literal>Node.setProperty(String, InputStream)</literal>, <literal>Property.setValue(InputStream)</literal> as described in the spec JSR-170. Also, there is the setter with a ready Value object obtained from <literal>ValueFactory.createValue(InputStream)</literal>. - </para> - <para> - An example of a specification usage: - </para> - + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Usage"> + <title>Usage</title> + <para> + In both of the cases, a developer can set or update the binary Property via <literal>Node.setProperty(String, InputStream)</literal>, <literal>Property.setValue(InputStream)</literal> as described in the spec JSR-170. Also, there is the setter with a ready Value object obtained from <literal>ValueFactory.createValue(InputStream)</literal>. + </para> + <para> + An example of a specification usage: + </para> + <programlisting language="Java" role="Java">// Set the property value with given stream content. Property binProp = node.setProperty("BinData", myDataStream); // Get the property value stream. @@ -54,37 +54,37 @@ updatedBinProp.setValue(ValueFactory.createValue(newDataStream)); // Get the updated property value stream. InputStream newStream = updatedBinProp.getStream();</programlisting> - <para> - However, updating the property sequentially and with partial content, would require you to edit the entire data stream outside of, then return to, the repository. In cases of large amounts of data, this process would belabor the application and its productivity will suffer. JCR stream setters will also check constraints and perform common validation each time. - </para> - <para> - A feature of the eXo JCR extension can be used for binary values partial writing without frequent session level calls. The main concept is to use a value object obtained from the property as the storage of the property content while writing/reading during runtime. - </para> - <para> - According to the JSR-170 specification, Value interface provides the state of property that can't be edited. The eXo JCR core provides <literal>ReadableBinaryValue</literal> and <literal>EditableBinaryValue</literal> interfaces which themselves extend JCR Value. The interfaces allow the user to partially read and change a value content. - </para> - <para> - <literal>ReadableBinaryValue</literal> value can be casted from any value, i.e. String, Binary, Date etc. - </para> - + <para> + However, updating the property sequentially and with partial content, would require you to edit the entire data stream outside of, then return to, the repository. In cases of large amounts of data, this process would belabor the application and its productivity will suffer. JCR stream setters will also check constraints and perform common validation each time. + </para> + <para> + A feature of the eXo JCR extension can be used for binary values partial writing without frequent session level calls. The main concept is to use a value object obtained from the property as the storage of the property content while writing/reading during runtime. + </para> + <para> + According to the JSR-170 specification, Value interface provides the state of property that can't be edited. The eXo JCR core provides <literal>ReadableBinaryValue</literal> and <literal>EditableBinaryValue</literal> interfaces which themselves extend JCR Value. The interfaces allow the user to partially read and change a value content. + </para> + <para> + <literal>ReadableBinaryValue</literal> value can be casted from any value, i.e. String, Binary, Date etc. + </para> + <programlisting language="Java" role="Java">// get the property value of type PropertyType.STRING ReadableBinaryValue extValue = (ReadableBinaryValue) node.getProperty("LargeText").getValue(); // read 200 bytes to a destStream from the position 1024 in the value content OutputStream destStream = new FileOutputStream("MyTextFile.txt"); extValue.read(destStream, 200, 1024);</programlisting> - <para> - However <literal>EditableBinaryValue</literal> can be applied only to <literal>PropertyType.BINARY</literal> type properties. In other cases, a cast to <literal>EditableBinaryValue</literal> will fail. - </para> - <para> - After the value has been edited, the <literal>EditableBinaryValue</literal> value can be applied to the property using the standard setters (<literal>Property.setValue(Value)</literal>, <literal>Property.setValues(Value)</literal>, <literal>Node.setProperty(String, Value)</literal> etc.). - </para> - <para> - Only after the <literal>EditableBinaryValue</literal> has been set to the property, it can be obtained in this session by getters <literal>(Property.getValue()</literal>, <literal>Node.getProperty(String)</literal> etc.). - </para> - <para> - The user can obtain an <literal>EditableBinaryValue</literal> instance and fill it with data in an interaction manner (or any other appropriated to the targets) and return (set) the value to the property after the content will be done. - </para> - + <para> + However <literal>EditableBinaryValue</literal> can be applied only to <literal>PropertyType.BINARY</literal> type properties. In other cases, a cast to <literal>EditableBinaryValue</literal> will fail. + </para> + <para> + After the value has been edited, the <literal>EditableBinaryValue</literal> value can be applied to the property using the standard setters (<literal>Property.setValue(Value)</literal>, <literal>Property.setValues(Value)</literal>, <literal>Node.setProperty(String, Value)</literal> etc.). + </para> + <para> + Only after the <literal>EditableBinaryValue</literal> has been set to the property, it can be obtained in this session by getters <literal>(Property.getValue()</literal>, <literal>Node.getProperty(String)</literal> etc.). + </para> + <para> + The user can obtain an <literal>EditableBinaryValue</literal> instance and fill it with data in an interaction manner (or any other appropriated to the targets) and return (set) the value to the property after the content will be done. + </para> + <programlisting language="Java" role="Java">// get the property value for PropertyType.BINARY Property EditableBinaryValue extValue = (EditableBinaryValue) node.getProperty("BinData").getValue(); @@ -96,10 +96,10 @@ // save the Property to persistence node.save();</programlisting> - <para> - A practical example of the iterative usage. In this example, the value is updated with data from the sequence of streams and after the update is done, the value will be applied to the property and be visible during the session. - </para> - + <para> + A practical example of the iterative usage. In this example, the value is updated with data from the sequence of streams and after the update is done, the value will be applied to the property and be visible during the session. + </para> + <programlisting language="Java" role="Java">// update length bytes from the stream starting from the particular // position in the existing Value data int dpos = 1024; @@ -111,44 +111,44 @@ // apply the edited EditableBinaryValue to the Property node.setProperty("BinData", extValue);</programlisting> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Value_implementations"> - <title>Value implementations</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/eXoJCR/other/binaryvalue.png" width="444" /> - </imageobject> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Value_implementations"> + <title>Value implementations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eXoJCR/other/binaryvalue.png" width="444" /> + </imageobject> - </mediaobject> - <para> - <literal>ReadableBinaryValue</literal> has one method to read Value. - </para> - <para> - Read length bytes is counted from the binary value to the given position into the stream. - </para> - + </mediaobject> + <para> + <literal>ReadableBinaryValue</literal> has one method to read Value. + </para> + <para> + Read length bytes is counted from the binary value to the given position into the stream. + </para> + <programlisting language="Java" role="Java">long read(OutputStream stream, long length, long position) throws IOException, RepositoryException ;</programlisting> - <para> - <literal>EditableBinaryValue</literal> has two methods to edit value. - </para> - <para> - Update with length bytes from the specified stream to this value data at a position. If the position is lower than <literal>0</literal>, the IOException exception will be thrown. If the position is higher than the current Value length, the Value length will be increased at first to the size of position and length bytes will be added after the position. - </para> - + <para> + <literal>EditableBinaryValue</literal> has two methods to edit value. + </para> + <para> + Update with length bytes from the specified stream to this value data at a position. If the position is lower than <literal>0</literal>, the IOException exception will be thrown. If the position is higher than the current Value length, the Value length will be increased at first to the size of position and length bytes will be added after the position. + </para> + <programlisting language="Java" role="Java">void update(InputStream stream, long length, long position) throws IOException;</programlisting> - <para> - Set the length of the Value in bytes to the specified size. If the size is lower than <literal>0</literal>, the IOException exception will be thrown. This operation can be used to extend or truncate the Value size. This method is used internally in the update operation in case of extending the size to the given position. - </para> - + <para> + Set the length of the Value in bytes to the specified size. If the size is lower than <literal>0</literal>, the IOException exception will be thrown. This operation can be used to extend or truncate the Value size. This method is used internally in the update operation in case of extending the size to the given position. + </para> + <programlisting language="Java" role="Java">void setLength(long size) throws IOException;</programlisting> - <para> - An application can perform JCR binary operations more flexibly and will have less I/O and CPU usage using these methods. - </para> + <para> + An application can perform JCR binary operations more flexibly and will have less I/O and CPU usage using these methods. + </para> - </section> - + </section> + -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,23 +3,23 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Resources"> - <title>JCR Resources:</title> - <para> - * Java Community Process: <ulink url="http://jcp.org/en/jsr/detail?id=170">JSR 170 </ulink> and <ulink url="http://jcp.org/en/jsr/detail?id=283">JSR 283</ulink> - </para> - <para> - * Tom Wheeler, <ulink url="http://www.tomwheeler.com/java_content_repository_tomwheeler_20... Java Content Repository</ulink> (2007) - </para> - <para> - * Roy T. Fielding, <ulink url="http://www.day.com/content/dam/day/whitepapers/JSR_170_White_Pa... 170 Overview: Standardizing the Content Repository Interface</ulink> (March 13, 2005) - </para> - <para> - * David Nuescheler and Janus Boye, <ulink url="http://www.cmswatch.com/Feature/123">JSR-170 What's in it for me?</ulink> (April 20, 2005) - </para> - <para> - * Benjamin Mestrallet, Tuan Nguyen, Gennady Azarenkov, Francois Moron and Brice Revenant <ulink url="http://www.theserverside.com/tt/articles/article.tss?l=eXoPlatf... Platform v2, Portal, JCR, ECM, Groupware and Business Intelligence</ulink> (January 2006) - </para> -</section> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Resources"> + <title>JCR Resources:</title> + <para> + * Java Community Process: <ulink url="http://jcp.org/en/jsr/detail?id=170">JSR 170 </ulink> and <ulink url="http://jcp.org/en/jsr/detail?id=283">JSR 283</ulink> + </para> + <para> + * Tom Wheeler, <ulink url="http://www.tomwheeler.com/java_content_repository_tomwheeler_20... Java Content Repository</ulink> (2007) + </para> + <para> + * Roy T. Fielding, <ulink url="http://www.day.com/content/dam/day/whitepapers/JSR_170_White_Pa... 170 Overview: Standardizing the Content Repository Interface</ulink> (March 13, 2005) + </para> + <para> + * David Nuescheler and Janus Boye, <ulink url="http://www.cmswatch.com/Feature/123">JSR-170 What's in it for me?</ulink> (April 20, 2005) + </para> + <para> + * Benjamin Mestrallet, Tuan Nguyen, Gennady Azarenkov, Francois Moron and Brice Revenant <ulink url="http://www.theserverside.com/tt/articles/article.tss?l=eXoPlatf... Platform v2, Portal, JCR, ECM, Groupware and Business Intelligence</ulink> (January 2006) + </para> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/link-producer.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/link-producer.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/other/link-producer.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Link_Producer_Service"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Link_Producer_Service"> <title>Link Producer Service</title> <para> The Link Producer Service is a simple service which generates an file that is compatible with the Microsoft link file format. It is an extension of the REST Framework library and is included into the WebDav service. On dispatching a <literal>GET</literal> request the service generates the content of an <filename>.lnk</filename> file, which points to a JCR resource via WebDav. @@ -92,6 +92,6 @@ <para> ...the file "somefile.extention" will open directly. </para> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/ftp.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/ftp.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/ftp.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,62 +3,62 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-FTP"> - <title>FTP</title> - <section id="sect-Reference_Guide_eXo_JCR_1.14-FTP-Introduction"> - <title>Introduction</title> - <para> - The JCR-FTP Server operates as an FTP server with access to a content stored in JCR repositories in the form of <emphasis role="bold">nt:file/nt:folder</emphasis> nodes or their successors. The client of an executed Server can be any FTP client. The FTP server is supported by a standard configuration which can be changed as required. - </para> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-FTP"> + <title>FTP</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-FTP-Introduction"> + <title>Introduction</title> + <para> + The JCR-FTP Server operates as an FTP server with access to a content stored in JCR repositories in the form of <emphasis role="bold">nt:file/nt:folder</emphasis> nodes or their successors. The client of an executed Server can be any FTP client. The FTP server is supported by a standard configuration which can be changed as required. + </para> - </section> - - <section id="sect-Reference_Guide_eXo_JCR_1.14-FTP-Configuration_Parameters"> - <title>Configuration Parameters</title> - <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Configuration_Parameters-Parameters"> - <title>Parameters</title> - <varlistentry> - <term>command-port:</term> - <listitem> - + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-FTP-Configuration_Parameters"> + <title>Configuration Parameters</title> + <variablelist id="vari-Reference_Guide_eXo_JCR_1.14-Configuration_Parameters-Parameters"> + <title>Parameters</title> + <varlistentry> + <term>command-port:</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;command-port&lt;/name&gt; &lt;value&gt;21&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - The value of the command channel port. The value '<literal>21</literal>' is default. - </para> - <para> - If you have already other FTP server installed in your system, this parameter needs to be changed (to <literal>2121</literal>, for example) to avoid conflicts or if the port is protected. - </para> + <para> + The value of the command channel port. The value '<literal>21</literal>' is default. + </para> + <para> + If you have already other FTP server installed in your system, this parameter needs to be changed (to <literal>2121</literal>, for example) to avoid conflicts or if the port is protected. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>data-min-port &amp; data-max-port</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>data-min-port &amp; data-max-port</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;data-min-port&lt;/name&gt; &lt;value&gt;52000&lt;/value&gt; &lt;/value-param&gt;</programlisting> - + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;data-max-port&lt;/name&gt; &lt;value&gt;53000&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - These two parameters indicate the minimum and maximum values of the range of ports, used by the server. The usage of the additional data channel is required by the FTP protocol, which is used to transfer the contents of files and the listing of catalogues. This range of ports should be free from listening by other server-programs. - </para> + <para> + These two parameters indicate the minimum and maximum values of the range of ports, used by the server. The usage of the additional data channel is required by the FTP protocol, which is used to transfer the contents of files and the listing of catalogues. This range of ports should be free from listening by other server-programs. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>system</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>system</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;system&lt;/name&gt; @@ -66,17 +66,17 @@ or &lt;value&gt;UNIX Type: L8&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - Types of formats of listing of catalogues which are supported. - </para> + <para> + Types of formats of listing of catalogues which are supported. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>client-side-encoding</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>client-side-encoding</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;client-side-encoding&lt;/name&gt; @@ -85,124 +85,124 @@ &lt;value&gt;KOI8-R&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - This parameter specifies the coding which is used for dialogue with the client. - </para> + <para> + This parameter specifies the coding which is used for dialogue with the client. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>def-folder-node-type</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>def-folder-node-type</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;def-folder-node-type&lt;/name&gt; &lt;value&gt;nt:folder&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - This parameter specifies the type of a node, when an FTP-folder is created. - </para> + <para> + This parameter specifies the type of a node, when an FTP-folder is created. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>def-file-node-type</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>def-file-node-type</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;def-file-node-type&lt;/name&gt; &lt;value&gt;nt:file&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - This parameter specifies the type of a node, when an FTP-file is created. - </para> + <para> + This parameter specifies the type of a node, when an FTP-file is created. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>def-file-mime-type</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>def-file-mime-type</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;def-file-mime-type&lt;/name&gt; &lt;value&gt;application/zip&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - The mime type of a created file is chosen by using its file extention. In case, a server cannot find the corresponding mime type, this value is used. - </para> + <para> + The mime type of a created file is chosen by using its file extention. In case, a server cannot find the corresponding mime type, this value is used. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>cache-folder-name</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>cache-folder-name</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;cache-folder-name&lt;/name&gt; &lt;value&gt;../temp/ftp_cache&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - The Path of the cache folder. - </para> + <para> + The Path of the cache folder. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>upload-speed-limit</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>upload-speed-limit</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;upload-speed-limit&lt;/name&gt; &lt;value&gt;20480&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - Restriction of the upload speed. It is measured in bytes. - </para> + <para> + Restriction of the upload speed. It is measured in bytes. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>download-speed-limit</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>download-speed-limit</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;download-speed-limit&lt;/name&gt; &lt;value&gt;20480&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - Restriction of the download speed. It is measured in bytes. - </para> + <para> + Restriction of the download speed. It is measured in bytes. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>timeout</term> - <listitem> - + </varlistentry> + <varlistentry> + <term>timeout</term> + <listitem> + <programlisting language="XML" role="XML">&lt;value-param&gt; &lt;name&gt;timeout&lt;/name&gt; &lt;value&gt;60&lt;/value&gt; &lt;/value-param&gt;</programlisting> - <para> - Defines the value of a timeout. - </para> + <para> + Defines the value of a timeout. + </para> - </listitem> + </listitem> - </varlistentry> + </varlistentry> - </variablelist> + </variablelist> - </section> - + </section> + -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/webdav.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/webdav.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/protocols/webdav.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV"> <!-- This document was created with Syntext Serna Free. --> <title>WebDAV</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV-Introduction"> <title>Introduction</title> @@ -482,6 +482,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings"> <title>Fulltext Search And Affecting Settings</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings-Property_content_indexing"> <title>Property content indexing</title> @@ -317,6 +317,6 @@ </section> -</section> +</chapter> Deleted: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.bk =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.bk 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.bk 2011-11-18 04:01:09 UTC (rev 8093) @@ -1,390 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" -"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> -<section id="JCR.QueryUsecases"> - - <title>JCR Query Usecases</title> - - <section> - <title>Intro</title> - - <para>JCR supports two query languages - JCR and XPath. A query, whether - XPath or SQL, specifies a subset of nodes within a workspace, called the - result set. The result set constitutes all the nodes in the workspace that - meet the constraints stated in the query.</para> - </section> - - <section> - <title>Query Lifecycle</title> - - <section> - <title>Query Creation and Execution</title> - - <para><emphasis role="bold">SQL</emphasis></para> - - <programlisting role="Java" language="Java">// get QueryManager -QueryManager queryManager = workspace.getQueryManager();  -// make SQL query -Query query = queryManager.createQuery("SELECT * FROM nt:base ", Query.SQL); -// execute query -QueryResult result = query.execute();</programlisting> - - <para><emphasis role="bold">XPath</emphasis></para> - - <programlisting role="Java" language="Java">// get QueryManager -QueryManager queryManager = workspace.getQueryManager(); -// make XPath query -Query query = queryManager.createQuery("//element(*,nt:base)", Query.XPATH); -// execute query -QueryResult result = query.execute();</programlisting> - </section> - - <section> - <title>Query Result Processing</title> - - <programlisting role="Java" language="Java">// fetch query result -QueryResult result = query.execute();</programlisting> - - <para>Now we can get result in an iterator of nodes:</para> - - <programlisting role="Java" language="Java">NodeIterator it = result.getNodes();</programlisting> - - <para>or we get the result in a table:</para> - - <programlisting role="Java" language="Java">// get column names -String[] columnNames = result.getColumnNames(); -// get column rows -RowIterator rowIterator = result.getRows(); -while(rowIterator.hasNext()){ - // get next row - Row row = rowIterator.nextRow(); - // get all values of row - Value[] values = row.getValues(); -}</programlisting> - </section> - - <section> - <title>Scoring</title> - - <para>The result returns a score for each row in the result set. The - score contains a value that indicates a rating of how well the result - node matches the query. A high value means a better matching than a low - value. This score can be used for ordering the result.</para> - - <para>eXo JCR Scoring is a mapping of Lucene scoring. For a more - in-depth understanding, please study <ulink - url="http://lucene.apache.org/java/2_4_1/scoring.html">Lucene - documentation</ulink>.</para> - - <para>jcr:score counted in next way - (lucene score)*1000f.</para> - - <para>Score may be increased for specified nodes, see <xref - linkend="JCR.IndexBoostRule"/></para> - - <para>Also, see an example <xref linkend="JCR.OrderByScore"/></para> - </section> - </section> - - <section> - <title>Query result settings</title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.SetOffsetandSetLimit"/></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Type Constraints</title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.FindAllNodes"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.FindNodesByPrimaryType"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.FindNodesByMixinType"/></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Property Constraints</title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.PropertyComparison"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.LIKEConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.EscapinginLIKEStatements"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.NOTConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.ANDConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.ORConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.PropertyExistenceConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.FindNodesCaseInsensitive"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.DatePropertyComparison"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.NodeNameConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.MultivaluePropertyComparison"/></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Path Constraint</title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.ExactPathConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.ChildNodeConstraint"/></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.FindAllDescendantNodes"/></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Ordering specifying</title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.OrderByProperty">Order by - Property</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.OrderByDescendant">Order by Descendant Node - Property</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.OrderByScore">Order by Score</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.OrderByPathOrName">Order by Path or - Name</link></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title><xref linkend="JCR.FulltextSearchAndSettings">Fulltext - Search</link></title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.FulltextSearchByProperty">Fulltext Search by - Property</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.FulltextSearchByAllProperties">Fulltext - Search by All Properties</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.AggregationRule">Find nt:file document by - content of child jcr:content node</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.IgnoreAccentSymbols">How to set new Analyzer. - Accent symblos ignoring</link></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Indexing rules and additional features</title> - - <itemizedlist> - <listitem> - <para><xref linkend="JCR.AggregationRule">Aggregation - rule</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.HiglightResultofFulltextSearch">Search Result - Highlighting</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.IndexBoostRule">Index Boost - Value</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.NodeScopeIndex">Exclusion from the Node Scope - Index</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.RegexpIndexingRule">Regular expressions as - property name in indexing rule</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.SynonimProvider">Synonim - Provider</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.SpellChecker">Spell Checking</link></para> - </listitem> - - <listitem> - <para><xref linkend="JCR.FindSimilarNodes">Find Similar - Nodes</link></para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Query Examples</title> - - <xi:include href="offset-and-limit.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="find-all-nodes.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="find-nodes-by-primary-type.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="find-nodes-by-mixin-type.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="property-comparison.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="like-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="escaping-like-statements.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="not-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="and-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="or-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="property-existance-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="find-nodes-case-insensitive.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="date-property-comparison.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="node-name-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="multivalue-property-comparison.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="exact-path-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="child-node-constraint.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="find-all-descendant-nodes.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="order-by-property.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="order-by-descendant.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="order-by-score.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="order-by-path-or-name.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="fulltext-search-by-property.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="fulltext-search-by-all-properties.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="ignore-accent-symbols.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="aggregation-rule.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="index-boost-value.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="node-scope-index.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="regexp-indexing-rule.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="higlight.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="synonim-provider.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="spell-checker.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="find-similar-nodes.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - </section> - - <section> - <title>Tips and tricks</title> - - <xi:include href="tip-nodename-with-number.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - - </section> -</section> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases"> <title>JCR Query Usecases</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Intro"> <title>Introduction</title> @@ -368,6 +368,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content"> <title>Searching Repository Content</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Introduction"> <title>Introduction</title> @@ -418,6 +418,6 @@ </section> -</section> +</chapter> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2011-11-18 03:58:04 UTC (rev 8092) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2011-11-18 04:01:09 UTC (rev 8093) @@ -3,7 +3,7 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<chapter id="sect-Reference_Guide_eXo_JCR_1.14-How_to_use_AS_Managed_DataSource_under_JBoss_AS"> +<section id="sect-Reference_Guide_eXo_JCR_1.14-How_to_use_AS_Managed_DataSource_under_JBoss_AS"> <title>How to use AS Managed DataSource under JBoss AS</title> <section id="sect-Reference_Guide_eXo_JCR_1.14-How_to_use_AS_Managed_DataSource_under_JBoss_AS-Configurations_Steps"> <title>Configurations Steps</title> @@ -106,6 +106,6 @@ </section> -</chapter> +</section>