Maintenance

PRImA-Research-Lab · Apr 23, 2016 · c8f5fcb · c8f5fcb
1 parent a2dae5f
commit c8f5fcb
Show file tree

Hide file tree

Showing 15 changed files with 56 additions and 31 deletions.
diff --git a/apidoc/allclasses-frame.html b/apidoc/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>All Classes (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/allclasses-noframe.html b/apidoc/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>All Classes (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/constant-values.html b/apidoc/constant-values.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>Constant Field Values (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/deprecated-list.html b/apidoc/deprecated-list.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>Deprecated List (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/help-doc.html b/apidoc/help-doc.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>API Help (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/index-all.html b/apidoc/index-all.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>Index (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style">
 </head>
 <body>
@@ -100,6 +100,10 @@ <h2 class="title">R</h2>
 <dd>
 <div class="block">Runs the conversion</div>
 </dd>
+<dt><span class="strong"><a href="./org/primaresearch/dla/page/converter/PageConverter.html#runTextFilter(org.primaresearch.shared.variable.VariableMap, org.primaresearch.dla.page.Page)">runTextFilter(VariableMap, Page)</a></span> - Static method in class org.primaresearch.dla.page.converter.<a href="./org/primaresearch/dla/page/converter/PageConverter.html" title="class in org.primaresearch.dla.page.converter">PageConverter</a></dt>
+<dd>
+<div class="block">Applies a set of filter rules to all text elements of the given page.</div>
+</dd>
 </dl>
 <a name="_S_">
 <!--   -->

diff --git a/apidoc/index.html b/apidoc/index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc on Sat Apr 23 14:02:00 BST 2016 -->
 <title>JPageConverter API</title>
 <script type="text/javascript">
     targetPage = "" + window.location.search;

diff --git a/apidoc/org/primaresearch/dla/page/converter/PageConverter.html b/apidoc/org/primaresearch/dla/page/converter/PageConverter.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>PageConverter (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 </head>
 <body>
@@ -149,20 +149,27 @@ <h3>Method Summary</h3>
 </td>
 </tr>
 <tr class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/primaresearch/dla/page/converter/PageConverter.html#runTextFilter(org.primaresearch.shared.variable.VariableMap, org.primaresearch.dla.page.Page)">runTextFilter</a></strong>(org.primaresearch.shared.variable.VariableMap&nbsp;textFilterRules,
+             org.primaresearch.dla.page.Page&nbsp;page)</code>
+<div class="block">Applies a set of filter rules to all text elements of the given page.</div>
+</td>
+</tr>
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/primaresearch/dla/page/converter/PageConverter.html#setGtsId(java.lang.String, java.lang.String)">setGtsId</a></strong>(java.lang.String&nbsp;pattern,
         java.lang.String&nbsp;filepath)</code>
 <div class="block">Sets the GtsId that is to be added to the PAGE document.<br>
  Note: The ID has to be conform to the XML ID convention (start with letter, ...).</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/primaresearch/dla/page/converter/PageConverter.html#setTargetSchema(java.lang.String)">setTargetSchema</a></strong>(java.lang.String&nbsp;versionString)</code>
 <div class="block">Sets the target PAGE XML schema version of the output file.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/primaresearch/dla/page/converter/PageConverter.html#setTextFilterRules(org.primaresearch.shared.variable.VariableMap)">setTextFilterRules</a></strong>(org.primaresearch.shared.variable.VariableMap&nbsp;textFilterRules)</code>
 <div class="block">Sets the filter rules that are to be applied to all text regions.</div>
@@ -230,6 +237,20 @@ <h4>run</h4>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceFilename</code> - File path of input PAGE XML</dd><dd><code>targetFilename</code> - File path to output PAGE XML</dd></dl>
 </li>
 </ul>
+<a name="runTextFilter(org.primaresearch.shared.variable.VariableMap, org.primaresearch.dla.page.Page)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runTextFilter</h4>
+<pre>public static&nbsp;void&nbsp;runTextFilter(org.primaresearch.shared.variable.VariableMap&nbsp;textFilterRules,
+                 org.primaresearch.dla.page.Page&nbsp;page)</pre>
+<div class="block">Applies a set of filter rules to all text elements of the given page.
+ The type of the target object (region, line, word, glyph) can be
+ specified per rule.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>textFilterRules</code> - A collection of String variables, each containing a filter rule in the variable value.</dd><dd><code>page</code> - Page object with text elements to apply the filter to.</dd></dl>
+</li>
+</ul>
 <a name="setGtsId(java.lang.String, java.lang.String)">
 <!--   -->
 </a>

diff --git a/apidoc/org/primaresearch/dla/page/converter/class-use/PageConverter.html b/apidoc/org/primaresearch/dla/page/converter/class-use/PageConverter.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>Uses of Class org.primaresearch.dla.page.converter.PageConverter (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/org/primaresearch/dla/page/converter/package-frame.html b/apidoc/org/primaresearch/dla/page/converter/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>org.primaresearch.dla.page.converter (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/org/primaresearch/dla/page/converter/package-summary.html b/apidoc/org/primaresearch/dla/page/converter/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>org.primaresearch.dla.page.converter (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/org/primaresearch/dla/page/converter/package-tree.html b/apidoc/org/primaresearch/dla/page/converter/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>org.primaresearch.dla.page.converter Class Hierarchy (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/org/primaresearch/dla/page/converter/package-use.html b/apidoc/org/primaresearch/dla/page/converter/package-use.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>Uses of Package org.primaresearch.dla.page.converter (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/apidoc/overview-tree.html b/apidoc/overview-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_51) on Thu Oct 23 13:35:40 BST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Sat Apr 23 14:02:00 BST 2016 -->
 <title>Class Hierarchy (JPageConverter API)</title>
-<meta name="date" content="2014-10-23">
+<meta name="date" content="2016-04-23">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>

diff --git a/src/org/primaresearch/dla/page/converter/PageConverter.java b/src/org/primaresearch/dla/page/converter/PageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ * Copyright 2015 PRImA Research Lab, University of Salford, United Kingdom
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -199,7 +199,7 @@ public void run(String sourceFilename, String targetFilename) {
 	 * @param textFilterRules A collection of String variables, each containing a filter rule in the variable value. 
 	 * @param page Page object with text elements to apply the filter to.
 	 */
-	void runTextFilter(VariableMap textFilterRules, Page page) {
+	public static void runTextFilter(VariableMap textFilterRules, Page page) {
 		final TextFilter textFilter = new TextFilter(textFilterRules);
 		final ContentObjectProcessor processor = new ContentObjectProcessor() {
 			@Override