Author: pkluegl
Date: Mon Feb 27 08:38:07 2017
New Revision: 1784507

URL: http://svn.apache.org/viewvc?rev=1784507&view=rev
Log:
UIMA-5220
- added params in descriptor
- added params in docu

Modified:
    
uima/ruta/trunk/ruta-core/src/main/resources/org/apache/uima/ruta/engine/BasicEngine.xml
    uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml
    uima/ruta/trunk/ruta-typesystem/   (props changed)

Modified: 
uima/ruta/trunk/ruta-core/src/main/resources/org/apache/uima/ruta/engine/BasicEngine.xml
URL: 
http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/resources/org/apache/uima/ruta/engine/BasicEngine.xml?rev=1784507&r1=1784506&r2=1784507&view=diff
==============================================================================
--- 
uima/ruta/trunk/ruta-core/src/main/resources/org/apache/uima/ruta/engine/BasicEngine.xml
 (original)
+++ 
uima/ruta/trunk/ruta-core/src/main/resources/org/apache/uima/ruta/engine/BasicEngine.xml
 Mon Feb 27 08:38:07 2017
@@ -210,6 +210,36 @@
         <multiValued>true</multiValued>
         <mandatory>false</mandatory>
     </configurationParameter>
+    <configurationParameter>
+        <name>reindexOnlyMentionedTypes</name>
+        <type>Boolean</type>
+        <multiValued>false</multiValued>
+        <mandatory>false</mandatory>
+    </configurationParameter>
+    <configurationParameter>
+        <name>indexOnlyMentionedTypes</name>
+        <type>Boolean</type>
+        <multiValued>false</multiValued>
+        <mandatory>false</mandatory>
+    </configurationParameter>
+    <configurationParameter>
+        <name>indexAdditionally</name>
+        <type>String</type>
+        <multiValued>true</multiValued>
+        <mandatory>false</mandatory>
+    </configurationParameter>
+    <configurationParameter>
+        <name>emptyIsInvisible</name>
+        <type>Boolean</type>
+        <multiValued>false</multiValued>
+        <mandatory>false</mandatory>
+    </configurationParameter>
+    <configurationParameter>
+        <name>modifyDataPath</name>
+        <type>Boolean</type>
+        <multiValued>false</multiValued>
+        <mandatory>false</mandatory>
+    </configurationParameter>
     </configurationParameters>
     <configurationParameterSettings>
       <nameValuePair>
@@ -260,6 +290,12 @@
           <boolean>false</boolean>
         </value>
       </nameValuePair>
+      <nameValuePair>
+        <name>emptyIsInvisible</name>
+        <value>
+          <boolean>true</boolean>
+        </value>
+      </nameValuePair>
     </configurationParameterSettings>
     <typeSystemDescription>
       <imports>

Modified: uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml
URL: 
http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml?rev=1784507&r1=1784506&r2=1784507&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml (original)
+++ uima/ruta/trunk/ruta-docbook/src/docbook/tools.ruta.overview.xml Mon Feb 27 
08:38:07 2017
@@ -820,6 +820,38 @@ Document{-> EXEC(MyAnalysisEngine, {MyTy
                 </row>
                 <row>
                   <entry>
+                    <link 
linkend='ugr.tools.ruta.ae.basic.parameter.reindexOnlyMentionedTypes'>reindexOnlyMentionedTypes</link>
+                  </entry>
+                  <entry>Option to reindex only mentioned types internally in 
ruta.
+                  </entry>
+                  <entry>Single Boolean</entry>
+                </row>
+                <row>
+                  <entry>
+                    <link 
linkend='ugr.tools.ruta.ae.basic.parameter.indexOnlyMentionedTypes'>indexOnlyMentionedTypes</link>
+                  </entry>
+                  <entry>Option to index only mentioned types internally in 
ruta.
+                  </entry>
+                  <entry>Single Boolean</entry>
+                </row>
+                <row>
+                  <entry>
+                    <link 
linkend='ugr.tools.ruta.ae.basic.parameter.indexAdditionally'>indexAdditionally</link>
+                  </entry>
+                  <entry>Option to index types additional to the mentioned 
ones internally in ruta.
+                  </entry>
+                  <entry>Multi String</entry>
+                </row>
+                <row>
+                  <entry>
+                    <link 
linkend='ugr.tools.ruta.ae.basic.parameter.emptyIsInvisible'>emptyIsInvisible</link>
+                  </entry>
+                  <entry>Option to define empty text positions as invisible.
+                  </entry>
+                  <entry>Single Boolean</entry>
+                </row>
+                <row>
+                  <entry>
                     <link 
linkend='ugr.tools.ruta.ae.basic.parameter.modifyDataPath'>modifyDataPath</link>
                   </entry>
                   <entry>Option to extend the datapath by the descriptorPaths
@@ -1061,6 +1093,39 @@ Document{-> EXEC(MyAnalysisEngine, {MyTy
             Default value is uima.tcas.Annotation
           </para>
         </section>
+        <section 
id="ugr.tools.ruta.ae.basic.parameter.reindexOnlyMentionedTypes">
+          <title>reindexOnlyMentionedTypes</title>
+          <para>
+           If this parameter is activated, then only annotations of types are 
internally reindexed at
+           beginning that are mentioned with in the rules. This parameter 
overrides the values of the parameter
+           'reindexOnly' with the types that are mentioned in the rules. 
Default value is false.
+          </para>
+        </section>
+        <section 
id="ugr.tools.ruta.ae.basic.parameter.indexOnlyMentionedTypes">
+          <title>indexOnlyMentionedTypes</title>
+          <para>
+           If this parameter is activated, then only annotations of types are 
internally indexed that are
+           mentioned with in the rules. This optimization of the internal 
indexing can improve the speed
+           and reduce the memory footprint. However, several features of the 
rule matching require the
+           indexing of types that are not mentioned in the rules, e.g., 
literal rule matches, wildcards
+           and actions like MARKFAST, MARKTABLE, TRIE. Default value is false.
+          </para>
+        </section>
+        <section id="ugr.tools.ruta.ae.basic.parameter.indexAdditionally">
+          <title>indexAdditionally</title>
+          <para>
+           This parameter specifies annotation types (resolvable mentions are 
also supported) that should
+           be index additionally to types mentioned in the rules. This 
parameter is only used if the
+           parameter 'indexOnlyMentionedTypes' is activated.
+          </para>
+        </section>
+        <section id="ugr.tools.ruta.ae.basic.parameter.emptyIsInvisible">
+          <title>emptyIsInvisible</title>
+          <para>
+           This parameter determines positions as invisible if the internal 
indexing of the corresponding
+           RutaBasic annotation is empty. Default value is true.
+          </para>
+        </section>
         <section id="ugr.tools.ruta.ae.basic.parameter.modifyDataPath">
           <title>modifyDataPath</title>
           <para>

Propchange: uima/ruta/trunk/ruta-typesystem/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Mon Feb 27 08:38:07 2017
@@ -1,2 +1,4 @@
 .settings
 target
+.classpath
+.project


Reply via email to