You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2022/06/28 09:55:24 UTC
svn commit: r1902306 [2/3] - in /uima/site/trunk/uima-website: docs/ docs/d/ruta-current/ docs/d/ruta-current/issuesFixed/ docs/d/ruta-current/issuesFixed/css/ docs/d/ruta-current/issuesFixed/images/ docs/d/ruta-current/issuesFixed/images/logos/ xdocs/...
Modified: uima/site/trunk/uima-website/docs/d/ruta-current/tools.ruta.book.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/ruta-current/tools.ruta.book.html?rev=1902306&r1=1902305&r2=1902306&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/d/ruta-current/tools.ruta.book.html (original)
+++ uima/site/trunk/uima-website/docs/d/ruta-current/tools.ruta.book.html Tue Jun 28 09:55:23 2022
@@ -1,10 +1,10 @@
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>Apache UIMA Ruta™ Guide and Reference</title><link rel="stylesheet" type="text/css" href="css/stylesheet-html.css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book" title="Apache UIMA Ruta™ Guide and Reference" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div><h1 class="title">Apache UIMA Ruta™ Guide and Reference</h1></div><div><div class="authorgroup">
+ <title>Apache UIMA Ruta™ Guide and Reference</title><link rel="stylesheet" type="text/css" href="css/stylesheet-html.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book" id="d5e1"><div xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div><h1 class="title">Apache UIMA Ruta™ Guide and Reference</h1></div><div><div class="authorgroup">
<h3 class="corpauthor">Written and maintained by the Apache UIMA Development Community</h3>
- </div></div><div><p class="releaseinfo">Version 3.1.0</p></div><div><p class="copyright">Copyright © 2011, 2021 The Apache Software Foundation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a>
+ </div></div><div><p class="releaseinfo">Version 3.2.0</p></div><div><p class="copyright">Copyright © 2011, 2022 The Apache Software Foundation</p></div><div><div class="legalnotice" id="d5e8">
<p> </p>
- <p title="License and Disclaimer">
+ <p>
<b>License and Disclaimer. </b>
The ASF licenses this documentation
@@ -14,7 +14,7 @@
</p><div class="blockquote"><blockquote class="blockquote">
<a class="ulink" href="http://www.apache.org/licenses/LICENSE-2.0" target="_top">http://www.apache.org/licenses/LICENSE-2.0</a>
- </blockquote></div><p title="License and Disclaimer">
+ </blockquote></div><p>
Unless required by applicable law or agreed to in writing,
this documentation and its contents are distributed under the License
@@ -27,7 +27,7 @@
</p>
<p> </p>
<p> </p>
- <p title="Trademarks">
+ <p>
<b>Trademarks. </b>
All terms mentioned in the text that are known to be trademarks or
service marks have been appropriately capitalized. Use of such terms
@@ -35,19 +35,19 @@
the trademark or service mark.
</p>
- </div></div><div><p class="pubdate">May, 2021</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#ugr.tools.ruta.overview">1. Apache UIMA Ruta Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.overview.intro">1.1. What is Apache UIMA Ruta?</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.overview.gettingstarted">1.2. Getting started</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.overview.coreconcepts">1.3. Core Concepts</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.overview.examples">1.4. Learning by Example</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae">1.5. UIMA Analysis Engines</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.ae.basic">1.5.1. Ruta Engine</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.annotationwriter">1.5.2. Annotation Writer</a></span></dt><d
t><span class="section"><a href="#ugr.tools.ruta.ae.plaintext">1.5.3. Plain Text Annotator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.modifier">1.5.4. Modifier</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.html">1.5.5. HTML Annotator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.htmlconverter">1.5.6. HTML Converter</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.stylemap">1.5.7. Style Map Creator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.cutter">1.5.8. Cutter</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.view">1.5.9. View Writer</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.xmi">1.5.10. XMI Writer</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.ruta.language.language">2. Apache UIMA Ruta Language</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.syntax">2
.1. Syntax</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.anchoring">2.2. Rule elements and their matching order</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.seeding">2.3. Basic annotations and tokens</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier">2.4. Quantifiers</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.sg">2.4.1. * Star Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.sr">2.4.2. *? Star Reluctant</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.pg">2.4.3. + Plus Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.pr">2.4.4. +? Plus Reluctant</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.qg">2.4.5. ? Question Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tool
s.ruta.language.quantifier.qr">2.4.6. ?? Question Reluctant</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.mmg">2.4.7. [x,y] Min Max Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.mmr">2.4.8. [x,y]? Min Max Reluctant</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations">2.5. Declarations</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.type">2.5.1. Types</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.variable">2.5.2. Variables</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.ressource">2.5.3. Resources</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.scripts">2.5.4. Scripts</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.components">2.5.5. Components</a
></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions">2.6. Expressions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.type">2.6.1. Type Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.annotation">2.6.2. Annotation Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.number">2.6.3. Number Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.string">2.6.4. String Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.boolean">2.6.5. Boolean Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.lists">2.6.6. List Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.features">2.6.7. Feature Expressions</a></span></dt></dl></d
d><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions">2.7. Conditions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.after">2.7.1. AFTER</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.and">2.7.2. AND</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.before">2.7.3. BEFORE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.contains">2.7.4. CONTAINS</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.contextcount">2.7.5. CONTEXTCOUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.count">2.7.6. COUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.currentcount">2.7.7. CURRENTCOUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.endswith">2.7.8. ENDSWITH</a></span></d
t><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.feature">2.7.9. FEATURE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.if">2.7.10. IF</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.inlist">2.7.11. INLIST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.is">2.7.12. IS</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.last">2.7.13. LAST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.mofn">2.7.14. MOFN</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.near">2.7.15. NEAR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.not">2.7.16. NOT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.or">2.7.17. OR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.lang
uage.conditions.parse">2.7.18. PARSE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.partof">2.7.19. PARTOF</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.partofneq">2.7.20. PARTOFNEQ</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.position">2.7.21. POSITION</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.regexp">2.7.22. REGEXP</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.score">2.7.23. SCORE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.size">2.7.24. SIZE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.startswith">2.7.25. STARTSWITH</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.totalcount">2.7.26. TOTALCOUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.la
nguage.conditions.vote">2.7.27. VOTE</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.actions">2.8. Actions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.add">2.8.1. ADD</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.addfiltertype">2.8.2. ADDFILTERTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.addretaintype">2.8.3. ADDRETAINTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.assign">2.8.4. ASSIGN</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.call">2.8.5. CALL</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.clear">2.8.6. CLEAR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.color">2.8.7. COLOR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.configure">2.
8.8. CONFIGURE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.create">2.8.9. CREATE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.del">2.8.10. DEL</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.dynamicanchoring">2.8.11. DYNAMICANCHORING</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.exec">2.8.12. EXEC</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.fill">2.8.13. FILL</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.filtertype">2.8.14. FILTERTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.gather">2.8.15. GATHER</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.get">2.8.16. GET</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.getfeature">2.8.17. GETFEATURE</a></span></d
t><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.getlist">2.8.18. GETLIST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.greedyanchoring">2.8.19. GREEDYANCHORING</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.log">2.8.20. LOG</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.mark">2.8.21. MARK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markfast">2.8.22. MARKFAST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markfirst">2.8.23. MARKFIRST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.marklast">2.8.24. MARKLAST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markonce">2.8.25. MARKONCE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markscore">2.8.26. MARKSCORE</a></span></dt><dt><sp
an class="section"><a href="#ugr.tools.ruta.language.actions.marktable">2.8.27. MARKTABLE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.matchedtext">2.8.28. MATCHEDTEXT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.merge">2.8.29. MERGE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.remove">2.8.30. REMOVE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.removeduplicate">2.8.31. REMOVEDUPLICATE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.removefiltertype">2.8.32. REMOVEFILTERTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.removeretaintype">2.8.33. REMOVERETAINTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.replace">2.8.34. REPLACE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.retaintype">2.
8.35. RETAINTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.setfeature">2.8.36. SETFEATURE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.shift">2.8.37. SHIFT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.split">2.8.38. SPLIT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.transfer">2.8.39. TRANSFER</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.trie">2.8.40. TRIE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.trim">2.8.41. TRIM</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.unmark">2.8.42. UNMARK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.unmarkall">2.8.43. UNMARKALL</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.filtering">2.9. Robust extraction using f
iltering</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.wildcard">2.10. Wildcard #</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.optional">2.11. Optional match _</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.labels">2.12. Label expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks">2.13. Blocks</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.block">2.13.1. BLOCK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.foreach">2.13.2. FOREACH</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.inlined">2.14. Inlined rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.macro">2.15. Macros for conditions and actions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.score">2.16. Heuristic extraction using scorin
g rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.modification">2.17. Modification</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.external_resources">2.18. External resources</a></span></dt><dd><dl><dt><span class="section"><a href="#d5e2662">2.18.1. WORDLISTs</a></span></dt><dt><span class="section"><a href="#d5e2684">2.18.2. WORDTABLEs</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.regexprule">2.19. Simple Rules based on Regular Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions">2.20. Language Extensions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.core-ext">2.20.1. Provided Extensions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.new">2.20.2. Adding new Language Elements</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.la
nguage.internal_indxexing">2.21. Internal indexing and reindexing</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.internal_indxexing.why">2.21.1. Why additional indexing?</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.internal_indxexing.how">2.21.2. How is it stored, created and updated?</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.internal_indxexing.optimize">2.21.3. How to optimize the performance?</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.ruta.workbench">3. Apache UIMA Ruta Workbench</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.install">3.1. Installation</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.overview">3.2. UIMA Ruta Workbench Overview</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.projects">3.3. UIMA Ruta Projects</a></spa
n></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.projects.create_projects">3.3.1. UIMA Ruta create project wizard</a></span></dt></dl></dd><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_perspective">3.4. UIMA Ruta Perspective</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_perspective.annotation_browser">3.4.1. Annotation Browser</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_perspective.selection">3.4.2. Selection</a></span></dt></dl></dd><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective">3.5. UIMA Ruta Explain Perspective</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.applied_rules">3.5.1. Applied Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.matched_and_failed_rule
s">3.5.2. Matched Rules and Failed Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.rule_elements">3.5.3. Rule Elements</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.inlined_rules">3.5.4. Inlined Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.covering_rules">3.5.5. Covering Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.rule_list">3.5.6. Rule List</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.created_by">3.5.7. Created By</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.statistics">3.5.8. Statistics</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.cde">3.6. UIMA Ruta CDE perspective</a></spa
n></dt><dd><dl><dt><span class="section"><a href="#section.tools.ruta.workbench.cde.documents">3.6.1. CDE Documents view</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.cde.constraints">3.6.2. CDE Constraints view</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.cde.result">3.6.3. CDE Result view</a></span></dt></dl></dd><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_query">3.7. Ruta Query View</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.testing">3.8. Testing</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.testing.usage">3.8.1. Usage</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.testing.evaluators">3.8.2. Evaluators</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler">3.9. TextRuler</a></span></dt><dd><dl><dt><span class="secti
on"><a href="#section.tools.ruta.workbench.textruler.learner">3.9.1. Included rule learning algorithms</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler.ui">3.9.2. The TextRuler view</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.check">3.10. Check Annotations view</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.create_dictionaries">3.11. Creation of Tree Word Lists</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.workbench.apply">3.12. Apply a UIMA Ruta script to a folder</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.ruta.howtos">4. Apache UIMA Ruta HowTos</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.ae.basic.apply">4.1. Apply UIMA Ruta Analysis Engine in plain Java</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.integration">4.2. Integrating UIMA Ruta in an existing UIMA Annot
ator</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.ae.integration.mvn">4.2.1. Adding Ruta to our Annotator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.integration.loading">4.2.2. Developing Ruta rules and applying them from inside Java code
- </a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.maven">4.3. UIMA Ruta Maven Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="#d5e3623">4.3.1. generate goal</a></span></dt><dt><span class="section"><a href="#d5e3628">4.3.2. twl goal</a></span></dt><dt><span class="section"><a href="#d5e3632">4.3.3. mtwl goal</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.archetype">4.4. UIMA Ruta Maven Archetype</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler.example">4.5. Induce rules with the TextRuler framework</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.html">4.6. HTML annotations in plain text</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.sorter">4.7. Sorting files with UIMA Ruta</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.xml">4.8. Converting XML documents with UIMA Ruta</a></span></dt
></dl></dd></dl></div>
+ </div></div><div><p class="pubdate">June, 2022</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#ugr.tools.ruta.overview">1. Apache UIMA Ruta Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.overview.intro">1.1. What is Apache UIMA Ruta?</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.overview.gettingstarted">1.2. Getting started</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.overview.coreconcepts">1.3. Core Concepts</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.overview.examples">1.4. Learning by Example</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae">1.5. UIMA Analysis Engines</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.ae.basic">1.5.1. Ruta Engine</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.annotationwriter">1.5.2. Annotation Writer</a><
/span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.plaintext">1.5.3. Plain Text Annotator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.modifier">1.5.4. Modifier</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.html">1.5.5. HTML Annotator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.htmlconverter">1.5.6. HTML Converter</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.stylemap">1.5.7. Style Map Creator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.cutter">1.5.8. Cutter</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.view">1.5.9. View Writer</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.xmi">1.5.10. XMI Writer</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.ruta.language.language">2. Apache UIMA Ruta Language</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.langu
age.syntax">2.1. Syntax</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.anchoring">2.2. Rule elements and their matching order</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.seeding">2.3. Basic annotations and tokens</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier">2.4. Quantifiers</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.sg">2.4.1. * Star Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.sr">2.4.2. *? Star Reluctant</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.pg">2.4.3. + Plus Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.pr">2.4.4. +? Plus Reluctant</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.qg">2.4.5. ? Question Greedy</a></span></dt><dt><span class="section"><a hr
ef="#ugr.tools.ruta.language.quantifier.qr">2.4.6. ?? Question Reluctant</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.mmg">2.4.7. [x,y] Min Max Greedy</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.quantifier.mmr">2.4.8. [x,y]? Min Max Reluctant</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations">2.5. Declarations</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.type">2.5.1. Types</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.variable">2.5.2. Variables</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.ressource">2.5.3. Resources</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.scripts">2.5.4. Scripts</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.declarations.components">2.5.5.
Components</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions">2.6. Expressions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.type">2.6.1. Type Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.annotation">2.6.2. Annotation Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.number">2.6.3. Number Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.string">2.6.4. String Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.boolean">2.6.5. Boolean Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.lists">2.6.6. List Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.features">2.6.7. Feature Expressions</a></span>
</dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions">2.7. Conditions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.after">2.7.1. AFTER</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.and">2.7.2. AND</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.before">2.7.3. BEFORE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.contains">2.7.4. CONTAINS</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.contextcount">2.7.5. CONTEXTCOUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.count">2.7.6. COUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.currentcount">2.7.7. CURRENTCOUNT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.endswith">2.7.8. ENDSWITH<
/a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.feature">2.7.9. FEATURE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.if">2.7.10. IF</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.inlist">2.7.11. INLIST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.is">2.7.12. IS</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.last">2.7.13. LAST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.mofn">2.7.14. MOFN</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.near">2.7.15. NEAR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.not">2.7.16. NOT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.or">2.7.17. OR</a></span></dt><dt><span class="section"><a href="#ugr.to
ols.ruta.language.conditions.parse">2.7.18. PARSE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.partof">2.7.19. PARTOF</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.partofneq">2.7.20. PARTOFNEQ</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.position">2.7.21. POSITION</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.regexp">2.7.22. REGEXP</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.score">2.7.23. SCORE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.size">2.7.24. SIZE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.startswith">2.7.25. STARTSWITH</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.totalcount">2.7.26. TOTALCOUNT</a></span></dt><dt><span class="section"><a href="#ugr.
tools.ruta.language.conditions.vote">2.7.27. VOTE</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.actions">2.8. Actions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.add">2.8.1. ADD</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.addfiltertype">2.8.2. ADDFILTERTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.addretaintype">2.8.3. ADDRETAINTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.assign">2.8.4. ASSIGN</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.call">2.8.5. CALL</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.clear">2.8.6. CLEAR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.color">2.8.7. COLOR</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.
configure">2.8.8. CONFIGURE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.create">2.8.9. CREATE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.del">2.8.10. DEL</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.dynamicanchoring">2.8.11. DYNAMICANCHORING</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.exec">2.8.12. EXEC</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.fill">2.8.13. FILL</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.filtertype">2.8.14. FILTERTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.gather">2.8.15. GATHER</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.get">2.8.16. GET</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.getfeature">2.8.17. GETFEATURE<
/a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.getlist">2.8.18. GETLIST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.greedyanchoring">2.8.19. GREEDYANCHORING</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.log">2.8.20. LOG</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.mark">2.8.21. MARK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markfast">2.8.22. MARKFAST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markfirst">2.8.23. MARKFIRST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.marklast">2.8.24. MARKLAST</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markonce">2.8.25. MARKONCE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.markscore">2.8.26. MARKSCORE</a></span
></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.marktable">2.8.27. MARKTABLE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.matchedtext">2.8.28. MATCHEDTEXT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.merge">2.8.29. MERGE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.remove">2.8.30. REMOVE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.removeduplicate">2.8.31. REMOVEDUPLICATE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.removefiltertype">2.8.32. REMOVEFILTERTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.removeretaintype">2.8.33. REMOVERETAINTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.replace">2.8.34. REPLACE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.r
etaintype">2.8.35. RETAINTYPE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.setfeature">2.8.36. SETFEATURE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.shift">2.8.37. SHIFT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.split">2.8.38. SPLIT</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.transfer">2.8.39. TRANSFER</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.trie">2.8.40. TRIE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.trim">2.8.41. TRIM</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.unmark">2.8.42. UNMARK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.actions.unmarkall">2.8.43. UNMARKALL</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.filtering">2.9. Robust extra
ction using filtering</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.wildcard">2.10. Wildcard #</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.optional">2.11. Optional match _</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.labels">2.12. Label expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks">2.13. Blocks</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.block">2.13.1. BLOCK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.foreach">2.13.2. FOREACH</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.inlined">2.14. Inlined rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.macro">2.15. Macros for conditions and actions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.score">2.16. Heuristic extraction
using scoring rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.modification">2.17. Modification</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.external_resources">2.18. External resources</a></span></dt><dd><dl><dt><span class="section"><a href="#d5e2662">2.18.1. WORDLISTs</a></span></dt><dt><span class="section"><a href="#d5e2684">2.18.2. WORDTABLEs</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.regexprule">2.19. Simple Rules based on Regular Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions">2.20. Language Extensions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.core-ext">2.20.1. Provided Extensions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.new">2.20.2. Adding new Language Elements</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.
tools.ruta.language.internal_indxexing">2.21. Internal indexing and reindexing</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.internal_indxexing.why">2.21.1. Why additional indexing?</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.internal_indxexing.how">2.21.2. How is it stored, created and updated?</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.internal_indxexing.optimize">2.21.3. How to optimize the performance?</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#ugr.tools.ruta.workbench">3. Apache UIMA Ruta Workbench</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.install">3.1. Installation</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.overview">3.2. UIMA Ruta Workbench Overview</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.projects">3.3. UIMA Ruta Proj
ects</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.projects.create_projects">3.3.1. UIMA Ruta create project wizard</a></span></dt></dl></dd><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_perspective">3.4. UIMA Ruta Perspective</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_perspective.annotation_browser">3.4.1. Annotation Browser</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_perspective.selection">3.4.2. Selection</a></span></dt></dl></dd><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective">3.5. UIMA Ruta Explain Perspective</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.applied_rules">3.5.1. Applied Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.matched_an
d_failed_rules">3.5.2. Matched Rules and Failed Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.rule_elements">3.5.3. Rule Elements</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.inlined_rules">3.5.4. Inlined Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.covering_rules">3.5.5. Covering Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.rule_list">3.5.6. Rule List</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.created_by">3.5.7. Created By</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.statistics">3.5.8. Statistics</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.cde">3.6. UIMA Ruta CDE perspec
tive</a></span></dt><dd><dl><dt><span class="section"><a href="#section.tools.ruta.workbench.cde.documents">3.6.1. CDE Documents view</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.cde.constraints">3.6.2. CDE Constraints view</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.cde.result">3.6.3. CDE Result view</a></span></dt></dl></dd><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.ruta_query">3.7. Ruta Query View</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.testing">3.8. Testing</a></span></dt><dd><dl><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.testing.usage">3.8.1. Usage</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.testing.evaluators">3.8.2. Evaluators</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler">3.9. TextRuler</a></span></dt><dd><dl><dt><span
class="section"><a href="#section.tools.ruta.workbench.textruler.learner">3.9.1. Included rule learning algorithms</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler.ui">3.9.2. The TextRuler view</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.check">3.10. Check Annotations view</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.create_dictionaries">3.11. Creation of Tree Word Lists</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.workbench.apply">3.12. Apply a UIMA Ruta script to a folder</a></span></dt></dl></dd><dt><span class="chapter"><a href="#ugr.tools.ruta.howtos">4. Apache UIMA Ruta HowTos</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.ae.basic.apply">4.1. Apply UIMA Ruta Analysis Engine in plain Java</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.integration">4.2. Integrating UIMA Ruta in an existi
ng UIMA Annotator</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.ae.integration.mvn">4.2.1. Adding Ruta to our Annotator</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.ae.integration.loading">4.2.2. Developing Ruta rules and applying them from inside Java code
+ </a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.maven">4.3. UIMA Ruta Maven Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="#d5e3624">4.3.1. generate goal</a></span></dt><dt><span class="section"><a href="#d5e3629">4.3.2. twl goal</a></span></dt><dt><span class="section"><a href="#d5e3633">4.3.3. mtwl goal</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.archetype">4.4. UIMA Ruta Maven Archetype</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler.example">4.5. Induce rules with the TextRuler framework</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.html">4.6. HTML annotations in plain text</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.sorter">4.7. Sorting files with UIMA Ruta</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.xml">4.8. Converting XML documents with UIMA Ruta</a></span></dt
></dl></dd></dl></div>
- <div class="chapter" title="Chapter 1. Apache UIMA Ruta Overview" id="ugr.tools.ruta.overview"><div class="titlepage"><div><div><h2 class="title">Chapter 1. Apache UIMA Ruta Overview</h2></div></div></div>
+ <div class="chapter" id="ugr.tools.ruta.overview"><div class="titlepage"><div><div><h1 class="title">Chapter 1. Apache UIMA Ruta Overview</h1></div></div></div>
<p>
</p>
- <div class="section" title="1.1. What is Apache UIMA Ruta?"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.tools.ruta.overview.intro">1.1. What is Apache UIMA Ruta?</h2></div></div></div>
+ <div class="section" id="ugr.tools.ruta.overview.intro"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.1. What is Apache UIMA Ruta?</h2></div></div></div>
<p>
Apache UIMA Ruta™ is a rule-based script language supported by Eclipse-based tooling.
@@ -60,7 +60,7 @@
</p>
</div>
- <div class="section" title="1.2. Getting started"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.tools.ruta.overview.gettingstarted">1.2. Getting started</h2></div></div></div>
+ <div class="section" id="ugr.tools.ruta.overview.gettingstarted"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.2. Getting started</h2></div></div></div>
<p>
This section gives a short roadmap how to read the documentation and gives some recommendations how to
@@ -98,7 +98,7 @@
</p>
</div>
- <div class="section" title="1.3. Core Concepts"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.tools.ruta.overview.coreconcepts">1.3. Core Concepts</h2></div></div></div>
+ <div class="section" id="ugr.tools.ruta.overview.coreconcepts"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.3. Core Concepts</h2></div></div></div>
<p>
The UIMA Ruta language is an imperative rule language extended with scripting elements. A UIMA Ruta rule defines a
@@ -161,7 +161,7 @@
</p>
</div>
- <div class="section" title="1.4. Learning by Example"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.tools.ruta.overview.examples">1.4. Learning by Example</h2></div></div></div>
+ <div class="section" id="ugr.tools.ruta.overview.examples"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.4. Learning by Example</h2></div></div></div>
<p>
This section gives an introduction to the UIMA Ruta language by explaining the rule syntax
@@ -692,14 +692,14 @@ Document{-> EXEC(MyAnalysisEngine, {M
</div>
- <div class="section" title="1.5. UIMA Analysis Engines"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="ugr.tools.ruta.ae">1.5. UIMA Analysis Engines</h2></div></div></div>
+ <div class="section" id="ugr.tools.ruta.ae"><div class="titlepage"><div><div><h2 class="title" style="clear: both">1.5. UIMA Analysis Engines</h2></div></div></div>
<p>This section gives an overview of the UIMA Analysis Engines shipped with UIMA Ruta. The most
important one is <span class="quote">“<span class="quote">RutaEngine</span>”</span>, a generic analysis engine, which is able to interpret
and execute script files. The other analysis engines provide support for some additional functionality or
add certain types of annotations.
</p>
- <div class="section" title="1.5.1. Ruta Engine"><div class="titlepage"><div><div><h3 class="title" id="ugr.tools.ruta.ae.basic">1.5.1. Ruta Engine</h3></div></div></div>
+ <div class="section" id="ugr.tools.ruta.ae.basic"><div class="titlepage"><div><div><h3 class="title">1.5.1. Ruta Engine</h3></div></div></div>
<p>
This generic Analysis Engine is the most important one for the UIMA Ruta language since it is
@@ -710,7 +710,7 @@ Document{-> EXEC(MyAnalysisEngine, {M
The available configuration parameters of the UIMA Ruta Analysis Engine are described in the following.
</p>
- <div class="section" title="1.5.1.1. Configuration Parameters"><div class="titlepage"><div><div><h4 class="title" id="ugr.tools.ruta.ae.basic.parameter">1.5.1.1. Configuration Parameters</h4></div></div></div>
+ <div class="section" id="ugr.tools.ruta.ae.basic.parameter"><div class="titlepage"><div><div><h4 class="title">1.5.1.1. Configuration Parameters</h4></div></div></div>
<p>
The configuration parameters of the UIMA Ruta Analysis Engine can be subdivided into three
@@ -729,152 +729,152 @@ Document{-> EXEC(MyAnalysisEngine, {M
(see <a class="xref" href="#ugr.tools.ruta.language.actions.dynamicanchoring" title="2.8.11. DYNAMICANCHORING">Section 2.8.11, “DYNAMICANCHORING”</a>) is recommended.
</p>
<p>
- </p><div class="table"><a name="table.ugr.tools.ruta.ae.parameter"></a><p class="title"><b>Table 1.1. Configuration parameters of the UIMA Ruta Analysis Engine </b></p><div class="table-contents">
+ </p><div class="table" id="table.ugr.tools.ruta.ae.parameter"><p class="title"><b>Table 1.1. Configuration parameters of the UIMA Ruta Analysis Engine </b></p><div class="table-contents">
- <table summary="Configuration parameters of the UIMA Ruta Analysis Engine " style="border-collapse: collapse;border-top: 0.5pt solid black; border-bottom: 0.5pt solid black; border-left: 0.5pt solid black; border-right: 0.5pt solid black; "><colgroup><col class="c1"><col class="c2"><col class="c3"></colgroup><thead><tr><th style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; " align="center">Name</th><th style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; " align="center">Short description</th><th style="border-bottom: 0.5pt solid black; " align="center">Type</th></tr></thead><tbody><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ <table class="table" summary="Configuration parameters of the UIMA Ruta Analysis Engine " style="border-collapse: collapse;border-top: 1px solid black; border-bottom: 1px solid black; border-left: 1px solid black; border-right: 1px solid black; "><colgroup><col class="c1"><col class="c2"><col class="c3"></colgroup><thead><tr><th style="border-right: 1px solid black; border-bottom: 1px solid black; " align="center">Name</th><th style="border-right: 1px solid black; border-bottom: 1px solid black; " align="center">Short description</th><th style="border-bottom: 1px solid black; " align="center">Type</th></tr></thead><tbody><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.mainScript" title="mainScript">mainScript</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Name with complete namespace of the script which will be interpreted and
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Name with complete namespace of the script which will be interpreted and
executed by the analysis engine.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.rules" title="rules">rules</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Script (list of rules) to be applied.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Script (list of rules) to be applied.
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.rules" title="rules">rulesScriptName</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">This parameter specifies the name of the non-existing script if the parameter 'rules' is used.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">This parameter specifies the name of the non-existing script if the parameter 'rules' is used.
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.scriptEncoding" title="scriptEncoding">scriptEncoding</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Encoding of all UIMA Ruta script files.</td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Encoding of all UIMA Ruta script files.</td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.scriptPaths" title="scriptPaths">scriptPaths</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of absolute locations, which contain the necessary script files like
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of absolute locations, which contain the necessary script files like
the main script.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.descriptorPaths" title="descriptorPaths">descriptorPaths</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of absolute locations, which contain the necessary descriptor files
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of absolute locations, which contain the necessary descriptor files
like type systems.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.resourcePaths" title="resourcePaths">resourcePaths</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of absolute locations, which contain the necessary resource files like
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of absolute locations, which contain the necessary resource files like
word lists.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.additionalScripts" title="additionalScripts">additionalScripts</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Optional list of names with complete namespace of additional scripts, which can be
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Optional list of names with complete namespace of additional scripts, which can be
referred to.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.additionalEngines" title="additionalEngines">additionalEngines</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Optional list of names with complete namespace of additional analysis engines, which
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Optional list of names with complete namespace of additional analysis engines, which
can be called by UIMA Ruta rules.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.additionalUimafitEngines" title="additionalUimafitEngines">additionalUimafitEngines</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Optional list of class names with complete namespace of additional uimaFIT analysis engines, which
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Optional list of class names with complete namespace of additional uimaFIT analysis engines, which
can be called by UIMA Ruta rules.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.additionalExtensions" title="additionalExtensions">additionalExtensions</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of factory classes for additional extensions of the UIMA Ruta language
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of factory classes for additional extensions of the UIMA Ruta language
like proprietary conditions.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.reloadScript" title="reloadScript">reloadScript</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to initialize the rule script each time the analysis engine processes
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to initialize the rule script each time the analysis engine processes
a CAS.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.seeders" title="seeders">seeders</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of class names that provide additional annotations before the rules are
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of class names that provide additional annotations before the rules are
executed.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.defaultFilteredTypes" title="defaultFilteredTypes">defaultFilteredTypes</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of complete type names of annotations that are invisible by default.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of complete type names of annotations that are invisible by default.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.removeBasics" title="removeBasics">removeBasics</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to remove all inference annotations after execution of the rule script.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to remove all inference annotations after execution of the rule script.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.indexOnly" title="indexOnly">indexOnly</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to select annotation types that should be indexed internally in ruta.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to select annotation types that should be indexed internally in ruta.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.indexSkipTypes" title="indexSkipTypes">indexSkipTypes</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to skip annotation types in the internal indexing.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to skip annotation types in the internal indexing.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.indexOnlyMentionedTypes" title="indexOnlyMentionedTypes">indexOnlyMentionedTypes</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to index only mentioned types internally in ruta.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to index only mentioned types internally in ruta.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.indexAdditionally" title="indexAdditionally">indexAdditionally</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to index types additionally to the mentioned ones internally in ruta.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to index types additionally to the mentioned ones internally in ruta.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.reindexOnly" title="reindexOnly">reindexOnly</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to select annotation types that should be reindexed internally in ruta.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to select annotation types that should be reindexed internally in ruta.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.reindexSkipTypes" title="reindexSkipTypes">reindexSkipTypes</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to skip annotation types in the internal reindexing.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to skip annotation types in the internal reindexing.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.reindexOnlyMentionedTypes" title="reindexOnlyMentionedTypes">reindexOnlyMentionedTypes</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to reindex only mentioned types internally in ruta.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to reindex only mentioned types internally in ruta.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.reindexAdditionally" title="reindexAdditionally">reindexAdditionally</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to reindex types additionally to the mentioned ones internally in ruta.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to reindex types additionally to the mentioned ones internally in ruta.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.indexUpdateMode" title="indexUpdateMode">indexUpdateMode</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Mode how internal indexing should be applied.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Mode how internal indexing should be applied.
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.indexUpdateMode" title="indexUpdateMode">validateInternalIndexing</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to validate the internal indexing.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to validate the internal indexing.
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.emptyIsInvisible" title="emptyIsInvisible">emptyIsInvisible</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to define empty text positions as invisible.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to define empty text positions as invisible.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.modifyDataPath" title="modifyDataPath">modifyDataPath</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to extend the datapath by the descriptorPaths
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to extend the datapath by the descriptorPaths
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.strictImports" title="strictImports">strictImports</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to restrict short type names resolution to those in the declared typesystems.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to restrict short type names resolution to those in the declared typesystems.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.typeIgnorePattern" title="typeIgnorePattern">typeIgnorePattern</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to ignore types even if they are available in the typesystem/CAS.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to ignore types even if they are available in the typesystem/CAS.
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.dynamicAnchoring" title="dynamicAnchoring">dynamicAnchoring</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to allow rule matches to start at any rule element.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to allow rule matches to start at any rule element.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.lowMemoryProfile" title="lowMemoryProfile">lowMemoryProfile</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to decrease the memory consumption when processing a large CAS.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to decrease the memory consumption when processing a large CAS.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.simpleGreedyForComposed" title="simpleGreedyForComposed">simpleGreedyForComposed</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to activate a different inferencer for composed rule elements.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to activate a different inferencer for composed rule elements.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.debug" title="debug">debug</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to add debug information to the CAS.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to add debug information to the CAS.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.debugWithMatches" title="debugWithMatches">debugWithMatches</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to add information about the rule matches to the CAS.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to add information about the rule matches to the CAS.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.debugAddToIndexes" title="debugAddToIndexes">debugAddToIndexes</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to add all debug information to the indexes.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to add all debug information to the indexes.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.debugOnlyFor" title="debugOnlyFor">debugOnlyFor</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of rule ids. If provided, then debug information is only created for
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of rule ids. If provided, then debug information is only created for
those rules.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.profile" title="profile">profile</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to add profile information to the CAS.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to add profile information to the CAS.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.statistics" title="statistics">statistics</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to add statistics of conditions and actions to the CAS.</td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to add statistics of conditions and actions to the CAS.</td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.createdBy" title="createdBy">createdBy</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Option to add additional information, which rule created an annotation.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Option to add additional information, which rule created an annotation.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.varNames" title="varNames">varNames</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">String array with names of variables. Is used in combination with varValues.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">String array with names of variables. Is used in combination with varValues.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.varValues" title="varValues">varValues</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">String array with values of variables. Is used in combination with varNames.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">String array with values of variables. Is used in combination with varNames.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.dictRemoveWS" title="dictRemoveWS">dictRemoveWS</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Remove whitespaces when loading dictionaries.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Boolean</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Remove whitespaces when loading dictionaries.
+ </td><td style="border-bottom: 1px solid black; ">Single Boolean</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.csvSeparator" title="csvSeparator">csvSeparator</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">String/token to be used to split columns in CSV tables.
- </td><td style="border-bottom: 0.5pt solid black; ">Single String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">String/token to be used to split columns in CSV tables.
+ </td><td style="border-bottom: 1px solid black; ">Single String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.inferenceVisitors" title="inferenceVisitors">inferenceVisitors</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of factory classes for additional inference visitors.
- </td><td style="border-bottom: 0.5pt solid black; ">Multi String</td></tr><tr><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">List of factory classes for additional inference visitors.
+ </td><td style="border-bottom: 1px solid black; ">Multi String</td></tr><tr><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.maxRuleMatches" title="maxRuleMatches">maxRuleMatches</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">Maximum amount of allowed matches of a single rule.
- </td><td style="border-bottom: 0.5pt solid black; ">Single Integer</td></tr><tr><td style="border-right: 0.5pt solid black; ">
+ </td><td style="border-right: 1px solid black; border-bottom: 1px solid black; ">Maximum amount of allowed matches of a single rule.
+ </td><td style="border-bottom: 1px solid black; ">Single Integer</td></tr><tr><td style="border-right: 1px solid black; ">
[... 4393 lines stripped ...]