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 2016/09/28 13:14:18 UTC
svn commit: r1762655 [2/3] - in /uima/site/trunk/uima-website:
docs/d/ruta-current/tools.ruta.book.html
docs/d/ruta-current/tools.ruta.book.pdf xdocs/index.xml xdocs/news.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=1762655&r1=1762654&r2=1762655&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 Wed Sep 28 13:14:17 2016
@@ -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 2.4.0</p></div><div><p class="copyright">Copyright © 2011, 2016 The Apache Software Foundation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="d5e8"></a>
+ </div></div><div><p class="releaseinfo">Version 2.5.0</p></div><div><p class="copyright">Copyright © 2011, 2016 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,11 +35,8 @@
the trademark or service mark.
</p>
- </div></div><div><p class="pubdate">January, 2016</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></d
t><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.synta
x">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.
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. Component
s</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.number">2.6.2. Number Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.string">2.6.3. String Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.boolean">2.6.4. Boolean Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.lists">2.6.5. List Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.features">2.6.6. 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 cl
ass="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 cla
ss="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.language.conditions.parse">2.7.18. PARSE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.conditions.pa
rtof">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.act
ions">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="sec
tion"><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. SETFE
ATURE</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. SHIFT</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.blocks">2.10. Blocks</a></span></dt><dd><
dl><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.condition">2.10.1. Conditioned statements</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.foreach">2.10.2.
- <span class="quote">“<span class="quote">Foreach</span>”</span>
- -Loops
- </a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.procedure">2.10.3. Procedures</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.inlined">2.11. Inlined rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.score">2.12. Heuristic extraction using scoring rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.modification">2.13. Modification</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.external_resources">2.14. External resources</a></span></dt><dd><dl><dt><span class="section"><a href="#d5e2394">2.14.1. WORDLISTs</a></span></dt><dt><span class="section"><a href="#d5e2414">2.14.2. WORDTABLEs</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.regexprule">2.15. Simple Rules based on Regular Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions">2.16. Lang
uage Extensions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.core-ext">2.16.1. Provided Extensions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.core-ext.onlyonce">2.16.2. ONLYONCE</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.core-ext.stringfunctions">2.16.3. Stringfunctions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.new">2.16.4. Adding new Language Elements</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.proje
cts">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.explai
n_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.covering_rules">3.5.4. Covering Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.rule_list">3.5.5. Rule List</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.created_by">3.5.6. Created By</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.statistics">3.5.7. 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. C
DE 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 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="#d5e3309">4.3.1. generate goal</a></span></dt><dt><span class="section"><a href="#d5e3314">4.3.2. twl goal</a></span></dt><dt><span class="section"><a href="#d5e3318">4.3.3. mtwl goal</a></span></dt></dl></dd><dt><span class="section"><a href="#section.tools.ruta.workbench.textruler.example">4.4. Induce rules with the TextRuler framework</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.html">4.5. HTML annotations in plain text</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.sorter">4.6. Sorting files with UIMA Ruta</a></span></dt><dt><span class="section"><a href="#section.tools.ruta.howto.xml">4.7. Converting XML documents with UIMA Ruta</a></span></dt></dl></dd></dl></div>
+ </div></div><div><p class="pubdate">September, 2016</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.syn
tax">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="#ug
r.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. Compone
nts</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.number">2.6.2. Number Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.string">2.6.3. String Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.boolean">2.6.4. Boolean Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.lists">2.6.5. List Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.expressions.features">2.6.6. 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 c
lass="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.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.a
ctions">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 cla
ss="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="s
ection"><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. SET
FEATURE</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.blocks">2.10. Blocks</a></span></dt><dd
><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.block">2.10.1. BLOCK</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.blocks.foreach">2.10.2. FOREACH</a></span></dt></dl></dd><dt><span class="section"><a href="#ugr.tools.ruta.language.inlined">2.11. Inlined rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.macro">2.12. Macros for conditions and actions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.score">2.13. Heuristic extraction using scoring rules</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.modification">2.14. Modification</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.external_resources">2.15. External resources</a></span></dt><dd><dl><dt><span class="section"><a href="#d5e2438">2.15.1. WORDLISTs</a></span></dt><dt><span class="section"><a href="#d5e2460">2.15.2. WORDTABLEs</a></span></dt></dl></dd><dt><span clas
s="section"><a href="#ugr.tools.ruta.language.regexprule">2.16. Simple Rules based on Regular Expressions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions">2.17. Language Extensions</a></span></dt><dd><dl><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.core-ext">2.17.1. Provided Extensions</a></span></dt><dt><span class="section"><a href="#ugr.tools.ruta.language.extensions.new">2.17.2. Adding new Language Elements</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></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.covering_rules">3.5.4. Covering Rules</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.rule_list">3.5.5. Rule List</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.created_by">3.5.6. Created By</a></span></dt><dt><span class="section"><a href="#section.ugr.tools.ruta.workbench.explain_perspective.statistics">3.5.7. 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="secti
on"><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="#sect
ion.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><spa
n 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="#d5e3364">4.3.1. generate goal</a></span></dt><dt><span class="section"><a href="#d5e3369">4.3.2. twl goal</a></span></dt><dt><span class="section"><a href="#d5e3373">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>
@@ -226,7 +223,7 @@ W{REGEXP("dog"), active -> Animal};</
in the complete document.
</p>
- <pre class="programlisting">WORDLIST AnimalsList = 'Animals.txt;'
+ <pre class="programlisting">WORDLIST AnimalsList = 'Animals.txt';
DECLARE Animal;
Document{-> MARKFAST(Animal, AnimalsList)};
</pre>
@@ -339,7 +336,7 @@ Paragraph{CONTAINS(Bold, 90, 100, true),
<pre class="programlisting">DECLARE Month, Year, Date;
ANY{INLIST(MonthsList) -> MARK(Month), MARK(Date,1,3)}
- PERIOD? NUM{REGEXP(".{2,4}") -> MARK(Year))};</pre>
+ PERIOD? NUM{REGEXP(".{2,4}") -> MARK(Year)};</pre>
<p>
This rule consists of three rule elements. The first one matches on every token, which has a covered text that occurs in a word lists named <span class="quote">“<span class="quote">MonthsList</span>”</span>.
@@ -406,15 +403,33 @@ Sentence{CONTAINS(EmploymentIndicator) -
In order to refer to annotations and, for example, assigning them to some features,
special kinds of local and global variables can be utilized. Local variables for annotations
do not need to be defined by are specified by a label at a rule element. This label can be utilized
- for referring to the matched annoation of this rule element within the current rule match alone.
- Global variables for annotations are declared like other variables and are able to store annotations
- across rules. The following example illustrate some simple use cases using local variables:
+ for referring to the matched annotation of this rule element within the current rule match alone.
+ The following example illustrate some simple use cases using local variables:
</p>
<pre class="programlisting">DECLARE Annotation EmplRelation
(Employee employeeRef, Employer employerRef);
e1:Employer # EmploymentIndicator # e2:Employee)
- {-> EmplRelation, EmplRelation.employeeRef=e2, EmplRelation.employerRef=e1};</pre>
+ {-> EmplRelation, EmplRelation.employeeRef=e2,
+ EmplRelation.employerRef=e1};</pre>
+
+ <p>
+ Global variables for annotations are declared like other variables and are able to store annotations
+ across rules as illustrated by the next example:
+ </p>
+
+ <pre class="programlisting">DECLARE MentionedAfter(Annotation first);
+ANNOTATION firstPerson;
+# p:Person{-> firstPerson = p};
+Entity{-> MentionedAfter, MentionedAfter.first = firstPerson};</pre>
+
+ <p>
+ The first line declares a new type that are utilized afterwards. The second line defines a variable
+ named <code class="code">firstPerson</code> which can store one annotation. A variable able to hold several annotations
+ is defined with ANNOTATIONLIST. The next line assigns the first occurrence of Person annotation to the
+ annotation variable <code class="code">firstPerson</code>. The last line creates an annotation of the type MentionedAfter and assigns the value
+ of the variable <code class="code">firstPerson</code> to the feature <code class="code">first</code> of the created annotation.
+ </p>
<p>
In the last examples, the values of features were defined as annotation types. However, also primitive
@@ -460,7 +475,7 @@ Document{-> CALL(SecondaryScript)};</
<p>
The script file with the name <span class="quote">“<span class="quote">SecondaryScript.ruta</span>”</span>, which is located in the package <span class="quote">“<span class="quote">uima/ruta/example</span>”</span>, is imported and executed
by the CALL action on the complete document. The script needs to be located in the folder specified by the parameter
- <a class="link" href="#ugr.tools.ruta.ae.basic.parameter.scriptPaths" title="scriptPaths">scriptPaths</a>, or in a coresponding packgae in the classpath. It is also possible to import script files of other UIMA Ruta projects, e.g.,
+ <a class="link" href="#ugr.tools.ruta.ae.basic.parameter.scriptPaths" title="scriptPaths">scriptPaths</a>, or in a corresponding package in the classpath. It is also possible to import script files of other UIMA Ruta projects, e.g.,
by adapting the configuration parameters of the UIMA Ruta Analysis Engine or
by setting a project reference in the project properties of a UIMA Ruta project.
</p>
@@ -610,14 +625,13 @@ Document{-> EXEC(Modifier)};
The first rule deletes all text covered by annotations of the type <span class="quote">“<span class="quote">Date</span>”</span>. The second rule replaces the text of all annotations of the type <span class="quote">“<span class="quote">MoneyAmount</span>”</span>
with the string <span class="quote">“<span class="quote"><MoneyAmount/></span>”</span>. The third rule remembers to set the background color of text in Headline annotation to green. The last rule
finally performs all of these changes in an additional view called <span class="quote">“<span class="quote">modified</span>”</span>, which is specified in the configuration parameters of the analysis engine.
- <a class="xref" href="#ugr.tools.ruta.ae.modifier" title="1.5.4. Modifier">Section 1.5.4, “Modifier”</a> and <a class="xref" href="#ugr.tools.ruta.language.modification" title="2.13. Modification">Section 2.13, “Modification”</a> provide a more detailed description.
+ <a class="xref" href="#ugr.tools.ruta.ae.modifier" title="1.5.4. Modifier">Section 1.5.4, “Modifier”</a> and <a class="xref" href="#ugr.tools.ruta.language.modification" title="2.14. Modification">Section 2.14, “Modification”</a> provide a more detailed description.
</p>
<p>
In the last example, a descriptor file was loaded in order to import and apply an external analysis engine. Analysis engines can also be loaded using uimaFIT,
whereas the given class name has to be present in the classpath. In the UIMA Ruta Workbench, you can add a dependency to a java project, which contains the
- implementation, to the UIMA Ruta project. If the UIMA Ruta script is applied in a UIMA Pipeline, then the configuration parameter
- <a class="link" href="#ugr.tools.ruta.ae.basic.parameter.additionalUimafitEngines" title="additionalUimafitEngines">additionalUimafitEngines</a> has to list the class of the analysis engine.
+ implementation, to the UIMA Ruta project.
The following example loads an analysis engine without an descriptor and applies it on the document. The additional list of types states that
the annotations of those types created by the analysis engine should be available to the following Ruta rules.
@@ -690,21 +704,17 @@ Document{-> EXEC(MyAnalysisEngine, {M
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; ">
<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; ">List of names with complete namespace of additional scripts, which can be
+ </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
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; ">
<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; ">List of names with complete namespace of additional analysis engines, which
+ </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
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; ">
<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; ">List of class names with complete namespace of additional uimaFIT analysis engines, which
+ </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
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; ">
- <a class="link" href="#ugr.tools.ruta.ae.basic.parameter.additionalEngineLoaders" title="additionalEngineLoaders">additionalEngineLoaders</a>
- </td><td style="border-right: 0.5pt solid black; border-bottom: 0.5pt solid black; ">List of class names of implementations that are able to perform additional
- task when loading external analysis engines.
- </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.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
like proprietary conditions.
@@ -817,36 +827,30 @@ Document{-> EXEC(MyAnalysisEngine, {M
<div class="section" title="additionalScripts"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.additionalScripts">additionalScripts</h5></div></div></div>
<p>
- The parameter additionalScripts is defined as a list of string values and contains script files, which are additionally loaded by the analysis engine. These script files are specified by their
+ The optional parameter additionalScripts is defined as a list of string values and contains script files, which are additionally loaded by the analysis engine. These script files are specified by their
complete namespace, exactly like the value of the parameter <a class="link" href="#ugr.tools.ruta.ae.basic.parameter.mainScript" title="mainScript">mainScript</a>
and can be refered to by language elements, e.g., by executing the containing rules. An exemplary value of this parameter is "org.apache.uima.SecondaryScript". In this example, the main script could import
this script file by the declaration "SCRIPT org.apache.uima.SecondaryScript;" and then could execute it with the rule
- "Document{-> CALL(SecondaryScript)};".
+ "Document{-> CALL(SecondaryScript)};". This optional list can be used as a replacement of global imports in the script file.
</p>
</div>
<div class="section" title="additionalEngines"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.additionalEngines">additionalEngines</h5></div></div></div>
<p>
- This parameter contains a list of additional analysis engines, which can be executed by the UIMA Ruta rules. The single values
+ This optional parameter contains a list of additional analysis engines, which can be executed by the UIMA Ruta rules. The single values
are given by the name of the analysis engine with their complete namespace and have to be located relative to one value of the parameter
<a class="link" href="#ugr.tools.ruta.ae.basic.parameter.descriptorPaths" title="descriptorPaths">descriptorPaths</a>, the location where the analysis engine searches for the descriptor file.
An example for one value of the parameter is "utils.HtmlAnnotator", which points to the descriptor "HtmlAnnotator.xml" in the folder "utils".
- </p>
- </div>
- <div class="section" title="additionalEngineLoaders"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.additionalEngineLoaders">additionalEngineLoaders</h5></div></div></div>
-
- <p>
- The parameter "additionalEngineLoaders" specifies a list of optional implementations of the interface
- "org.apache.uima.ruta.extensions.IEngineLoader", which can be used to application-specific configurations of
- additional analysis engines.
+ This optional list can be used as a replacement of global imports in the script file.
</p>
</div>
<div class="section" title="additionalUimafitEngines"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.additionalUimafitEngines">additionalUimafitEngines</h5></div></div></div>
<p>
- This parameter contains a list of additional analysis engines, which can be executed by the UIMA Ruta rules. The single values
+ This optional parameter contains a list of additional analysis engines, which can be executed by the UIMA Ruta rules. The single values
are given by the name of the implementation with the complete namespace and have to be present int he classpath of the application.
An example for one value of the parameter is "org.apache.uima.ruta.engine.HtmlAnnotator", which points to the "HtmlAnnotator" class.
+ This optional list can be used as a replacement of global imports in the script file.
</p>
</div>
<div class="section" title="additionalExtensions"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.additionalExtensions">additionalExtensions</h5></div></div></div>
@@ -992,8 +996,8 @@ Document{-> EXEC(MyAnalysisEngine, {M
This parameter specifies the values of variables as string values in an string array. It is
used in combination with the parameter varNames, which contains the names of the corresponding
variables. The n-th entry of this string array specifies the value of the n-th entry of the
- string array of the parameter varNames. Only value of the kinds string, boolean, int, double
- and float are allowed.
+ string array of the parameter varNames. The values for list variables are separated by the character
+ <span class="quote">“<span class="quote">,</span>”</span>. Thus, the usage of commas is not allowed if the variable is a list.
</p>
</div>
<div class="section" title="dictRemoveWS"><div class="titlepage"><div><div><h5 class="title" id="ugr.tools.ruta.ae.basic.parameter.dictRemoveWS">dictRemoveWS</h5></div></div></div>
@@ -1442,9 +1446,11 @@ VariableDeclaration -> (("TYPE" Ident
("," Identifier)* ("=" NumberExpression)?)
| ("BOOLEAN" Identifier ("," Identifier)*
("=" BooleanExpression)?)
- | ("ANNOTATION" Identifier ("=" AnnotationExpression)?)
- | ("WORDLIST" Identifier ("=" WordListExpression)?)
- | ("WORDTABLE" Identifier ("=" WordTableExpression)?)
+ | ("ANNOTATION" Identifier("="AnnotationExpression)?)
+ | ("WORDLIST" Identifier ("=" WordListExpression
+ | StringExpression)?)
+ | ("WORDTABLE" Identifier ("=" WordTableExpression
+ | StringExpression)?)
| ("TYPELIST" Identifier ("=" TypeListExpression)?)
| ("STRINGLIST" Identifier
("=" StringListExpression)?)
@@ -1461,11 +1467,13 @@ BasicAnnotationType -> ('COLON'| 'SW
| 'SENTENCEEND' | 'W' | 'PM' | 'ANY' | 'ALL'
| 'SPACE' | 'BREAK')
BlockDeclaration -> "BLOCK" "(" Identifier ")" RuleElementWithCA
- "{" Statements "}"</pre><p>
-actionDeclaration -> "ACTION" Identifier "(" VarType Identifier ("," VarType Identifier)*")"
+ "{" Statements "}"
+actionDeclaration -> "ACTION" Identifier "(" ("VAR"? VarType
+ Identifier)? ("," "VAR"? VarType Identifier)*")"
"=" Action ( "," Action)* ";"
-conditionDeclaration-> "CONDITION" Identifier "(" VarType Identifier ("," VarType Identifier)*")"
- "=" Condition ( "," Condition)* ";"
+conditionDeclaration-> "CONDITION" Identifier "(" ("VAR"? VarType
+ Identifier)? ("," "VAR"? VarType Identifier)*")"
+ "=" Condition ( "," Condition)* ";"</pre><p>
Syntax of statements and rule elements:
</p><pre class="programlisting">SimpleStatement -> SimpleRule | RegExpRule | ConjunctRules
| DocumentActionRule
@@ -1512,7 +1520,8 @@ Actions -> "->" Act
<p>
It is also possible to use specific expression as implicit conditions or action additionally to the set of available conditions and actions.
</p><pre class="programlisting">Condition -> BooleanExpression | FeatureMatchExpression
-Action -> TypeExpression | FeatureAssignmentExpression | VariableAssignmentExpression
+Action -> TypeExpression | FeatureAssignmentExpression
+ | VariableAssignmentExpression
</pre><p>
@@ -1783,7 +1792,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="d5e1013">2.5.1.1.
+ <div class="section" title="2.5.1.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1012">2.5.1.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -1867,9 +1876,19 @@ DECLARE ParentType NewType (SomeType fea
Boolean list variable: A variable that represents a list of
booleans.
</p>
+ </li><li class="listitem" style="list-style-type: circle">
+ <p>
+ Annotation
+ variable: A variable that represents an annotation.
+ </p>
+ </li><li class="listitem" style="list-style-type: circle">
+ <p>
+ Annotation list variable: A variable that represents a list of
+ annotations.
+ </p>
</li></ul></div><p>
</p>
- <div class="section" title="2.5.2.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1047">2.5.2.1.
+ <div class="section" title="2.5.2.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1050">2.5.2.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -1885,7 +1904,9 @@ DOUBLELIST newDoubleList;
STRING newStringVariable;
STRINGLIST newStringList;
BOOLEAN newBooleanVariable;
-BOOLEANLIST newBooleanList;</pre><p>
+BOOLEANLIST newBooleanList;
+ANNOTATION newAnnotationVariable;
+ANNOTATIONLIST newAnnotationList;</pre><p>
</p>
</div>
</div>
@@ -1909,7 +1930,7 @@ BOOLEANLIST newBooleanList;</pre><p>
</p>
</li></ul></div><p>
</p>
- <div class="section" title="2.5.3.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1060">2.5.3.1.
+ <div class="section" title="2.5.3.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1063">2.5.3.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -1927,7 +1948,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="d5e1068">2.5.4.1.
+ <div class="section" title="2.5.4.1. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1071">2.5.4.1.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -1969,7 +1990,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="d5e1084">2.5.5.1.
+ <div class="section" title="2.5.5.1. Type System Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1087">2.5.5.1.
<span class="bold"><strong>Type System Example:</strong></span>
</h4></div></div></div>
@@ -2002,7 +2023,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="d5e1089">2.5.5.2.
+ <div class="section" title="2.5.5.2. Analysis Engine Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1092">2.5.5.2.
<span class="bold"><strong>Analysis Engine Example:</strong></span>
</h4></div></div></div>
@@ -2045,7 +2066,7 @@ Document{-> EXEC(AnotherEngine, {Some
<a class="xref" href="#ugr.tools.ruta.language.declarations.variable" title="2.5.2. Variables">Section 2.5.2, “Variables”</a>
).
</li></ol></div><p>
- </p><div class="section" title="Definition:"><div class="titlepage"><div><div><h5 class="title" id="d5e1108">
+ </p><div class="section" title="Definition:"><div class="titlepage"><div><div><h5 class="title" id="d5e1111">
<span class="bold"><strong>Definition:</strong></span>
</h5></div></div></div>
@@ -2053,7 +2074,7 @@ Document{-> EXEC(AnotherEngine, {Some
</p><pre class="programlisting">TypeExpression -> AnnotationType | TypeVariable</pre><p>
</p>
</div><p>
- </p><div class="section" title="Example:"><div class="titlepage"><div><div><h5 class="title" id="d5e1113">
+ </p><div class="section" title="Example:"><div class="titlepage"><div><div><h5 class="title" id="d5e1116">
<span class="bold"><strong>Example:</strong></span>
</h5></div></div></div>
@@ -2077,7 +2098,7 @@ Document{->ASSIGN(typeVar, Author)};<
a complete overview, have a look at the following syntax definition
of number expressions.
</p>
- <div class="section" title="2.6.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1121">2.6.2.1.
+ <div class="section" title="2.6.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1124">2.6.2.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2107,7 +2128,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.2.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1128">2.6.2.2.
+ <div class="section" title="2.6.2.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1131">2.6.2.2.
<span class="bold"><strong>Examples:</strong></span>
</h4></div></div></div>
@@ -2144,7 +2165,7 @@ Document{->ASSIGN(intVar1, 12 * intVa
</p>
</li></ol></div><p>
</p>
- <div class="section" title="2.6.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1144">2.6.3.1.
+ <div class="section" title="2.6.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1147">2.6.3.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2154,7 +2175,7 @@ SimpleStringExpression -> StringLit
| StringVariable</pre><p>
</p>
</div>
- <div class="section" title="2.6.3.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1149">2.6.3.2.
+ <div class="section" title="2.6.3.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1152">2.6.3.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2175,7 +2196,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.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1157">2.6.4.1.
+ <div class="section" title="2.6.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1160">2.6.4.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2199,7 +2220,7 @@ BooleanLiteral -> "true" | "false
.
</p>
</div>
- <div class="section" title="2.6.4.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1164">2.6.4.2.
+ <div class="section" title="2.6.4.2. Examples:"><div class="titlepage"><div><div><h4 class="title" id="d5e1167">2.6.4.2.
<span class="bold"><strong>Examples:</strong></span>
</h4></div></div></div>
@@ -2265,7 +2286,7 @@ BooleanLiteral -> "true" | "false
<p>
List expression are a rather simple kind of expression.
</p>
- <div class="section" title="2.6.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1182">2.6.5.1.
+ <div class="section" title="2.6.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1185">2.6.5.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2287,6 +2308,9 @@ StringListExpression -> StringList
BooleanListExpression -> BooleanListVariable
| "{" BooleanExpression
("," BooleanExpression)* "}"
+AnnotationListExpression -> AnnotationListVariable
+ | "{" AnnotationExpression
+ ("," AnnotationExpression)* "}"
</pre><p>
A ResourceLiteral is something
like 'folder/file.txt' (Attention: Use single quotes).
@@ -2310,7 +2334,7 @@ FeatureAssignmentExpression -> Featur
</pre><p>
</p>
<p>
- The covered text of an annoation can be referred to with "coveredText" or "ct".
+ The covered text of an annotation can be referred to with "coveredText" or "ct".
The latter one is an abbreviation and returns the covered text of an annotation
only if the type of the annotation does not define a feature with the name "ct".
The following example creates an annotation of the type TypeA for each word with the
@@ -2330,7 +2354,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="d5e1200">2.7.1.1.
+ <div class="section" title="2.7.1.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1203">2.7.1.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2338,7 +2362,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="d5e1205">2.7.1.2.
+ <div class="section" title="2.7.1.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1208">2.7.1.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2358,7 +2382,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="d5e1214">2.7.2.1.
+ <div class="section" title="2.7.2.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1217">2.7.2.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2366,7 +2390,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="d5e1219">2.7.2.2.
+ <div class="section" title="2.7.2.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1222">2.7.2.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2390,7 +2414,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="d5e1228">2.7.3.1.
+ <div class="section" title="2.7.3.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1231">2.7.3.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2398,7 +2422,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="d5e1233">2.7.3.2.
+ <div class="section" title="2.7.3.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1236">2.7.3.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2428,7 +2452,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="d5e1242">2.7.4.1.
+ <div class="section" title="2.7.4.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1245">2.7.4.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2436,7 +2460,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="d5e1247">2.7.4.2.
+ <div class="section" title="2.7.4.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1250">2.7.4.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2480,7 +2504,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="d5e1263">2.7.5.1.
+ <div class="section" title="2.7.5.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1266">2.7.5.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2488,7 +2512,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="d5e1268">2.7.5.2.
+ <div class="section" title="2.7.5.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1271">2.7.5.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2523,7 +2547,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="d5e1277">2.7.6.1.
+ <div class="section" title="2.7.6.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1280">2.7.6.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2535,7 +2559,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="d5e1284">2.7.6.2.
+ <div class="section" title="2.7.6.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1287">2.7.6.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2571,7 +2595,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="d5e1296">2.7.7.1.
+ <div class="section" title="2.7.7.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1299">2.7.7.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2579,7 +2603,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="d5e1301">2.7.7.2.
+ <div class="section" title="2.7.7.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1304">2.7.7.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2602,7 +2626,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="d5e1310">2.7.8.1.
+ <div class="section" title="2.7.8.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1313">2.7.8.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2610,7 +2634,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="d5e1315">2.7.8.2.
+ <div class="section" title="2.7.8.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1318">2.7.8.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2630,7 +2654,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="d5e1324">2.7.9.1.
+ <div class="section" title="2.7.9.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1327">2.7.9.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2638,7 +2662,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="d5e1329">2.7.9.2.
+ <div class="section" title="2.7.9.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1332">2.7.9.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2659,7 +2683,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="d5e1338">2.7.10.1.
+ <div class="section" title="2.7.10.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1341">2.7.10.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2667,7 +2691,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="d5e1343">2.7.10.2.
+ <div class="section" title="2.7.10.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1346">2.7.10.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2689,7 +2713,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="d5e1352">2.7.11.1.
+ <div class="section" title="2.7.11.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1355">2.7.11.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2700,7 +2724,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="d5e1359">2.7.11.2.
+ <div class="section" title="2.7.11.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1362">2.7.11.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2732,7 +2756,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="d5e1371">2.7.12.1.
+ <div class="section" title="2.7.12.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1374">2.7.12.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2740,7 +2764,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="d5e1376">2.7.12.2.
+ <div class="section" title="2.7.12.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1379">2.7.12.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2760,7 +2784,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="d5e1385">2.7.13.1.
+ <div class="section" title="2.7.13.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1388">2.7.13.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2768,7 +2792,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="d5e1390">2.7.13.2.
+ <div class="section" title="2.7.13.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1393">2.7.13.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2789,7 +2813,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="d5e1399">2.7.14.1.
+ <div class="section" title="2.7.14.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1402">2.7.14.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2797,7 +2821,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="d5e1404">2.7.14.2.
+ <div class="section" title="2.7.14.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1407">2.7.14.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2824,7 +2848,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="d5e1413">2.7.15.1.
+ <div class="section" title="2.7.15.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1416">2.7.15.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2833,7 +2857,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="d5e1418">2.7.15.2.
+ <div class="section" title="2.7.15.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1421">2.7.15.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2853,7 +2877,7 @@ FeatureAssignmentExpression -> Featur
The NOT condition negates the result of its contained
condition.
</p>
- <div class="section" title="2.7.16.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1427">2.7.16.1.
+ <div class="section" title="2.7.16.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1430">2.7.16.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2861,7 +2885,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">"-"Condition</pre><p>
</p>
</div>
- <div class="section" title="2.7.16.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1432">2.7.16.2.
+ <div class="section" title="2.7.16.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1435">2.7.16.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
@@ -2881,7 +2905,7 @@ FeatureAssignmentExpression -> Featur
The OR Condition is a composed condition and evaluates true, if
at least one contained condition is evaluated true.
</p>
- <div class="section" title="2.7.17.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1441">2.7.17.1.
+ <div class="section" title="2.7.17.1. Definition:"><div class="titlepage"><div><div><h4 class="title" id="d5e1444">2.7.17.1.
<span class="bold"><strong>Definition:</strong></span>
</h4></div></div></div>
@@ -2889,7 +2913,7 @@ FeatureAssignmentExpression -> Featur
</p><pre class="programlisting">OR(Condition1,...,ConditionN)</pre><p>
</p>
</div>
- <div class="section" title="2.7.17.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1446">2.7.17.2.
+ <div class="section" title="2.7.17.2. Example:"><div class="titlepage"><div><div><h4 class="title" id="d5e1449">2.7.17.2.
<span class="bold"><strong>Example:</strong></span>
</h4></div></div></div>
[... 2817 lines stripped ...]