Author: smumford Date: 2011-11-14 17:32:16 -0500 (Mon, 14 Nov 2011) New Revision: 8058 Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/and-constraint.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/child-node-constraint.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-all-nodes.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-similar-nodes.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/multivalue-property-comparison.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/node-scope-index.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-path-or-name.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-property.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/property-comparison.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/regexp-indexing-rule.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/searching-repository-content.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/synonim-provider.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/tip-nodename-with-number.xml epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml Log: Edits to eXo JCR content Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/and-constraint.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/and-constraint.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/and-constraint.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,12 +5,13 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint"> <title>AND Constraint</title> - <para> - Find all fairytales with a page count more than 90 pages. - </para> - <para> - How does it sound in jcr terms - Find all nodes with mixin type 'mix:title' where the property 'jcr:description' equals "fairytale" and whose "prop_pagecount" property value is less than 90. - </para> + <formalpara> + <title>Task:</title> + <para> + To find all <emphasis>fairytales</emphasis> with a page count more than <literal>90</literal> pages. Or, in JCR terms; find all nodes with mixin type <literal>mix:title</literal> where the property <parameter>jcr:description</parameter> equals <emphasis>fairytale</emphasis> and whose <parameter>prop_pagecount</parameter> property value is less than <literal>90</literal>. + </para> + </formalpara> + <note> <para> See also <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison" />. @@ -20,47 +21,21 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Repository_Structure"> <title>Repository Structure:</title> <para> - The repository contains mix:title nodes, where prop_pagecount has different values. + The repository contains <literal>mix:title</literal> nodes, where <parameter>prop_pagecount</parameter> has different values. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - document1 (mix:title) jcr:title="War and peace" jcr:description="novel" prop_pagecount=1000 - </para> +<programlisting>root + ├── document1 (mix:title) jcr:title="War and peace" jcr:description="novel" prop_pagecount=1000 + ├── document2 (mix:title) jcr:title="Cinderella" jcr:description="fairytale" prop_pagecount=100 + └── document3 (mix:title) jcr:title="Puss in Boots" jcr:description="fairytale" prop_pagecount=60 +</programlisting> - </listitem> - <listitem> - <para> - document2 (mix:title) jcr:title="Cinderella" jcr:description="fairytale" prop_pagecount=100 - </para> - - </listitem> - <listitem> - <para> - document3 (mix:title) jcr:title="Puss in Boots" jcr:description="fairytale" prop_pagecount=60 - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -68,10 +43,12 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -79,13 +56,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Fetching_the_Result"> <title>Fetching the Result</title> <para> - Let's get nodes: + To fetch the nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -95,10 +74,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return "document2". + <literal>NodeIterator</literal> will return <emphasis>document2</emphasis>. </para> <para> - We can also get a table: + The results can also be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/child-node-constraint.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/child-node-constraint.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/child-node-constraint.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,9 +5,14 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint"> <title>Child Node Constraint</title> - <para> - Find all nodes with the primary type '<literal>nt:folder</literal>' that are children of node by path "<filename>/root1/root2</filename>". Only find children, do not find further descendants. - </para> + + <formalpara> + <title>Task:</title> + <para> + To find all nodes with the primary type '<literal>nt:folder</literal>' that are children of node by path "<filename>/root1/root2</filename>". Only find children, do not find further descendants. + </para> + </formalpara> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Repository_Structure"> <title>Repository Structure</title> <para> @@ -55,7 +60,7 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Fetching_the_Result"> <title>Fetching the Result</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -68,7 +73,7 @@ The NodeIterator will return "folder3" and "folder5". </para> <para> - We can also get a table: + The results can also be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-all-nodes.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-all-nodes.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-all-nodes.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,71 +5,38 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes"> <title>Finding All Nodes</title> - <para> - Find all nodes in the repository. Only those nodes are found to which the session has READ permission. See also <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Access_Control" />. - </para> + <formalpara> + <title>Task:</title> + <para> + Find all nodes in the repository. + </para> + </formalpara> + <note> + <title>Note</title> + <para> + This search will only nodes that the current session has READ access to. See also <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Access_Control" />. + </para> + </note> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Repository_structure"> <title>Repository structure:</title> <para> Repository contains many different nodes. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - folder1 (nt:folder) - </para> - <itemizedlist> - <listitem> - <para> - document1 (nt:file) - </para> +<programlisting>root +└── folder1 (nt:folder) + ├── document1 (nt:file) + └── folder2 (nt:folder) + ├── document2 (nt:unstructured) + └── document3 (nt:folder) +</programlisting> - </listitem> - <listitem> - <para> - folder2 (nt:folder) - </para> - <itemizedlist> - <listitem> - <para> - document2 (nt:unstructured) - </para> - - </listitem> - <listitem> - <para> - document3 (nt:folder) - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -77,10 +44,11 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -88,13 +56,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Fetching_result"> <title>Fetching result</title> <para> - Let's get nodes: + To fetch the nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -104,10 +74,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return "folder1", "folder2","document1","document2","document3", and each other nodes in workspace if they are here. + The <literal>NodeIterator</literal> will return <emphasis>folder1</emphasis>, <emphasis>folder2</emphasis>, <emphasis>document1</emphasis>, <emphasis>document2</emphasis>, <emphasis>document3</emphasis>, and each other node in the workspace. </para> <para> - We can also get a table: + The results can also be output as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,62 +5,32 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way"> <title>Finding Nodes in a Case-Insensitive Way</title> - <para> - Find all nodes with a mixin type 'mix:title' and where the property 'jcr:title' equals 'casesensitive' in lower or upper case. - </para> + <formalpara> + <title>Task:</title> + <para> + Find all nodes with a mixin type <literal>mix:title</literal> and where the property <parameter>jcr:title</parameter> equals <literal>casesensitive</literal> in lower or upper case. + </para> + </formalpara> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Repository_Structure"> <title>Repository Structure</title> <para> - The repository contains mix:title nodes, whose jcr:title properties have different values. + The repository contains <literal>mix:title</literal> nodes, whose <literal>jcr:title</literal> properties have different values. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - document1 (mix:title) jcr:title="CaseSensitive" - </para> +<programlisting>root + ├── document1 (mix:title) jcr:title="CaseSensitive" + ├── document2 (mix:title) jcr:title="casesensitive" + └── document3 (mix:title) jcr:title="caseSENSITIVE" +</programlisting> - </listitem> - <listitem> - <para> - document2 (mix:title) jcr:title="casesensitive" - </para> - - </listitem> - <listitem> - <para> - document3 (mix:title) jcr:title="caseSENSITIVE" - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution"> <title>Query Execution</title> - <itemizedlist> - <listitem> - <para> - UPPER case - </para> - - </listitem> - - </itemizedlist> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + + <formalpara> + <title>SQL- Uppercase</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -68,10 +38,11 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + <formalpara> + <title>XPath - Upper Case</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -79,19 +50,11 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <itemizedlist> - <listitem> - <para> - LOWER case - </para> - - </listitem> - - </itemizedlist> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + </para> + </formalpara> + <formalpara> + <title>SQL - Lower Case</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -99,10 +62,11 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + <formalpara> + <title>XPath - Lower Case</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -110,13 +74,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Fetching_the_Result"> <title>Fetching the Result</title> <para> - Let's get nodes: + To fetch the nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -126,10 +92,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return "document1", "document2" and "document3" (in all examples). + The <literal>NodeIterator</literal> will return <emphasis>document1</emphasis>, <emphasis>document2</emphasis> and <emphasis>document3</emphasis> (in all examples). </para> <para> - We can also get a table: + The results can also be output as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-similar-nodes.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-similar-nodes.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/find-similar-nodes.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,10 +5,13 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes"> <title>Finding Similar Nodes</title> + <formalpara> + <title>Task:</title> + <para> + To find nodes similar to a nominated node at: <literal>/baseFile/jcr:content</literal>. + </para> + </formalpara> <para> - Find similar nodes to a nominated node with the path: '<literal>/baseFile/jcr:content</literal>'. - </para> - <para> In this example, <literal>baseFile</literal> contains text where a keyword (<literal>terms</literal>) is repeated often. This word will be used as a criteria of node similarity (for node baseFile). </para> <note> @@ -42,10 +45,10 @@ <area coords="5" id="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target3" /> </areaspec> <programlisting>root -├── baseFile (nt:file) -├── target1 (nt:file) -├── target2 (nt:file) -└── target3 (nt:file) + ├── baseFile (nt:file) + ├── target1 (nt:file) + ├── target2 (nt:file) + └── target3 (nt:file) </programlisting> <calloutlist> <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-baseFile"> @@ -75,10 +78,10 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -86,10 +89,12 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -97,13 +102,16 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> + </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Fetching_result"> - <title>Fetching result</title> + <title>Fetching results</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -113,13 +121,13 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return "/baseFile/jcr:content","/target1/jcr:content" and "/target3/jcr:content". + <literal>NodeIterator</literal> will return <emphasis>/baseFile/jcr:content</emphasis>,<emphasis>/target1/jcr:content</emphasis> and <emphasis>/target3/jcr:content</emphasis>. </para> <para> - As you see the base node are also in result set. + As you see the base node are also in the result set. </para> <para> - We can also get a table: + The results can also be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); @@ -131,7 +139,7 @@ Value[] values = row.getValues(); }</programlisting> <para> - The table content is + The table content is: </para> <table> <title>Table content</title> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/multivalue-property-comparison.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/multivalue-property-comparison.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/multivalue-property-comparison.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,53 +5,31 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison"> <title>Multivalue Property Comparison</title> - <para> - Find all nodes with the primary type 'nt:unstructured' whose property 'multiprop' contains both values "one" and "two". - </para> + <formalpara> + <title>Task:</title> + <para> + To find all nodes with the primary type <literal>nt:unstructured</literal> whose property <parameter>multiprop</parameter> contains both values <emphasis>one</emphasis> and <emphasis>two</emphasis>. + </para> + </formalpara> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Repository_Structure"> <title>Repository Structure</title> <para> The repository contains nt:unstructured nodes with different 'multiprop' properties. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - node1 (nt:unstructured) multiprop = [ "one","two" ] - </para> - - </listitem> - <listitem> - <para> - node1 (nt:unstructured) multiprop = [ "one","two","three" ] - </para> - - </listitem> - <listitem> - <para> - node1 (nt:unstructured) multiprop = [ "one","five" ] - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - +<programlisting>root + ├── node1 (nt:unstructured) multiprop = [ "one","two" ] + ├── node1 (nt:unstructured) multiprop = [ "one","two","three" ] + └── node1 (nt:unstructured) multiprop = [ "one","five" ] +</programlisting> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Query_Execution"> <title>Query Execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -59,10 +37,13 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> + </para> + </formalpara> + + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -70,13 +51,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Fetching_the_Result"> <title>Fetching the Result</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -86,10 +69,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - The NodeIterator will return "node1" and "node2". + The <literal>NodeIterator</literal> will return <emphasis>node1</emphasis> and <emphasis>node2</emphasis>. </para> <para> - We can also get a table: + The results can be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); @@ -101,7 +84,7 @@ Value[] values = row.getValues(); }</programlisting> <para> - Table content is: + The table content is: <table> <title>Table content</title> <tgroup cols="3"> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/node-scope-index.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/node-scope-index.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/node-scope-index.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -6,10 +6,10 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope"> <title>Removing Nodes Property From Indexing Scope</title> <para> - In this example, we will exclude some 'text' property of nt:unstructured node from indexing. And, therefore, node will not be found by the content of this property, even if it accepts all constraints. + In this example, we will exclude a <emphasis>text</emphasis> property of <literal>nt:unstructured</literal> nodes from being indexed. This means the node will not be found by a search for the content of this property, even if it accepts all constraints. </para> <para> - First of all, add rules to indexing-configuration.xml: + Add appropriate rules to the <filename>indexing-configuration.xml</filename> file: </para> <programlisting language="XML" role="XML">&lt;index-rule nodeType="nt:unstructured" condition="@rule='nsiTrue'"&gt; @@ -21,56 +21,30 @@ &lt;!-- do not include text in node scope index --&gt; &lt;property nodeScopeIndex="false"&gt;text&lt;/property&gt; &lt;/index-rule&gt;</programlisting> - <note> + <para> - See <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> + Refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more details. </para> - </note> <section id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Repository_structure"> - <title>Repository structure:</title> + <title>Repository structure</title> <para> - Repository contains nt:unstructured nodes, with same 'text'property and different 'rule' properties (even null) + The repository contains <literal>nt:unstructured</literal> nodes, with same <emphasis>text</emphasis> property and different <emphasis>rule</emphasis> properties. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - node1 (nt:unstructured) rule="nsiTrue" text="The quick brown fox ..." - </para> +<programlisting>root + ├── node1 (nt:unstructured) rule="nsiTrue" text="The quick brown fox ..." + ├── node2 (nt:unstructured) rule="nsiFalse" text="The quick brown fox ..." + └── node3 (nt:unstructured) text="The quick brown fox ..." // as you see this node not mentioned in indexing-configuration +</programlisting> - </listitem> - <listitem> - <para> - node2 (nt:unstructured) rule="nsiFalse" text="The quick brown fox ..." - </para> - - </listitem> - <listitem> - <para> - node3 (nt:unstructured) text="The quick brown fox ..." // as you see this node not mentioned in indexing-configuration - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -78,10 +52,12 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> + </para> + </formalpara> + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -89,13 +65,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Fetching_result"> <title>Fetching result</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -105,10 +83,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return "node1" and "node3". Node2, as you see, is not in result set. + The <literal>NodeIterator</literal> will return <emphasis>node1</emphasis> and <emphasis>node3</emphasis>. <emphasis>Node2</emphasis> is not in the result set. </para> <para> - Also, we can get a table: + The results can also be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); @@ -120,7 +98,7 @@ Value[] values = row.getValues(); }</programlisting> <para> - Table content is + Table content is: </para> <table> <title>Table content</title> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-path-or-name.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-path-or-name.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-path-or-name.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -4,38 +4,38 @@ %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Path_or_Name"> - <title>Ordering by Path or Name</title> - <warning> - <para> - Ordering by jcr:path or jcr:name does not supported. - </para> + <title>Ordering by Path or Name</title> + <warning> + <para> + Ordering by <literal>jcr:path</literal> or <literal>jcr:name</literal> is not supported. + </para> - </warning> - <para> - There is two ways to order results, when path may be used as criteria: - </para> - <itemizedlist> - <listitem> - <para> - Order by property with value type NAME or PATH (jcr supports it) - </para> + </warning> + <para> + There are two ways to order results, when path may be used as criteria: + </para> + <orderedlist> + <listitem> + <para> + Order by property with value type <parameter>NAME</parameter> or <parameter>PATH</parameter> (as the JCR supports it). + </para> - </listitem> - <listitem> - <para> - Order by jcr:path or jcr:name - sort by exact path or name of node (jcr do not supports it) - </para> + </listitem> + <listitem> + <para> + Order by <literal>jcr:path</literal> or <literal>jcr:name</literal> which will sort results by exact path or name of node (the JCR does not supports this). + </para> - </listitem> + </listitem> - </itemizedlist> - <para> - If no order specification is supplied in the query statement, implementations may support document order on the result nodes (see jsr-170 / 6.6.4.2 Document Order). And it's sorted by order number. - </para> - <para> - By default, (if query do not contains any ordering statements) result nodes is sorted by document order. - </para> - + </orderedlist> + <para> + If no order specification is supplied in the query statement, implementations may support document order on the result nodes (as per the <literal>JSR-170</literal> specification). This will sort by order number. + </para> + <para> + By default, (if the query does not contains any ordering statements) result nodes is sorted by document order. + </para> + <programlisting>SELECT * FROM nt:unstructured WHERE jcr:path LIKE 'testRoot/%'</programlisting> </section> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-property.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-property.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/order-by-property.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,53 +5,32 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property"> <title>Sorting Nodes by Property</title> - <para> - Select all nodes with the mixin type ''mix:title' and order them by the 'prop_pagecount' property. - </para> + <formalpara> + <title>Task:</title> + <para> + Select all nodes with the mixin type <literal>mix:title</literal> and order them by the <parameter>prop_pagecount</parameter> property. + </para> + </formalpara> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Repository_Structure"> <title>Repository Structure</title> <para> - The repository contains several mix:title nodes, where prop_pagecount has different values. + The repository contains several <literal>mix:title</literal> nodes, where <parameter>prop_pagecount</parameter> has different values. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - document1 (mix:title) jcr:title="War and peace" jcr:description="roman" prop_pagecount=4 - </para> +<programlisting>root + ├── document1 (mix:title) jcr:title="War and peace" jcr:description="roman" prop_pagecount=4 + ├── document2 (mix:title) jcr:title="Cinderella" jcr:description="fairytale" prop_pagecount=7 + └── document3 (mix:title) jcr:title="Puss in Boots" jcr:description="fairytale" prop_pagecount=1 +</programlisting> - </listitem> - <listitem> - <para> - document2 (mix:title) jcr:title="Cinderella" jcr:description="fairytale" prop_pagecount=7 - </para> - - </listitem> - <listitem> - <para> - document3 (mix:title) jcr:title="Puss in Boots" jcr:description="fairytale" prop_pagecount=1 - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Query_Execution"> <title>Query Execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -59,10 +38,12 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -70,13 +51,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Fetching_the_Result"> <title>Fetching the Result</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -86,10 +69,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - The NodeIterator will return nodes in the following order "document3", "document1", "document2". + The <literal>NodeIterator</literal> will return nodes in the following order: <emphasis>document3</emphasis>, <emphasis>document1</emphasis>, <emphasis>document2</emphasis>". </para> <para> - We can also get a table: + The results can also be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/property-comparison.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/property-comparison.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/property-comparison.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,53 +5,32 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison"> <title>Property Comparison</title> - <para> - Find all nodes with mixin type 'mix:title' where the prop_pagecount property contains a value less than 90. Only select the title of each node. - </para> + <formalpara> + <title>Task:</title> + <para> + To find all nodes with mixin type <literal>mix:title</literal> where the <parameter>prop_pagecount</parameter> property contains a value less than <literal>90</literal>. Only select the title of each node. + </para> + </formalpara> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Repository_structure"> <title>Repository structure:</title> <para> - Repository contains several mix:title nodes, where each prop_pagecount contains a different value. + Repository contains several <literal>mix:title</literal> nodes, where each <parameter>prop_pagecount</parameter> contains a different value. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - document1 (mix:title) jcr:title="War and peace" prop_pagecount=1000 - </para> +<programlisting>root + ├── document1 (mix:title) jcr:title="War and peace" prop_pagecount=1000 + ├── document2 (mix:title) jcr:title="Cinderella" prop_pagecount=100 + └── document3 (mix:title) jcr:title="Puss in Boots" prop_pagecount=60 +</programlisting> - </listitem> - <listitem> - <para> - document2 (mix:title) jcr:title="Cinderella" prop_pagecount=100 - </para> - - </listitem> - <listitem> - <para> - document3 (mix:title) jcr:title="Puss in Boots" prop_pagecount=60 - </para> - - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -59,10 +38,12 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> + </para> + </formalpara> + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -70,13 +51,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Fetching_result"> <title>Fetching result</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -86,10 +69,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - The NodeIterator will return "document3". + The <literal>NodeIterator</literal> will return <literal>document3</literal>. </para> <para> - We can also get a table: + The results can also be formatted as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); @@ -101,7 +84,7 @@ Value[] values = row.getValues(); }</programlisting> <para> - The table content is + The table content is: <table> <title>Table Content</title> <tgroup cols="3"> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/regexp-indexing-rule.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/regexp-indexing-rule.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/regexp-indexing-rule.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,66 +5,45 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules"> <title>Regular Expression as Property Name in Indexing Rules</title> + <formalpara> + <title>Task:</title> + <para> + Tto configure indexing so that all properties of <literal>nt:unstructured</literal> nodes must be excluded from searches, except properties with names ending with a particular <emphasis>Text</emphasis> string. + </para> + </formalpara> + <para> - In this example, we want to configure indexing in the next way. All properties of nt:unstructured nodes must be excluded from search, except properties whoes names ends with 'Text' string. First of all, add rules to indexing-configuration.xml: - </para> + To begin, add the appropriate rules to the <filename>indexing-configuration.xml</filename> file: + </para> <programlisting language="XML" role="XML">&lt;index-rule nodeType="nt:unstructured""&gt; &lt;property isRegexp="true"&gt;.*Text&lt;/property&gt; &lt;/index-rule&gt;</programlisting> - <note> + <para> - See <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> + See <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more information. </para> - - </note> - <para> - Now, let's check this rule with simple query - select all nodes with primary type 'nt:unstructured' and containing 'quick' string (fulltext search by full node). - </para> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Repository_structure"> <title>Repository structure:</title> <para> - Repository contains nt:unstructured nodes, with different 'text'-like named properties + The repository contains <literal>nt:unstructured</literal> nodes, with different <parameter>text</parameter>-based properties: </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - node1 (nt:unstructured) Text="The quick brown fox ..." - </para> - </listitem> - <listitem> - <para> - node2 (nt:unstructured) OtherText="The quick brown fox ..." - </para> +<programlisting>root + ├── node1 (nt:unstructured) Text="The quick brown fox ..." + ├── node2 (nt:unstructured) OtherText="The quick brown fox ..." + └── node3 (nt:unstructured) Textle="The quick brown fox ..." +</programlisting> - </listitem> - <listitem> - <para> - node3 (nt:unstructured) Textle="The quick brown fox ..." - </para> - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -72,10 +51,11 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -83,13 +63,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Fetching_result"> <title>Fetching result</title> <para> - Let's get nodes: + TO fetch the nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -99,10 +81,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return "node1" and "node2". "node3", as you see, is not in result set. + The <literal>NodeIterator</literal> will return <emphasis>node1</emphasis> and <emphasis>node2</emphasis>. <emphasis>Node3</emphasis> is not in result set. </para> <para> - Also, we can get a table: + The results can also be output as a table: </para> <programlisting language="Java" role="Java">String[] columnNames = result.getColumnNames(); Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/searching-repository-content.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/searching-repository-content.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/searching-repository-content.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -8,7 +8,10 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Introduction"> <title>Introduction</title> <para> - You can find the JCR configuration file here: .../portal/WEB-INF/conf/jcr/repository-configuration.xml. Please read also <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more information about index configuration. + You can find the JCR configuration file here: <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename>. + </para> + <para> + Please refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more information about index configuration. </para> </section> @@ -16,13 +19,13 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Bi_directional_RangeIterator"> <title>Bi-directional RangeIterator</title> <para> - QueryResult.getNodes() will return bi-directional NodeIterator implementation. + <literal>QueryResult.getNodes()</literal> will return bi-directional <literal>NodeIterator</literal> implementation. </para> <note> <para> Bi-directional NodeIterator is <emphasis role="bold">not supported</emphasis> in two cases: </para> - <itemizedlist> + <orderedlist> <listitem> <para> SQL query: select * from nt:base @@ -36,11 +39,11 @@ </listitem> - </itemizedlist> + </orderedlist> </note> <para> - TwoWayRangeIterator interface: + <literal>TwoWayRangeIterator</literal> interface: </para> <programlisting language="Java" role="Java">/** @@ -71,11 +74,8 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Fuzzy_Searches"> <title>Fuzzy Searches</title> <para> - JCR supports such features as Lucene Fuzzy Searches <ulink url="http://lucene.apache.org/java/2_3_2/queryparsersyntax.html"... Lucene - Query Parser Syntax</ulink>. + The JBoss Enterprise Portal Platform JCR supports features such as Lucene Fuzzy Searches. To perform a fuzzy search, form your query like the one below: </para> - <para> - To use it, you have to form a query like the one described below: - </para> <programlisting language="Java" role="Java">QueryManager qman = session.getWorkspace().getQueryManager(); Query q = qman.createQuery("select * from nt:base where contains(field, 'ccccc~')", Query.SQL); @@ -86,14 +86,14 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-SynonymSearch"> <title>SynonymSearch</title> <para> - Searching with synonyms is integrated in the jcr:contains() function and uses the same syntax as synonym searches in Google. If a search term is prefixed by a tilde symbol ( ~ ), also synonyms of the search term are taken into consideration. For example: + Searching with synonyms is integrated in the <literal>jcr:contains()</literal> function and uses the same syntax as synonym searches in web search engines (Google, for example). If a search term is prefixed by a tilde symbol ( ~ ), synonyms of the search term are taken into consideration. For example: </para> <programlisting>SQL: select * from nt:resource where contains(., '~parameter') XPath: //element(*, nt:resource)[jcr:contains(., '~parameter')</programlisting> <para> - This feature is disabled by default and you need to add a configuration parameter to the query-handler element in your jcr configuration file to enable it. + This feature is disabled by default and you need to add a configuration parameter to the query-handler element in your JCR configuration file to enable it. </para> <programlisting language="XML" role="XML">&lt;param name="synonymprovider-config-path" value="..you path to configuration file....."/&gt; @@ -134,11 +134,14 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Highlighting"> <title>Highlighting</title> <para> - An ExcerptProvider retrieves text excerpts for a node in the query result and marks up the words in the text that match the query terms. + An <literal>ExcerptProvider</literal> retrieves text excerpts for a node in the query result and marks up the words in the text that match the query terms. </para> <para> - By default highlighting words matched the query is disabled because this feature requires that additional information is written to the search index. To enable this feature, you need to add a configuration parameter to the query-handler element in your jcr configuration file to enable it. + By default, match highlighting is disabled because as it requires that additional information is written to the search index. </para> + <para> + To enable this feature, you need to add a configuration parameter to the query-handler element in your JCR configuration file: + </para> <programlisting language="XML" role="XML">&lt;param name="support-highlighting" value="true"/&gt;</programlisting> <para> @@ -146,6 +149,7 @@ </para> <programlisting language="XML" role="XML">&lt;param name="excerptprovider-class" value="org.exoplatform.services.jcr.impl.core.query.lucene.DefaultXMLExcerpt"/&gt;</programlisting> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting-DefaultXMLExcerpt"> <title>DefaultXMLExcerpt</title> <para> @@ -185,9 +189,9 @@ </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting-How_to_use_it"> - <title>How to use it</title> + <title>Usage</title> <para> - If you are using XPath, you must use the rep:excerpt() function in the last location step, just like you would select properties: + If you are using XPath, you must use the <code>rep:excerpt()</code> function in the last location step, just like you would select properties: </para> <programlisting language="Java" role="Java">QueryManager qm = session.getWorkspace().getQueryManager(); @@ -199,16 +203,16 @@ Value excerpt = r.getValue("rep:excerpt(.)"); }</programlisting> <para> - The above code searches for nodes that contain the word exoplatform and then gets the value of the Title property and an excerpt for each result node. + The above code searches for nodes that contain the word <emphasis>exoplatform</emphasis> and then gets the value of the <parameter>Title</parameter> property and an excerpt for each resultant node. </para> <para> - It is also possible to use a relative path in the call Row.getValue() while the query statement still remains the same. Also, you may use a relative path to a string property. The returned value will then be an excerpt based on string value of the property. + It is also possible to use a relative path in the call <code>Row.getValue()</code> while the query statement still remains the same. Also, you may use a relative path to a string property. The returned value will then be an excerpt based on string value of the property. </para> <para> - Both available excerpt provider will create fragments of about 150 characters and up to 3 fragments. + Both available excerpt providers will create fragments of about 150 characters and up to three fragments. </para> <para> - In SQL, the function is called excerpt() without the rep prefix, but the column in the RowIterator will nonetheless be labelled rep:excerpt(.)! + In SQL, the function is called <code>excerpt()</code> without the rep prefix, but the column in the <literal>RowIterator</literal> will nonetheless be labelled <code>rep:excerpt(.)</code>. </para> <programlisting language="Java" role="Java">QueryManager qm = session.getWorkspace().getQueryManager(); @@ -227,61 +231,73 @@ <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-SpellChecker"> <title>SpellChecker</title> <para> - The lucene based query handler implementation supports a pluggable spell checker mechanism. By default, spell checking is not available and you have to configure it first. See parameter spellCheckerClass on page <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> JCR currently provides an implementation class , which uses the <ulink url="http://wiki.apache.org/jakarta-lucene/SpellChecker">luc... to contribute . The dictionary is derived from the fulltext indexed content of the workspace and updated periodically. You can configure the refresh interval by picking one of the available inner classes of org.exoplatform.services.jcr.impl.core.query.lucene.spell.LuceneSpellChecker: + The lucene based query handler implementation supports a pluggable spell-checker mechanism. By default, spell checking is not available, it must be configured first. + </para> + <para> + Information about the <parameter>spellCheckerClass</parameter> parameter is available in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration" />. </para> + <para> + The JCR currently provides an implementation class which uses the <ulink url="http://wiki.apache.org/jakarta-lucene/SpellChecker">luc...;. + </para> + <para> + The dictionary is derived from the fulltext, indexed content of the workspace and updated periodically. You can configure the refresh interval by picking one of the available inner classes of <literal>org.exoplatform.services.jcr.impl.core.query.lucene.spell.LuceneSpellChecker</literal>: + </para> <itemizedlist> <listitem> <para> - OneMinuteRefreshInterval + <literal>OneMinuteRefreshInterval</literal> </para> </listitem> <listitem> <para> - FiveMinutesRefreshInterval + <literal>FiveMinutesRefreshInterval</literal> </para> </listitem> <listitem> <para> - ThirtyMinutesRefreshInterval + <literal>ThirtyMinutesRefreshInterval</literal> </para> </listitem> <listitem> <para> - OneHourRefreshInterval + <literal>OneHourRefreshInterval</literal> </para> </listitem> <listitem> <para> - SixHoursRefreshInterval + <literal>SixHoursRefreshInterval</literal> </para> </listitem> <listitem> <para> - TwelveHoursRefreshInterval + <literal>TwelveHoursRefreshInterval</literal> </para> </listitem> <listitem> <para> - OneDayRefreshInterval + <literal>OneDayRefreshInterval</literal> </para> </listitem> </itemizedlist> <para> - For example, if you want a refresh interval of six hours, the class name is: org.exoplatform.services.jcr.impl.core.query.lucene.spell.LuceneSpellChecker$SixHoursRefreshInterval. If you use org.exoplatform.services.jcr.impl.core.query.lucene.spell.LuceneSpellChecker, the refresh interval will be one hour. + For example, if you want a refresh interval of six hours, the class name would be; <literal>org.exoplatform.services.jcr.impl.core.query.lucene.spell.LuceneSpellChecker$SixHoursRefreshInterval</literal>. + </para> + <para> + If you use <literal>org.exoplatform.services.jcr.impl.core.query.lucene.spell.LuceneSpellChecker</literal>, the refresh interval will be one hour. </para> <para> - The spell checker dictionary is stored as a lucene index under <emphasis role="bold">"index-dir"/spellchecker</emphasis>. If it does not exist, a background thread will create it on startup. Similarly, the dictionary refresh is also done in a background thread to not block regular queries. + The spell checker dictionary is stored as a lucene index under <filename>&lt;index-dir&gt;/spellchecker</filename>. If this index does not exist, a background thread will create it on start up. Similarly, the dictionary refresh is also done in a background thread so as not to block regular queries. </para> <section id="sect-Reference_Guide_eXo_JCR_1.14-SpellChecker-How_do_I_use_it"> - <title>How do I use it?</title> + <title>Usage</title> <para> You can spell check a fulltext statement either with an XPath or a SQL query: </para> @@ -330,52 +346,74 @@ <para> Similarity is determined by looking up terms that are common to nodes. There are some conditions that must be met for a term to be considered. This is required to limit the number possibly relevant terms. </para> + <para> + To be considered, terms must: + </para> <itemizedlist> <listitem> <para> - Only terms with at least 4 characters are considered. + Be at least four characters long. </para> </listitem> <listitem> <para> - Only terms that occur at least 2 times in the source node are considered. + Occur at least twice in the source node. </para> </listitem> <listitem> <para> - Only terms that occur in at least 5 nodes are considered. + Occur in at least five other nodes. </para> </listitem> </itemizedlist> - <para> - Note: The similarity functionality requires that the support Hightlighting is enabled. Please make sure that you have the following parameter set for the query handler in your workspace.xml. - </para> + <note> + <title>Note</title> + <para> + The similarity function requires that the support Hightlighting is enabled. Please make sure that you have the following parameter set for the query handler in your <filename>workspace.xml</filename>. + </para> +<programlisting language="XML" role="XML">&lt;param name="support-highlighting" value="true"/&gt;</programlisting> + </note> -<programlisting language="XML" role="XML">&lt;param name="support-highlighting" value="true"/&gt;</programlisting> <para> - The functions are called rep:similar() (in XPath) and similar() (in SQL) and have two arguments: + The functions (<code>rep:similar()</code> in XPath and <code>similar()</code> in SQL) have two arguments: </para> - <para> - relativePath: a relative path to a descendant node or . for the current node. absoluteStringPath: a string literal that contains the path to the node for which to find similar nodes. - </para> + <variablelist> + <title></title> + <varlistentry> + <term>relativePath</term> + <listitem> + <para> + A relative path to a descendant node or a period (<literal>.</literal>) for the current node. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>absoluteStringPath</term> + <listitem> + <para> + A string literal that contains the path to the node for which to find similar nodes. + </para> + </listitem> + </varlistentry> + </variablelist> <warning> + <title>Warning</title> <para> Relative path is not supported yet. </para> </warning> - <para> - Examples: - </para> - + <example> + <title>Example</title> <programlisting>//element(*, nt:resource)[rep:similar(., '/parentnode/node.txt/jcr:content')]</programlisting> - <para> - Finds nt:resource nodes, which are similar to node by path /parentnode/node.txt/jcr:content. - </para> + <para> + Finds <literal>nt:resource</literal> nodes, which are similar to node by path <filename>/parentnode/node.txt/jcr:content</filename>. + </para> + </example> </section> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/synonim-provider.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/synonim-provider.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/synonim-provider.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -5,9 +5,13 @@ ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym"> <title>Searching By Synonym</title> - <para> - Find all mix:title nodes where title contains synonyms to 'fast' word. - </para> + <formalpara> + <title>Task:</title> + <para> + Find all <literal>mix:title</literal> nodes whose title contains a synonym for the term <emphasis>fast</emphasis>. + </para> + </formalpara> + <note> <para> Refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content" /> for information about synonym provider configuration @@ -15,7 +19,7 @@ </note> <para> - Synonym provider must be configured in indexing-configuration.xml : + The synonym provider must be configured in the <filename>indexing-configuration.xml</filename> configuration file: </para> <programlisting language="XML" role="XML">&lt;query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"&gt; @@ -27,44 +31,31 @@ &lt;/properties&gt; &lt;/query-handler&gt;</programlisting> <para> - File synonym.properties contains next synonyms list: + The <filename>synonym.properties</filename> file contains the synonyms list: </para> +<example> + <title>Example Synonym List</title> <programlisting>ASF=Apache Software Foundation quick=fast sluggish=lazy</programlisting> +</example> <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Repository_structure"> <title>Repository structure:</title> <para> - Repository contains mix:title nodes, where jcr:title has different values. + the repository contains <literal>mix:title</literal> nodes, where <literal>jcr:title</literal> has different values. </para> - <itemizedlist> - <listitem> - <para> - root - </para> - <itemizedlist> - <listitem> - <para> - document1 (mix:title) jcr:title="The quick brown fox jumps over the lazy dog." - </para> +<programlisting>root + └── document1 (mix:title) jcr:title="The quick brown fox jumps over the lazy dog." +</programlisting> - </listitem> - - </itemizedlist> - - </listitem> - - </itemizedlist> - </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Query_execution"> <title>Query execution</title> - <para> - <emphasis role="bold">SQL</emphasis> - </para> - + <formalpara> + <title>SQL</title> + <para> <programlisting language="Java" role="Java">// make SQL query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -72,10 +63,11 @@ Query query = queryManager.createQuery(sqlStatement, Query.SQL); // execute query and fetch result QueryResult result = query.execute();</programlisting> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </para> + </formalpara> + <formalpara> + <title>XPath</title> + <para> <programlisting language="Java" role="Java">// make XPath query QueryManager queryManager = workspace.getQueryManager(); // create query @@ -83,13 +75,15 @@ Query query = queryManager.createQuery(xpathStatement, Query.XPATH); // execute query and fetch result QueryResult result = query.execute();</programlisting> + </para> + </formalpara> </section> <section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Fetching_result"> <title>Fetching result</title> <para> - Let's get nodes: + To fetch nodes: </para> <programlisting language="Java" role="Java">NodeIterator it = result.getNodes(); @@ -99,11 +93,10 @@ Node findedNode = it.nextNode(); }</programlisting> <para> - NodeIterator will return expected document1. This is a purpose of synonym providers. Find by specified word, but return by all synonyms to. + The <literal>NodeIterator</literal> will return <emphasis>document1</emphasis> as expected. This is a purpose of synonym providers; to search using specified keyword(s), but return results that contain synonyms to it. </para> - </section> - + </section> </section> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/tip-nodename-with-number.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/tip-nodename-with-number.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/jcr/searching/tip-nodename-with-number.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -4,50 +4,43 @@ %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide_eXo_JCR_1.14-XPath_queries_containing_node_names_starting_with_a_number"> - <title>XPath queries containing node names starting with a number</title> - <para> - If you execute an XPath request like this: - </para> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + <title>XPath queries containing node names starting with a number</title> + <para> + If you execute an XPath request like this: + </para> + <programlisting language="Java" role="Java">// get QueryManager QueryManager queryManager = workspace.getQueryManager(); // make XPath query Query query = queryManager.createQuery("/jcr:root/Documents/Publie/2010//element(*, exo:article)", Query.XPATH);</programlisting> - <para> - You will have an error : "Invalid request". This happens because XML does not allow names starting with a number - and XPath is part of XML: <ulink url="http://www.w3.org/TR/REC-xml/#NT-Name">http://www.w3.or... - </para> - <para> - Therefore, you cannot do XPath requests using a node name that starts with a number. - </para> - <para> - Easy workarounds: - </para> - <itemizedlist> - <listitem> - <para> - Use an SQL request. - </para> + <para> + You will receive an <code>Invalid request</code> error. This is because XML (and thus XPath) does not allow names starting with a number. + </para> + <para> + Therefore, XPath requests using a node name that starts with a number are invalid. + </para> + <para> + Some possible alternatives are: + </para> + <itemizedlist> + <listitem> + <para> + Use an SQL request. + </para> - </listitem> - <listitem> - <para> - Use escaping : - </para> - - </listitem> - - </itemizedlist> - <para> - <emphasis role="bold">XPath</emphasis> - </para> - + </listitem> + <listitem> + <para> + Use escaping : + </para> <programlisting language="Java" role="Java">// get QueryManager QueryManager queryManager = workspace.getQueryManager(); // make XPath query Query query = queryManager.createQuery("/jcr:root/Documents/Publie/_x0032_010//element(*, exo:article)", Query.XPATH);</programlisting> + </listitem> + + </itemizedlist> + </section> Modified: epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml 2011-11-14 22:10:59 UTC (rev 8057) +++ epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/WSRP.xml 2011-11-14 22:32:16 UTC (rev 8058) @@ -314,7 +314,7 @@ </para> <para> - For instructions on how to specify this URL in JBoss Enterprise Portal Platform, refer to <xref linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" />. + For instructions on how to specify this URL in JBoss Enterprise Portal Platform, refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets" />. </para> <para> @@ -1391,7 +1391,7 @@ </mediaobject></step> <step><para> - The fully-qualified name for the <classname>RegistrationPolicy</classname> and <classname>RegistrationPropertyValidator</classname> can be specified here. The default values are acceptable. Refer to <xref linkend="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior" /> for more information. + The fully-qualified name for the <classname>RegistrationPolicy</classname> and <classname>RegistrationPropertyValidator</classname> can be specified here. The default values are acceptable. Refer to <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Registration_Configuration-Customization_of_Registration_Handling_Behavior" /> for more information. </para></step> <step><para>