/usr/share/doc/liblouisutdml-java/api/org/liblouis/LibLouisUTDML.html is in liblouisutdml-java-doc 2.7.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>LibLouisUTDML</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LibLouisUTDML";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":9,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../org/liblouis/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/liblouis/LibLouis.html" title="class in org.liblouis"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/liblouis/LogCallback.html" title="interface in org.liblouis"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/liblouis/LibLouisUTDML.html" target="_top">Frames</a></li>
<li><a href="LibLouisUTDML.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.liblouis</div>
<h2 title="Class LibLouisUTDML" class="title">Class LibLouisUTDML</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.liblouis.LibLouisUTDML</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">LibLouisUTDML</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#Comp8Dots">Comp8Dots</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#CompbrlAtCursor">CompbrlAtCursor</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#CompbrlLeftCursor">CompbrlLeftCursor</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#DontInit">DontInit</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#DotsIO">DotsIO</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#HtmlDoc">HtmlDoc</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#NoContractions">NoContractions</a></span></code>
<div class="block">Definitions of mode bits
The bits for liblouis are included because it is sometimes necessary
to pass a liblouis mode to a liblouisutdml function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#notUC">notUC</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#OtherTrans">OtherTrans</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#Pass1Only">Pass1Only</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#UcBrl">UcBrl</a></span></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#backTranslateFile-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">backTranslateFile</a></span>(java.lang.String configFileList,
java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String logFileName,
java.lang.String settingsString,
int mode)</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#backTranslateString-java.lang.String-byte:A-byte:A-int:A-java.lang.String-java.lang.String-int-">backTranslateString</a></span>(java.lang.String configFileList,
byte[] inbuf,
byte[] outbuf,
int[] outlen,
java.lang.String logFilename,
java.lang.String settingsSrting,
int mode)</code>
<div class="block">the brf characters in inbuf are translated to print characters in
outbuf according to the settings in the configuration files and
setingsStrring.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#charToDots-java.lang.String-byte:A-byte:A-java.lang.String-int-">charToDots</a></span>(java.lang.String tableList,
byte[] inbuf,
byte[] outbuf,
java.lang.String logFile,
int mode)</code>
<div class="block">Convert the utf8 character string in inbuf to Unicode braille dot
patterns and place the result as a utf8 string in outbuf.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#checkTable-java.lang.String-java.lang.String-int-">checkTable</a></span>(java.lang.String tableList,
java.lang.String logFile,
int mode)</code>
<div class="block">See if the table in tableList exists and is valid.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#dotsToChar-java.lang.String-byte:A-byte:A-java.lang.String-int-">dotsToChar</a></span>(java.lang.String tableList,
byte[] inbuf,
byte[] outbuf,
java.lang.String logFile,
int mode)</code>
<div class="block">Convert the utf8 string of dot patterns in inbuf to characters and
place the result as a utf8 string in outbuf.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#file2brl-java.lang.String:A-">file2brl</a></span>(java.lang.String[] args)</code>
<div class="block">This method performs the functions of the file2brl program in a more
contrrolled environment.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#free--">free</a></span>()</code>
<div class="block">You must call free at the end of your application to free all
memory used by liblouisutdml and liblouis.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../org/liblouis/LibLouisUTDML.html" title="class in org.liblouis">LibLouisUTDML</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#getInstance--">getInstance</a></span>()</code> </td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#initialize-java.lang.String-java.lang.String-java.lang.String-">initialize</a></span>(java.lang.String dataPath,
java.lang.String writeablePath,
java.lang.String logFile)</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#loadLibrary-java.lang.String-java.lang.String-">loadLibrary</a></span>(java.lang.String libraryPath,
java.lang.String librarySuffix)</code> </td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#loadXMLCatalog-java.lang.String-">loadXMLCatalog</a></span>(java.lang.String filename)</code>
<div class="block">Load a XML catalog into LibLouisUTDML.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#logEnd--">logEnd</a></span>()</code> </td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#registerLogCallback-org.liblouis.LogCallback-">registerLogCallback</a></span>(<a href="../../org/liblouis/LogCallback.html" title="interface in org.liblouis">LogCallback</a> cb)</code> </td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#setDataPath-java.lang.String-">setDataPath</a></span>(java.lang.String path)</code>
<div class="block">Path on which liblouis tables and liblouisutdml files can be found.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#setLogFile-java.lang.String-">setLogFile</a></span>(java.lang.String fileName)</code> </td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#setLogLevel-int-">setLogLevel</a></span>(int level)</code> </td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#setWriteablePath-java.lang.String-">setWriteablePath</a></span>(java.lang.String path)</code>
<div class="block">Set the path to which temporary files will be written.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#translateFile-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">translateFile</a></span>(java.lang.String configFileList,
java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String logFileName,
java.lang.String settingsString,
int mode)</code>
<div class="block">The xml document in inputFile is translated into braille and the
translation is placed
in outputFile.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#translateString-java.lang.String-byte:A-byte:A-int:A-java.lang.String-java.lang.String-int-">translateString</a></span>(java.lang.String configFileList,
byte[] inbuf,
byte[] outbuf,
int[] outlen,
java.lang.String logFilename,
java.lang.String settingsString,
int mode)</code>
<div class="block">Make a braille translation of the UTF-8 characters in inbuf
according to configuration settings to UTF-8 characters in outbuf.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#translateTextFile-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">translateTextFile</a></span>(java.lang.String configFileList,
java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String logFileName,
java.lang.String settingsString,
int mode)</code>
<div class="block">The plain-text file in inFile is translated to braille and the
translation placed in outputFile as described for the previous method.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/liblouis/LibLouisUTDML.html#version--">version</a></span>()</code>
<div class="block">Return a string giving the versions of both liblouisutdml and
liblouis</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="NoContractions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NoContractions</h4>
<pre>public static final int NoContractions</pre>
<div class="block">Definitions of mode bits
The bits for liblouis are included because it is sometimes necessary
to pass a liblouis mode to a liblouisutdml function. The liblouis bits
take up the low-order bits of the mode integer, while the
liblouisutdml bits take up the high-order bits, except that the
sign bit is skipped.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.NoContractions">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CompbrlAtCursor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompbrlAtCursor</h4>
<pre>public static final int CompbrlAtCursor</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.CompbrlAtCursor">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DotsIO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DotsIO</h4>
<pre>public static final int DotsIO</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.DotsIO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="Comp8Dots">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Comp8Dots</h4>
<pre>public static final int Comp8Dots</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.Comp8Dots">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="Pass1Only">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Pass1Only</h4>
<pre>public static final int Pass1Only</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.Pass1Only">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CompbrlLeftCursor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompbrlLeftCursor</h4>
<pre>public static final int CompbrlLeftCursor</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.CompbrlLeftCursor">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OtherTrans">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OtherTrans</h4>
<pre>public static final int OtherTrans</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.OtherTrans">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="UcBrl">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UcBrl</h4>
<pre>public static final int UcBrl</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.UcBrl">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DontInit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DontInit</h4>
<pre>public static final int DontInit</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.DontInit">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HtmlDoc">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HtmlDoc</h4>
<pre>public static final int HtmlDoc</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.HtmlDoc">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="notUC">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>notUC</h4>
<pre>public static final int notUC</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#org.liblouis.LibLouisUTDML.notUC">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static <a href="../../org/liblouis/LibLouisUTDML.html" title="class in org.liblouis">LibLouisUTDML</a> getInstance()</pre>
</li>
</ul>
<a name="initialize-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public static void initialize(java.lang.String dataPath,
java.lang.String writeablePath,
java.lang.String logFile)</pre>
</li>
</ul>
<a name="loadLibrary-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadLibrary</h4>
<pre>public static void loadLibrary(java.lang.String libraryPath,
java.lang.String librarySuffix)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="version--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public java.lang.String version()</pre>
<div class="block">Return a string giving the versions of both liblouisutdml and
liblouis</div>
</li>
</ul>
<a name="loadXMLCatalog-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadXMLCatalog</h4>
<pre>public void loadXMLCatalog(java.lang.String filename)</pre>
<div class="block">Load a XML catalog into LibLouisUTDML.</div>
</li>
</ul>
<a name="translateString-java.lang.String-byte:A-byte:A-int:A-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translateString</h4>
<pre>public boolean translateString(java.lang.String configFileList,
byte[] inbuf,
byte[] outbuf,
int[] outlen,
java.lang.String logFilename,
java.lang.String settingsString,
int mode)</pre>
<div class="block">Make a braille translation of the UTF-8 characters in inbuf
according to configuration settings to UTF-8 characters in outbuf. The
latter will be in Unicode braille. The return value is true if the
translation is successful and false if not. Any errors are recorded in
logFile. If this is null, they are printed on stderr. There may be
errors even if the return value is true. If there are none, the log file
will be empty. settingsstring may be used to pass in configuration
settings.</div>
</li>
</ul>
<a name="backTranslateString-java.lang.String-byte:A-byte:A-int:A-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backTranslateString</h4>
<pre>public boolean backTranslateString(java.lang.String configFileList,
byte[] inbuf,
byte[] outbuf,
int[] outlen,
java.lang.String logFilename,
java.lang.String settingsSrting,
int mode)</pre>
<div class="block">the brf characters in inbuf are translated to print characters in
outbuf according to the settings in the configuration files and
setingsStrring. The translation will be in UTF-8.</div>
</li>
</ul>
<a name="translateFile-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translateFile</h4>
<pre>public boolean translateFile(java.lang.String configFileList,
java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String logFileName,
java.lang.String settingsString,
int mode)</pre>
<div class="block">The xml document in inputFile is translated into braille and the
translation is placed
in outputFile. The return value and log file are as described above.</div>
</li>
</ul>
<a name="translateTextFile-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translateTextFile</h4>
<pre>public boolean translateTextFile(java.lang.String configFileList,
java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String logFileName,
java.lang.String settingsString,
int mode)</pre>
<div class="block">The plain-text file in inFile is translated to braille and the
translation placed in outputFile as described for the previous method.
If the text contains blank lines they are treated as paragraph breaks.</div>
</li>
</ul>
<a name="backTranslateFile-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backTranslateFile</h4>
<pre>public boolean backTranslateFile(java.lang.String configFileList,
java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String logFileName,
java.lang.String settingsString,
int mode)</pre>
</li>
</ul>
<a name="charToDots-java.lang.String-byte:A-byte:A-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charToDots</h4>
<pre>public boolean charToDots(java.lang.String tableList,
byte[] inbuf,
byte[] outbuf,
java.lang.String logFile,
int mode)</pre>
<div class="block">Convert the utf8 character string in inbuf to Unicode braille dot
patterns and place the result as a utf8 string in outbuf.</div>
</li>
</ul>
<a name="dotsToChar-java.lang.String-byte:A-byte:A-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dotsToChar</h4>
<pre>public boolean dotsToChar(java.lang.String tableList,
byte[] inbuf,
byte[] outbuf,
java.lang.String logFile,
int mode)</pre>
<div class="block">Convert the utf8 string of dot patterns in inbuf to characters and
place the result as a utf8 string in outbuf.</div>
</li>
</ul>
<a name="checkTable-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkTable</h4>
<pre>public boolean checkTable(java.lang.String tableList,
java.lang.String logFile,
int mode)</pre>
<div class="block">See if the table in tableList exists and is valid. If no errors are
found logFile will be empty.</div>
</li>
</ul>
<a name="setDataPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDataPath</h4>
<pre>public void setDataPath(java.lang.String path)</pre>
<div class="block">Path on which liblouis tables and liblouisutdml files can be found.</div>
</li>
</ul>
<a name="file2brl-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>file2brl</h4>
<pre>public boolean file2brl(java.lang.String[] args)</pre>
<div class="block">This method performs the functions of the file2brl program in a more
contrrolled environment.</div>
</li>
</ul>
<a name="setWriteablePath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWriteablePath</h4>
<pre>public void setWriteablePath(java.lang.String path)</pre>
<div class="block">Set the path to which temporary files will be written.</div>
</li>
</ul>
<a name="free--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre>public void free()</pre>
<div class="block">You must call free at the end of your application to free all
memory used by liblouisutdml and liblouis. Do NOT call it after every
call to a liblouisutdml method. This will result in great
inefficiency. The memory used by liblouisutdml for each document is
freed wen the method completes, but some memory holding configuration
settings is held. The memory used by liblouis is freed only when the
free method is called.</div>
</li>
</ul>
<a name="setLogFile-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogFile</h4>
<pre>public void setLogFile(java.lang.String fileName)</pre>
</li>
</ul>
<a name="logEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logEnd</h4>
<pre>public void logEnd()</pre>
</li>
</ul>
<a name="registerLogCallback-org.liblouis.LogCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerLogCallback</h4>
<pre>public void registerLogCallback(<a href="../../org/liblouis/LogCallback.html" title="interface in org.liblouis">LogCallback</a> cb)</pre>
</li>
</ul>
<a name="setLogLevel-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setLogLevel</h4>
<pre>public void setLogLevel(int level)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../org/liblouis/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/liblouis/LibLouis.html" title="class in org.liblouis"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/liblouis/LogCallback.html" title="interface in org.liblouis"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/liblouis/LibLouisUTDML.html" target="_top">Frames</a></li>
<li><a href="LibLouisUTDML.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|