You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by pk...@apache.org on 2021/05/18 08:50:03 UTC
svn commit: r1889992 [2/3] - in /uima/site/trunk/uima-website:
docs/d/ruta-current/tools.ruta.book.html
docs/d/ruta-current/tools.ruta.book.pdf docs/downloads.html docs/news.html
docs/ruta.html xdocs/news.xml xdocs/ruta.xml xdocs/stylesheets/project.xml
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=1889992&r1=1889991&r2=1889992&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 May 18 08:50:02 2021
@@ -2,7 +2,7 @@
<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">
<h3 class="corpauthor">Written and maintained by the Apache UIMA Development Community</h3>
- </div></div><div><p class="releaseinfo">Version 3.0.1</p></div><div><p class="copyright">Copyright © 2011, 2020 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.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>
<p> </p>
<p title="License and Disclaimer">
<b>License and Disclaimer. </b>
@@ -35,8 +35,8 @@
the trademark or service mark.
</p>
- </div></div><div><p class="pubdate">March, 2020</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>
<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.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.to
ols.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.tools.ruta.la
nguage.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.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
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 scor
ing 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="#d5e2598">2.18.1. WORDLISTs</a></span></dt><dt><span class="section"><a href="#d5e2620">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></dl></dd><dt><span class="chapter"><a href="#ugr.t
ools.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></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_and_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_l
ist">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></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.t
esting">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 existing 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="#d5e3530">4.3.1. generate goal</a></span></dt><dt><span class="section"><a href="#d5e3535">4.3.2. twl goal</a></span></dt><dt><span class="section"><a href="#d5e3539">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">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>
@@ -786,18 +786,36 @@ Document{-> EXEC(MyAnalysisEngine, {M
<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; ">
- <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 reindex internally in ruta.
+ <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; ">
+ <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; ">
- <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; ">
<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; ">
<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 additional to the mentioned ones internally in ruta.
+ </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; ">
+ <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; ">
+ <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; ">
+ <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; ">
+ <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; ">
+ <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; ">
+ <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; ">
<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; ">
@@ -807,6 +825,9 @@ Document{-> EXEC(MyAnalysisEngine, {M
<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; ">
+ <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; ">
<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; ">
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.lowMemoryProfile" title="lowMemoryProfile">lowMemoryProfile</a>
@@ -817,6 +838,8 @@ Document{-> EXEC(MyAnalysisEngine, {M
</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; ">
<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; ">
+ <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; ">
<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
those rules.
@@ -961,8 +984,8 @@ Document{-> EXEC(MyAnalysisEngine, {M
<p>
This list of string values refers to implementations of the interface "org.apache.uima.ruta.seed.RutaAnnotationSeeder",
- which can be used to automatically add annotations to the CAS. The default value of the parameter is a single seeder, namely "org.apache.uima.ruta.seed.DefaultSeeder"
- that adds annotations for token classes like CW, MARKUP or SEMICOLON. Remember that additional annotations can also be added with
+ which can be used to automatically add annotations to the CAS. The default value of the parameter is a single seeder, namely "org.apache.uima.ruta.seed.TextSeeder"
+ that adds annotations for token classes like CW, NUM and SEMICOLON, but not MARKUP. Remember that additional annotations can also be added with
an additional engine that is executed by a UIMA Ruta rule.
</p>
</div>
@@ -982,22 +1005,21 @@ Document{-> EXEC(MyAnalysisEngine, {M
The default value is set to false.
</p>
</div>
- <div class="section" title="reindexOnly"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.reindexOnly">reindexOnly</h5></div></div></div>
+ <div class="section" title="indexOnly"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.indexOnly">indexOnly</h5></div></div></div>
<p>
- This parameter specifies the annotation types which should be reindex for ruta's internal annotations
- All annotation types that changed since the last call of a ruta script need to be listed here.
- The value of this parameter needs only be adapted for performance optimization in pipelines that
- contains several ruta analysis engines.
- Default value is uima.tcas.Annotation
+ This parameter specifies the annotation types which should be indexed for ruta's internal
+ annotations. All annotation types that are relevant need to be listed here. The value of this
+ parameter needs only be adapted for performance and memory optimization in pipelines that
+ contains several ruta analysis engines. Default value is uima.tcas.Annotation
</p>
</div>
- <div class="section" title="reindexOnlyMentionedTypes"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.reindexOnlyMentionedTypes">reindexOnlyMentionedTypes</h5></div></div></div>
+ <div class="section" title="indexSkipTypes"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.indexSkipTypes">indexSkipTypes</h5></div></div></div>
<p>
- 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.
+ This parameter specifies annotation types that should not be indexed at all. These types
+ normally include annotations that provide no meaningful semantics for text processing, e.g.,
+ types concerning ruta debug information.
</p>
</div>
<div class="section" title="indexOnlyMentionedTypes"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.indexOnlyMentionedTypes">indexOnlyMentionedTypes</h5></div></div></div>
@@ -1013,11 +1035,64 @@ Document{-> EXEC(MyAnalysisEngine, {M
<div class="section" title="indexAdditionally"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.indexAdditionally">indexAdditionally</h5></div></div></div>
<p>
- This parameter specifies annotation types (resolvable mentions are also supported) that should
+ This parameter specifies annotation types that should
be index additionally to types mentioned in the rules. This parameter is only used if the
parameter 'indexOnlyMentionedTypes' is activated.
</p>
</div>
+ <div class="section" title="reindexOnly"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.reindexOnly">reindexOnly</h5></div></div></div>
+
+ <p>
+ This parameter specifies the annotation types which should be reindexed for ruta's internal annotations
+ All annotation types that changed since the last call of a ruta script need to be listed here.
+ The value of this parameter needs only be adapted for performance optimization in pipelines that
+ contains several ruta analysis engines.
+ Default value is uima.tcas.Annotation
+ </p>
+ </div>
+ <div class="section" title="reindexSkipTypes"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.reindexSkipTypes">reindexSkipTypes</h5></div></div></div>
+
+ <p>
+ This parameter specifies annotation types that should not be reindexed. These types normally
+ include annotations that are added once and are not changed in the following pipeline, e.g.,
+ Tokens or TokenSeed (like CW).
+ </p>
+ </div>
+ <div class="section" title="reindexOnlyMentionedTypes"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.reindexOnlyMentionedTypes">reindexOnlyMentionedTypes</h5></div></div></div>
+
+ <p>
+ 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.
+ </p>
+ </div>
+ <div class="section" title="reindexAdditionally"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.reindexAdditionally">reindexAdditionally</h5></div></div></div>
+
+ <p>
+ This parameter specifies annotation types that should be reindexed additionally to types
+ mentioned in the rules. This parameter is only used if the parameter
+ 'reindexOnlyMentionedTypes' is activated.
+ </p>
+ </div>
+ <div class="section" title="indexUpdateMode"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.indexUpdateMode">indexUpdateMode</h5></div></div></div>
+
+ <p>
+ This parameter specifies the mode for updating the internal indexing in RutaBasic annotations.
+ This is a technical parameter for optimizing the runtime performance/speed of RutaEngines.
+ Available modes are: COMPLETE, ADDITIVE, SAFE_ADDITIVE, NONE.
+ Default value is ADDITIVE.
+ </p>
+ </div>
+ <div class="section" title="validateInternalIndexing"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.validateInternalIndexing">validateInternalIndexing</h5></div></div></div>
+
+ <p>
+ Option to validate the internal indexing in RutaBasic with the current CAS after the indexing
+ and reindexing is performed. Annotations that are not correctly indexing in RutaBasics cause
+ Exceptions. Annotations of types listed in parameter 'indexSkipTypes' and 'reindexSkipTypes'
+ are ignored. Default value is false.
+ </p>
+ </div>
+ validateInternalIndexing
<div class="section" title="emptyIsInvisible"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.emptyIsInvisible">emptyIsInvisible</h5></div></div></div>
<p>
@@ -1039,6 +1114,14 @@ Document{-> EXEC(MyAnalysisEngine, {M
The default value is set to false.
</p>
</div>
+ <div class="section" title="typeIgnorePattern"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.typeIgnorePattern">typeIgnorePattern</h5></div></div></div>
+
+ <p>
+ An optional pattern (regular expression) which defined types that should be ignored. These
+ types will not be resolved even if strictImports is set to false. This parameter can be used to
+ ignore complete namespaces of type that could contain ambiguous short names.
+ </p>
+ </div>
<div class="section" title="dynamicAnchoring"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.dynamicAnchoring">dynamicAnchoring</h5></div></div></div>
<p>
@@ -1078,6 +1161,13 @@ Document{-> EXEC(MyAnalysisEngine, {M
The default value of this parameter is set to false.
</p>
</div>
+ <div class="section" title="debugAddToIndexes"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.debugAddToIndexes">debugAddToIndexes</h5></div></div></div>
+
+ <p>
+ This parameter specifies whether all debug annotation should be added to the indexes. By
+ default this parameter is deactivated and only the root script apply is added.
+ </p>
+ </div>
<div class="section" title="debugOnlyFor"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.debugOnlyFor">debugOnlyFor</h5></div></div></div>
<p>
@@ -1954,7 +2044,7 @@ Matched: small Big Big Big small</pre><
Type declarations define new kinds of annotation types and
optionally their features.
</p>
- <div class="section" title="2.5.1.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1115">2.5.1.1.
+ <div class="section" title="2.5.1.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1179">2.5.1.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2050,7 +2140,7 @@ DECLARE ParentType NewType (SomeType fea
</p>
</li></ul></div><p>
</p>
- <div class="section" title="2.5.2.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1153">2.5.2.1.
+ <div class="section" title="2.5.2.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1217">2.5.2.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2092,7 +2182,7 @@ ANNOTATIONLIST newAnnotationList;</pre><
</p>
</li></ul></div><p>
</p>
- <div class="section" title="2.5.3.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1166">2.5.3.1.
+ <div class="section" title="2.5.3.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1230">2.5.3.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2110,7 +2200,7 @@ WORDTABLE tableName = 'someTable.csv';</
is not necessary to import the Type System of the additional rule
script.
</p>
- <div class="section" title="2.5.4.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1174">2.5.4.1.
+ <div class="section" title="2.5.4.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1238">2.5.4.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2152,7 +2242,7 @@ Document{->CALL(AnotherScript)}; // &
</p>
</li></ul></div><p>
</p>
- <div class="section" title="2.5.5.1. Type System Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1190">2.5.5.1.
+ <div class="section" title="2.5.5.1. Type System Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1254">2.5.5.1.
<span class="bold"><strong>Type System Example:</strong></span>
</h4></div></div></div>
@@ -2185,7 +2275,7 @@ IMPORT PACKAGE * FROM my.package.Externa
</p>
</div>
- <div class="section" title="2.5.5.2. Analysis Engine Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1195">2.5.5.2.
+ <div class="section" title="2.5.5.2. Analysis Engine Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1259">2.5.5.2.
<span class="bold"><strong>Analysis Engine Example:</strong></span>
</h4></div></div></div>
@@ -2234,7 +2324,7 @@ Document{-> EXEC(AnotherEngine, {Some
).
</li></ol></div><p>
</p>
- <div class="section" title="2.6.1.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1216">2.6.1.1.
+ <div class="section" title="2.6.1.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1280">2.6.1.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2243,7 +2333,7 @@ Document{-> EXEC(AnotherEngine, {Some
| AnnotationExpression.type</pre><p>
</p>
</div>
- <div class="section" title="2.6.1.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1221">2.6.1.2.
+ <div class="section" title="2.6.1.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1285">2.6.1.2.
<span class="bold"><strong>Examples:</strong></span>
</h4></div></div></div>
@@ -2286,7 +2376,7 @@ Document{->ASSIGN(typeVar, Author)};<
).
</li></ol></div><p>
</p>
- <div class="section" title="2.6.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1240">2.6.2.1.
+ <div class="section" title="2.6.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1304">2.6.2.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2295,7 +2385,7 @@ Document{->ASSIGN(typeVar, Author)};<
| TypeExpression | FeatureExpression</pre><p>
</p>
</div>
- <div class="section" title="2.6.2.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1245">2.6.2.2.
+ <div class="section" title="2.6.2.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1309">2.6.2.2.
<span class="bold"><strong>Examples:</strong></span>
</h4></div></div></div>
@@ -2323,7 +2413,7 @@ e:EmplRelation.employer; // this feature
a complete overview, have a look at the following syntax definition
of number expressions.
</p>
- <div class="section" title="2.6.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1253">2.6.3.1.
+ <div class="section" title="2.6.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1317">2.6.3.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2353,7 +2443,7 @@ Digit -> ('0'..'9') <
<a class="xref" href="#ugr.tools.ruta.language.declarations.variable" title="2.5.2. Variables">Section 2.5.2, “Variables”</a>
.
</p>
- <div class="section" title="2.6.3.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1260">2.6.3.2.
+ <div class="section" title="2.6.3.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1324">2.6.3.2.
<span class="bold"><strong>Examples:</strong></span>
</h4></div></div></div>
@@ -2390,7 +2480,7 @@ Document{->ASSIGN(intVar1, 12 * intVa
</p>
</li></ol></div><p>
</p>
- <div class="section" title="2.6.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1276">2.6.4.1.
+ <div class="section" title="2.6.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1340">2.6.4.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2400,7 +2490,7 @@ SimpleStringExpression -> StringLit
| StringVariable</pre><p>
</p>
</div>
- <div class="section" title="2.6.4.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1281">2.6.4.2.
+ <div class="section" title="2.6.4.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1345">2.6.4.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2421,7 +2511,7 @@ Document{->ASSIGN(strVar, "strLiteral
true or false. To get a complete overview, have a look at the
following syntax definition of boolean expressions.
</p>
- <div class="section" title="2.6.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1289">2.6.5.1.
+ <div class="section" title="2.6.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1353">2.6.5.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2445,7 +2535,7 @@ BooleanLiteral -> "true" | "false
.
</p>
</div>
- <div class="section" title="2.6.5.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1296">2.6.5.2.
+ <div class="section" title="2.6.5.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1360">2.6.5.2.
<span class="bold"><strong>Examples:</strong></span>
</h4></div></div></div>
@@ -2511,7 +2601,7 @@ BooleanLiteral -> "true" | "false
<p>
List expression are a rather simple kind of expression.
</p>
- <div class="section" title="2.6.6.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1314">2.6.6.1.
+ <div class="section" title="2.6.6.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1378">2.6.6.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2590,7 +2680,7 @@ FeatureAssignmentExpression -> Featur
type. If a list of types is passed, this has to be true for at least
one of them.
</p>
- <div class="section" title="2.7.1.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1335">2.7.1.1.
+ <div class="section" title="2.7.1.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1399">2.7.1.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2598,7 +2688,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">AFTER(Type|TypeListExpression)</pre><p>
</p>
</div>
- <div class="section" title="2.7.1.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1340">2.7.1.2.
+ <div class="section" title="2.7.1.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1404">2.7.1.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2618,7 +2708,7 @@ FeatureAssignmentExpression -> Featur
The AND condition is a composed condition and evaluates true, if
all contained conditions evaluate true.
</p>
- <div class="section" title="2.7.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1349">2.7.2.1.
+ <div class="section" title="2.7.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1413">2.7.2.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2626,7 +2716,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">AND(Condition1,...,ConditionN)</pre><p>
</p>
</div>
- <div class="section" title="2.7.2.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1354">2.7.2.2.
+ <div class="section" title="2.7.2.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1418">2.7.2.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2650,7 +2740,7 @@ FeatureAssignmentExpression -> Featur
type. If a list of types is passed, this has to be true for at least
one of them.
</p>
- <div class="section" title="2.7.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1363">2.7.3.1.
+ <div class="section" title="2.7.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1427">2.7.3.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2658,7 +2748,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">BEFORE(Type|TypeListExpression)</pre><p>
</p>
</div>
- <div class="section" title="2.7.3.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1368">2.7.3.2.
+ <div class="section" title="2.7.3.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1432">2.7.3.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2688,7 +2778,7 @@ FeatureAssignmentExpression -> Featur
occurrence of the
passed type.
</p>
- <div class="section" title="2.7.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1377">2.7.4.1.
+ <div class="section" title="2.7.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1441">2.7.4.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2696,7 +2786,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">CONTAINS(Type(,NumberExpression,NumberExpression(,BooleanExpression)?)?)</pre><p>
</p>
</div>
- <div class="section" title="2.7.4.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1382">2.7.4.2.
+ <div class="section" title="2.7.4.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1446">2.7.4.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2740,7 +2830,7 @@ FeatureAssignmentExpression -> Featur
the index of the matched annotation is within a passed interval. If
no interval is passed, the condition always evaluates true.
</p>
- <div class="section" title="2.7.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1398">2.7.5.1.
+ <div class="section" title="2.7.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1462">2.7.5.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2748,7 +2838,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">CONTEXTCOUNT(Type(,NumberExpression,NumberExpression)?(,Variable)?)</pre><p>
</p>
</div>
- <div class="section" title="2.7.5.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1403">2.7.5.2.
+ <div class="section" title="2.7.5.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1467">2.7.5.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2783,7 +2873,7 @@ FeatureAssignmentExpression -> Featur
amount is within a specified interval. If no interval is passed, the
condition always evaluates true.
</p>
- <div class="section" title="2.7.6.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1412">2.7.6.1.
+ <div class="section" title="2.7.6.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1476">2.7.6.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2795,7 +2885,7 @@ FeatureAssignmentExpression -> Featur
(,NumberExpression,NumberExpression)?(,NumberVariable)?)</pre><p>
</p>
</div>
- <div class="section" title="2.7.6.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1419">2.7.6.2.
+ <div class="section" title="2.7.6.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1483">2.7.6.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2831,7 +2921,7 @@ FeatureAssignmentExpression -> Featur
specified interval. If no interval is passed, the condition always
evaluates true.
</p>
- <div class="section" title="2.7.7.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1431">2.7.7.1.
+ <div class="section" title="2.7.7.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1495">2.7.7.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2839,7 +2929,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">CURRENTCOUNT(Type(,NumberExpression,NumberExpression)?(,Variable)?)</pre><p>
</p>
</div>
- <div class="section" title="2.7.7.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1436">2.7.7.2.
+ <div class="section" title="2.7.7.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1500">2.7.7.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2862,7 +2952,7 @@ FeatureAssignmentExpression -> Featur
annotation. If a list of types is passed, this has to be true for at
least one of them.
</p>
- <div class="section" title="2.7.8.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1445">2.7.8.1.
+ <div class="section" title="2.7.8.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1509">2.7.8.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2870,7 +2960,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">ENDSWITH(Type|TypeListExpression) </pre><p>
</p>
</div>
- <div class="section" title="2.7.8.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1450">2.7.8.2.
+ <div class="section" title="2.7.8.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1514">2.7.8.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2890,7 +2980,7 @@ FeatureAssignmentExpression -> Featur
The FEATURE condition compares a feature of the matched
annotation with the second argument.
</p>
- <div class="section" title="2.7.9.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1459">2.7.9.1.
+ <div class="section" title="2.7.9.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1523">2.7.9.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2898,7 +2988,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">FEATURE(StringExpression,Expression) </pre><p>
</p>
</div>
- <div class="section" title="2.7.9.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1464">2.7.9.2.
+ <div class="section" title="2.7.9.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1528">2.7.9.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2919,7 +3009,7 @@ FeatureAssignmentExpression -> Featur
The IF condition evaluates true, if the contained boolean
expression evaluates true.
</p>
- <div class="section" title="2.7.10.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1473">2.7.10.1.
+ <div class="section" title="2.7.10.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1537">2.7.10.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2927,7 +3017,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">IF(BooleanExpression) </pre><p>
</p>
</div>
- <div class="section" title="2.7.10.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1478">2.7.10.2.
+ <div class="section" title="2.7.10.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1542">2.7.10.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2949,7 +3039,7 @@ FeatureAssignmentExpression -> Featur
in a given word or string list. If an optional agrument is given, then
the value of the argument is used instead of the covered text of the matched annotation
</p>
- <div class="section" title="2.7.11.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1487">2.7.11.1.
+ <div class="section" title="2.7.11.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1551">2.7.11.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2960,7 +3050,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">INLIST(StringList(,StringExpression)?) </pre><p>
</p>
</div>
- <div class="section" title="2.7.11.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1494">2.7.11.2.
+ <div class="section" title="2.7.11.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1558">2.7.11.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2992,7 +3082,7 @@ FeatureAssignmentExpression -> Featur
evaluates true,
if at least one of them fulfills the former condition.
</p>
- <div class="section" title="2.7.12.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1506">2.7.12.1.
+ <div class="section" title="2.7.12.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1570">2.7.12.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -3000,7 +3090,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">IS(Type|TypeListExpression) </pre><p>
</p>
</div>
- <div class="section" title="2.7.12.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1511">2.7.12.2.
+ <div class="section" title="2.7.12.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1575">2.7.12.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -3020,7 +3110,7 @@ FeatureAssignmentExpression -> Featur
The LAST condition evaluates true, if the type of the last token
within the window of the matched annotation is of the given type.
</p>
- <div class="section" title="2.7.13.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1520">2.7.13.1.
+ <div class="section" title="2.7.13.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1584">2.7.13.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -3028,7 +3118,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">LAST(TypeExpression) </pre><p>
</p>
</div>
- <div class="section" title="2.7.13.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1525">2.7.13.2.
+ <div class="section" title="2.7.13.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1589">2.7.13.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -3049,7 +3139,7 @@ FeatureAssignmentExpression -> Featur
the number of containing conditions evaluating true is within a given
interval.
</p>
- <div class="section" title="2.7.14.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1534">2.7.14.1.
+ <div class="section" title="2.7.14.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1598">2.7.14.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -3057,7 +3147,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">MOFN(NumberExpression,NumberExpression,Condition1,...,ConditionN) </pre><p>
</p>
</div>
- <div class="section" title="2.7.14.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1539">2.7.14.2.
+ <div class="section" title="2.7.14.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1603">2.7.14.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -3084,7 +3174,7 @@ FeatureAssignmentExpression -> Featur
parameter can be set to true to get the condition being evaluated on
a filtered index.
</p>
- <div class="section" title="2.7.15.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1548">2.7.15.1.
+ <div class="section" title="2.7.15.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1612">2.7.15.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -3093,7 +3183,7 @@ FeatureAssignmentExpression -> Featur
(,BooleanExpression(,BooleanExpression)?)?) </pre><p>
</p>
</div>
- <div class="section" title="2.7.15.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1553">2.7.15.2.
+ <div class="section" title="2.7.15.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1617">2.7.15.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
[... 1290 lines stripped ...]