/usr/share/doc/libeigenbase-resgen-java/index.html is in libeigenbase-resgen-java-doc 1.3.0.13768-4.
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 | <html>
<!--
// $Id: //open/util/resgen/doc/index.html#3 $
// package org.eigenbase.resgen is an i18n resource generator
// Copyright (C) 2005-2005 The Eigenbase Project
// Copyright (C) 2005-2005 Disruptive Tech
// Copyright (C) 2005-2005 Red Square, Inc.
// Portions Copyright (C) 2002-2005 Kana Software, Inc. and others.
// All Rights Reserved.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
//
// jhyde, 24 September, 2002
-->
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 6.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>Eigenbase ResGen specification</title>
<link rel="stylesheet" href="stylesheet.css" type="text/css" />
<base target="_top">
</head>
<body>
<h1>ResGen: Eigenbase Resource Generator</h1>
<p>Julian Hyde; last updated September, 2005.</p>
<hr noshade color="#000000" size="1">
<p>ResGen (the Eigenbase <i><b>Res</b></i>ource <i><b>Gen</b></i>erator)
helps you build and maintain internationalized applications in Java. From a
simple XML file, it generates classes to access those resources in a type-safe
manner. It is tightly integrated with <a href="http://jakarta.apache.org/ant/">
ANT</a>, to make the development process painless; and it supports a variety of
schemes to determine the current locale.</p>
<p>Let's take a look at a simple example.</p>
<h2>Example</h2>
<p>The following example shows how you would define a simple resource file, generate
resource classes from it, and use those classes in your own code.</p>
<h3>Create a resource file</h3>
<p>First, create a resource file like the following, <code>BirthdayResource_en_US.xml</code>:</p>
<blockquote>
<pre><?xml version="1.0" ?>
<?xml-stylesheet type="text/xsl" href="Resource.xsl" ?>
<resourceBundle locale="en_US">
<message name="HappyBirthday">
<text>Happy Birthday, {0}! You don''t look {1,number}.</text>
</message>
<exception name="TooYoung" className="RuntimeException">
<text>{0} has not been born yet.</text>
</exception>
</resourceBundle></pre>
</blockquote>
<p dir="ltr">The top-level element of a resource file is always a <code><resourceBundle></code>, and the only necessary property
is the <code>locale</code> of the current file. Its children are a mixture of
<code><message></code> and <code><exception></code> elements. Each must have a
<code>name</code> attribute and a <code><text></code> child holding the message
string.</p>
<h3>Create ANT target</h3>
<p>Now modify your ANT build-file, <code>build.xml</code>, as follows:</p>
<blockquote>
<pre><taskdef name="resgen" classname="org.eigenbase.resgen.ResourceGenTask">
<classpath path="lib/eigenbase-resgen.jar:lib/eigenbase-xom.jar"/>
</taskdef>
<target name="generate.resources">
<resgen srcdir="source" locales="en_US">
<include name="happy/BirthdayResource_en_US.xml"/>
</resgen>
</target>
<target name="compile" depends="generate.resources">
<javac srcdir="source" destdir="classes">
<include name="happy/BirthdayResource*.java"/>
</javac>
<copy todir="classes">
<fileset dir="source" includes="**/*.properties"/>
</copy>
</target></pre>
</blockquote>
<p>I have assumed that your Java source files are held in the "<code>source</code>"
directory, and classes are compiled to <code>classes</code> directory, but this
ought to be easy to change. If you already have a target to compile Java source
files, you don't need the "<code>compile</code>" target; just add its contents to your own
target.</p>
<h3>Compile</h3>
<p>Build as follows. (You need 'ant' on your path, and you will need to edit the
project.classpath property in <code>build.xml</code>.)</p>
<blockquote>
<pre>$ ant
Buildfile: build.xml
generate.resources:
[resgen] Generating source\happy\BirthdayResource.java
[resgen] Generating source\happy\BirthdayResource_en_US.java
[resgen] Generating source\happy\BirthdayResource_en_US.properties
compile:
[javac] Compiling 2 source files to classes
[copy] Copying 1 files to classes
BUILD SUCCESSFUL
Total time: 3 seconds</pre>
</blockquote>
<p>Four files are generated.</p>
<p><code>source/happy/BirthdayResource.java</code>:</p>
<blockquote>
<pre>package happy;
import java.io.IOException;
import java.util.Locale;
import org.eigenbase.resgen.*</a>;
class BirthdayResource extends ShadowResourceBundle {
public BirthdayResource() throws IOException {
}
private static String baseName = "happy.BirthdayResource";
/**
* Retrieves the singleton instance of {@link BirthdayResource}. If
* the application has called {@link #setThreadLocale}, returns the
* resource for the thread's locale.
*/
public static synchronized BirthdayResource instance() {
return (BirthdayResource) instance(baseName);
}
/**
* Retrieves the instance of {@link BirthdayResource} for the given locale.
*/
public static synchronized BirthdayResource instance(Locale locale) {
return (BirthdayResource) instance(baseName, locale);
}
/** HappyBirthday is 'Happy Birthday, {0}! You don''t look {1,number} at all.' */
public static final ResourceDefinition HappyBirthday = new ResourceDefinition("HappyBirthday", "Happy Birthday, {0}! You don''t look {1,number} at all.");
public static String getHappyBirthday(String p0, Number p1) {
return HappyBirthday.instantiate(
getInstance(), new Object[] {p0, p1}).toString();
}
/** TooYoung is '{0} has not been born yet.' */
public static final ResourceDefinition TooYoung = new ResourceDefinition("TooYoung", "{0} has not been born yet.");
public static String getTooYoung(String p0) {
return HappyBirthday.instantiate(
getInstance(), new Object[] {p0}).toString();
}
public static RuntimeException newTooYoung(String p0) {
return new RuntimeException(TooYoung.instantiate(
getInstance(), new Object[] {p0}), null);
}
public static RuntimeException newTooYoung(String p0, Throwable err) {
return new RuntimeException(TooYoung.instantiate(
getInstance(), new Object[] {p0}), err);
}
}</pre>
</blockquote>
<p><code>source/happy/BirthdayResource_en_US.java</code>:</p>
<blockquote>
<pre>package happy;
import java.io.IOException;
public class BirthdayResource_en_US extends BirthdayResource {
public BirthdayResource_en_US() throws IOException {}
}</pre>
</blockquote>
<p><code>source/happy/BirthdayResource.properties</code>:</p>
<blockquote>
<pre>HappyBirthday=Happy Birthday, {0}! You don''t look {1,number}.
TooYoung={0} has not been born yet.</pre>
</blockquote>
<p><code>source/happy/BirthdayResource_en_US.properties</code>:</p>
<blockquote>
<pre># This file is intentionally blank. Add property values
# to this file to override the translations in the base
# properties file, BirthdayResource.properties.</pre>
</blockquote>
<p>For each resource, a <code>get</code><code><i>Xxx</i>()</code> method is
generated to retrieve that resource in the current locale, substituting
parameters appropriately. For exception resources, an additional two <code>new<i>Xxx</i>()</code>
methods are generated to create (but not throw) an exception.</p>
<p>Tokens such as <code>{0}</code> and <code>{1,number}</code> in the message
are automatically converted to method parameters of the right type. This means
that if you ever change the parameters in your error message, or accidentally
delete it, you code will no longer build. (If your code doesn't compile, you can
fix the problem immediately; better that than getting a phone call, "I just got
this really weird error...", in a few months time.)</p>
<p>Here's how you might use it in your code:</p>
<blockquote>
<pre>import happy.BirthdayResource;
public class Birthday {
static void wishHappyBirthday(String name, int age) {
if (age < 0) {
throw BirthdayResource.newTooYoung(name);
}
System.out.println(BirthdayResource.getHappyBirthday(name, age));
}
public static void main(String[] args) {
wishHappyBirthday("Fred", 33);
wishHappyBirthday("Wilma", -3);
}
}</pre>
</blockquote>
<p>This produces the following output.</p>
<blockquote>
<pre>Happy Birthday, Fred! You don't look 33.
RuntimeException: Wilma has not been born yet.</pre>
</blockquote>
<p>So there are the basics. That was easy, wasn't it? Now let's look at how you can
tell the system to switch to another locale, and how you go about producing
resource files for that locale.</p>
<h2>Of locales and threads</h2>
<p>When you ask for a message, the system needs to know the locale in order to
get the right translation. There are several strategies for this.</p>
<p>The simplest strategy is to do nothing. Most applications run in the same locale as their
host machine, and so when the system calls <code>Locale.getDefault()</code>, it
will return the right answer.</p>
<p>You can switch locale by calling <code>Locale.getDefault(Locale newLocale)</code>,
but this call will affect other applications running in the same Java Virtual
Machine, and is not allowed in some application server environments.</p>
<p>ResGen provides a method
<code>ShadowResourceBundle.setThreadLocale(Locale)</code> to allow threads
to have different locales. Threads which are working in a different locale
should call this method at their entry point. For example:</p>
<blockquote>
<pre>System.out.println(BirthdayResource.getHappyBirthday("Fred", 33));
ShadowResourceBundle.setThreadLocale(Locale.FR);
System.out.println(BirthdayResource.getHappyBirthday("Pierre", 22));</pre>
</blockquote>
<p>produces the output</p>
<blockquote>
<pre>Happy Birthday, Fred! You don't look 33.
Bon anniversaire, Pièrre! 22, quel bon âge.</pre>
</blockquote>
<p>Threads which have not made this call will remain in the default locale.</p>
<p>This strategy may not be possible if the threading model is complex. Here,
you should use an explicit resource bundle object:</p>
<blockquote>
<pre>BirthdayResource myResource = BirthdayResource.instance();
System.out.println(myResource.getHappyBirthday("Fred", 33));
myResource = BirthdayResource.instance(Locale.FR);
System.out.println(myResource.getHappyBirthday("Pierre", 22));</pre>
</blockquote>
<p>The problem is that the accessor methods (<code>getHappyBirthday</code>, and so forth) are
static. To make them non-static, change add <code>static="false"</code> to the
<code><resgen></code> ANT task:</p>
<blockquote>
<pre><target name="generate.resources">
<resgen srcdir="source" <font color="#FF0000"><i><b>style="dynamic"</b></i></font>>
<include name="happy/BirthdayResource_en_US.xml"/>
</resgen>
</target></pre>
</blockquote>
<h2>Translation</h2>
<p>So far, we've just been dealing with one resource file, and you're probably
wondering why you went to all the trouble of extracting your messages and
exception strings! Have no fear, there will be more. A typical development
process goes as follows.</p>
<p>First, you develop your application for a single locale, referred to as the
<dfn>base locale</dfn>. I have been assuming that
this American English (<code>en_US</code>), but you can develop in any locale
you choose.</p>
<p>You create an XML file for this language containing all the messages and
exceptions used by your application. Developers are often tempted to put in
hard-coded strings, but ResGen's tight integration with ANT makes it painless to
modify the XML file and re-generate the wrapper as you go.</p>
<p>So now you have an application in the beta stage. You're written most of the
code, are getting through the pile of bugs, and would like to translate the
product into French (<code>fr_FR</code>). Recall that in the above example, we
were dealing with the following set of files.</p>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<th>Source files</th>
<td valign="top">happy/BirthdayResource_en_US.xml</td>
</tr>
<tr>
<th>Generated files</th>
<td valign="top">happy/BirthdayResource.java<br>
happy/BirthdayResource.properties<br>
happy/BirthdayResource_en_US.java<br>
happy/BirthdayResource_en_US.properties</td>
</tr>
<tr>
<th>Runtime files</th>
<td valign="top">happy/BirthdayResource.class<br>
happy/BirthdayResource.properties<br>
happy/BirthdayResource_en_US.class<br>
happy/BirthdayResource_en_US.properties</td>
</tr>
</table>
</blockquote>
<p>Do the following steps:</p>
<ol>
<li>Copy <code>happy/BirthdayResource.properties</code> to <code>happy/BirthdayResource_fr_FR.properties</code>,
and translate the messages as appropriate for the new locale:<blockquote>
<pre>HappyBirthday=Bon anniversaire, {0}! {1,number}, c'est un bon age.
TooYoung={0} n'est pas encore né(e).</pre>
</blockquote>
<p> </li>
<li>Add <code>happy/BirthdayResource_fr_FR.properties</code> to the ANT task:<blockquote>
<pre><target name="generate.resources">
<resgen srcdir="source" <font color="#FF0000"><i>locales="en_US,fr_FR"</i></font>>
<include name="happy/BirthdayResource_en_US.xml"/>
<font color="#FF0000"><i><include name="happy/BirthdayResource_fr_FR.properties"/></i></font>
</resgen>
</target></pre>
</blockquote></li>
<li>Build.</li>
</ol>
<p>ResGen treats <code>happy/BirthdayResource_fr_FR.properties</code> as a source file.
It generates <code>happy/BirthdayResource_fr_FR.java</code> from it, and validates that
every resource in <code>happy/BirthdayResource_fr_FR.properties</code> exists in
<code>happy/BirthdayResource_en_US.xml</code>, and has the same number and types of parameters.</p>
<p>In this multi-language scenario, the source and generated files are as
follows (new files are shown in <i>italic</i>):</p><blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
<tr>
<th>Source files</th>
<td valign="top" dir="ltr">happy/BirthdayResource_en_US.xml<br>
<i>happy/BirthdayResource_fr_FR.properties</i></td>
</tr>
<tr>
<th>Generated files</th>
<td dir="ltr" valign="top">happy/BirthdayResource.java<br>
happy/BirthdayResource.properties<br>
happy/BirthdayResource_en_US.java<br>
happy/BirthdayResource_en_US.properties<br>
<i>happy/BirthdayResource_fr_FR.java</i></td>
</tr>
<tr>
<th>Runtime files</th>
<td dir="ltr" valign="top">happy/BirthdayResource.class<br>
happy/BirthdayResource.properties<br>
happy/BirthdayResource_en_US.class<br>
happy/BirthdayResource_en_US.properties<br>
<i>happy/BirthdayResource_fr_FR.class<br>
happy/BirthdayResource_fr_FR.properties</i></td>
</tr>
</table>
</blockquote>
<p>(Validation is not implemented yet. As well as detecting modified and deleted
messages, it should also have a mode which reminds us to add new messages.)</p>
<a name="cpp_resources"></a>
<h2>Styles of generated code</h2>
<p>ResGen can generate Java code in three styles: <code>static</code>, <code>
dynamic</code> and <code>functor</code>.</p>
<h4>Static style</h4>
<p>In the <code>static</code> style, the generated Java resource class contains
a resource member and several methods for each resource. In the example, the <i>
TooYoung</i> resource had a data member and three methods:</p>
<ul>
<li><code>public static final ResourceDefinition TooYoung;</code></li>
<li><code>public static String getTooYoung(String)</code></li>
<li><code>public static RuntimeException newTooYoung(String)</code></li>
<li><code>public static RuntimeException newTooYoung(String, Throwable)</code></li>
</ul>
<p>To change style, add an attribute to your ant target:</p>
<blockquote>
<pre><resgen srcdir="source" <font color="#FF0000"><i><b>style="functor" </b></i></font>locales="en_US">
<include name="happy/BirthdayResource_en_US.xml"/>
</resgen></pre>
</blockquote>
<h4>Dynamic style</h4>
<p>In the <code>dynamic</code> style, the same data member and methods are
generated, but they are not static. For example,</p>
<ul>
<li><code>public final ResourceDefinition TooYoung;</code></li>
<li><code>public String getTooYoung(String)</code></li>
<li><code>public RuntimeException newTooYoung(String)</code></li>
<li><code>public RuntimeException newTooYoung(String, Throwable)</code></li>
</ul>
<p>Because the methods are not static, they have different behavior if they are
invoked on different objects. Typically you have an instance of the resource
bundle for each locale. These instances are accessed via the <code>instance()</code>
and <code>instance(Locale)</code> methods in the resource bundle:</p>
<ul>
<li><code>BirthdayResource.instance()</code> returns the instance of the
resource bundle for the thread's default locale.</li>
<li><code>BirthdayResource.instance(Locale)</code> returns the instance of
the resource bundle for the given locale.</li>
</ul>
<p>Here's the same code example using <code>dynamic</code> resources:</p>
<blockquote>
<pre>import happy.BirthdayResource;
public class Birthday {
static void wishHappyBirthday(String name, int age) {
if (age < 0) {
throw <font color="#FF0000"><i><b>BirthdayResource.instance().newTooYoung(name)</b></i></font>;
}
System.out.println(<font color="#FF0000"><i><b>BirthdayResource.instance().getHappyBirthday(name, age)</b></i></font>);
}
public static void main(String[] args) {
wishHappyBirthday("Fred", 33);
wishHappyBirthday("Wilma", -3);
}
}</pre>
</blockquote>
<p> </p>
<h4>Functor style</h4>
<p>In the <code>functor</code> style, only one data member is generated per
resource, but the data member belongs to a class which has all of the necessary
accessor methods. For example,</p>
<ul>
<li><code>public final _Def0 TooYoung;</code></li>
<li><code>public class _Def0 extends ResourceDefinition {<br>
public String getTooYoung(String);<br>
public RuntimeException newTooYoung(String);<br>
public RuntimeException newTooYoung(String, Throwable);<br>
}</code></li>
</ul>
<p>The accessor methods have the same purpose as the generated methods in <code>
static</code> or <code>dynamic</code> style, but have different names. The <code>
str</code> accessor method corresponds to <code>getTooYoung</code>, and <code>ex</code>
corresponds <code>newTooYoung</code>.</p>
<p>Let's see how the code example looks when rewritten to use functors.</p>
<blockquote>
<pre>import happy.BirthdayResource;
public class Birthday {
static void wishHappyBirthday(String name, int age) {
if (age < 0) {
throw <font color="#FF0000"><i><b>BirthdayResource.instance().TooYoung.ex(name)</b></i></font>;
}
System.out.println(<font color="#FF0000"><i><b>BirthdayResource.instance().HappyBirthday.str(name, age)</b></i></font>);
}
public static void main(String[] args) {
wishHappyBirthday("Fred", 33);
wishHappyBirthday("Wilma", -3);
}
}</pre>
</blockquote>
<p>The code is slightly more verbose, but functors have two advantages. First,
functors are genuine objects, so can be passed as callbacks. Suppose that you
are designing a library method which is to create, populate, and throw an
exception if it encounters an error, but which cannot be dependent upon a
particular resource file. You could design the method to receive a functor, and
the method could call the functor's <code>ex()</code> method if it has an error.</p>
<p>Second, they make it easy to figure out which pieces of code are using a
particular resource, because there is only one access point to that resource.
For example, every piece of code which uses the <i>TooYoung</i> resource must do
so via the <code>BirthdayResource.TooYoung</code> data member. If no code is
using the data member, you can safely obsolete the resource.</p>
<h2>C++ Resource Support</h2>
<p>ResGen also includes support for building and maintaining
internationalized applications in <a target="_self" href="overview_cpp.html">C++</a>.
<h2>Resource file format</h2>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber2">
<tr>
<th>Element</th>
<th>Attributes</th>
</tr>
<tr>
<td><code><resourceBundle></code></td>
<td><p>The top-level element.</p>
<p>Attributes:</p>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="table2">
<tr>
<th>name</th>
<th>description</th>
</tr>
<tr>
<td><b><code>locale</code></b></td>
<td>The locale of resources in this file. Required.</td>
</tr>
<tr>
<td><b><code>style</code></b></td>
<td>If <code>dynamic</code> (the default),
generate several accessor methods per resource;
if <code>functor</code>, generate one member per resource, with several
methods. </td>
</tr>
<tr>
<td><b><code>exceptionClassName</code></b></td>
<td>The default class of exception to generate.
Must be qualified by package name, unless it is in the package <code>
java.lang</code>. Not required; default value is "java.lang.RuntimeException".
The <code>className</code> attribute of <code><exception></code> overrides
this for a specific exception.</td>
</tr>
<tr>
<td><b><code>cppNamespace</code></b></td>
<td>The namespace used for
generated C++ files. Only used if resources are generated in
C++ mode. Optional.</td>
</tr>
<tr>
<td><b><code>cppCommonInclude</code></b></td>
<td>The name of a header file to
include at the start of all generated C++ files. Optional. Only used if
resources are generated in C++ mode.</td>
</tr>
<tr>
<td><b><code>cppExceptionClassName</code></b></td>
<td>The name of the
exception class to be returned by exception resources.
Optional. Only used if resources are generated in C++ mode.</td>
</tr>
<tr>
<td><b><code>cppExceptionClassLocation</code></b></td>
<td>The name of
the header file to include. Should define the class referred to
in cppExceptionClassName. Required if cppExceptionClassName is
given.</td>
</tr>
</table>
</blockquote>
<p>Children:</p>
<ul>
<li>Zero or more <code><message></code> or <code><exception></code> elements.</li>
</ul>
</td>
</tr>
<tr>
<td><code><message></code></td>
<td><p>Defines a localizable message.</p>
<p>Attributes:</p>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="table4">
<tr>
<th>name</th>
<th>description</th>
</tr>
<tr>
<td><b><code>name</code></b></td>
<td>The identifier of the message. Becomes the name of the
property in the generated <code>.properties</code> file. Required, must be
unique within the resource file, and must be a valid Java identifer.</td>
</tr>
</table>
</blockquote>
<p>Children:</p>
<ul>
<li>Zero or more <code><property></code> elements, defining properties of
the resource. These properties will be accessible at runtime via the
<a href="api/org/eigenbase/resgen/ResourceDefinition.html#getProperties()">
ResourceDefinition.getProperties()</a> method.</li>
<li>A single <code><text></code> element, holding the text of the message. </li>
</ul>
</td>
</tr>
<tr>
<td><exception></td>
<td>Defines an exception and its associated message.<p>Attributes:</p>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111">
<tr>
<th>name</th>
<th>description</th>
</tr>
<tr>
<td><b><code>name</code></b></td>
<td>The identifier of the exception. Becomes the name of the
property in the generated <code>.properties</code> file. Required, must be
unique within the resource file, and must be a valid Java identifer.</td>
</tr>
<tr>
<td><b><code>className</code></b></td>
<td>The type of exception to generate. Must be fully qualified,
unless it is in the package <code>java.lang</code>. If not<br>
specified, the resource bundle's default exception class is used.</td>
</tr>
<tr>
<td><b><code>cppClassName</code></b></td>
<td>The name of the C++
exception class returned by this exception. Either this attribute
or <code><resourceBundle>'s cppExceptionClassName</code>
must be defined.</td>
</tr>
<tr>
<td><b><code>cppClassLocation</code></b></td>
<td>The name of a C++
header file to be included. Required if
<code>cppClassName</code> is used.</td>
</tr>
<tr>
<td><b><code>cppChainExceptions</code></b></td>
<td>If <code>false</code>
(the default), only a basic constructor is need. If
<code>true</code> the basic and chained constructors are
required (see the section on <a href="#cpp_resources">C++
resources</a>.</td>
</tr>
</table>
</blockquote>
<p>Children:</p>
<ul>
<li>A single <code><text></code> element, holding the text of the message. </li>
</ul>
</td>
</tr>
<tr>
<td><code><text></code></td>
<td>The text of the message or exception. Should be in Java message format (see
<a href="http://java.sun.com/j2se/1.4/docs/api/java/text/MessageFormat.html">
class java.text.MessageFormat</a> for more details).<p>If the message contains
XML special characters such as '<' and '&', you may find it easier to
enclose the message in <code><![CDATA[</code> ... <code>]]></code>.</td>
</tr>
<tr>
<td><property></td>
<td>Property of a resource.<p>Attributes:</p>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="table3">
<tr>
<th>name</th>
<th>description</th>
</tr>
<tr>
<td><code>name</code></td>
<td>The name of the property.</td>
</tr>
</table>
</blockquote>
<p>Children:</p>
<ul>
<li>The value of the property.</li>
</ul>
</td>
</tr>
</table>
</blockquote>
<h2>API</h2>
For details on the ResGen interfaces, please see the
<a href="api/index.html">javadoc</a>.
<h2>Conclusion</h2>
<p>ResGen helps you build and maintain an internationalized application. Code
generation helps to leverage the power of the compiler: it detects parameters
which are missing or of the wrong type, spelling mistakes, and informational
messages which are being used to describe error conditions.</p>
<h2>About ResGen</h2>
<p>ResGen is an Eigenbase utility package, and was derived from the
MonRG utility in the <a href="http://mondrian.sourceforge.net">Mondrian project</a> (an open-source OLAP server).
Packaged distributions are available from <a
href="http://sourceforge.net/projects/eigenbase">the Eigenbase project
home page at SourceForge.net</a>. For more information, email <a
href="mailto:perfecthash@users.sourceforge.net">John Sichi</a>.</p>
<hr noshade color="#000000" size="1">
<table border="0" class="clsStd" width="100%" style="border-collapse: collapse" bordercolor="#111111" cellpadding="0" cellspacing="0" id="table1">
<tr>
<td class="content">
<a target="_top" href="http://eigenbase.sourceforge.net">Home</a> |
This file is<i>
<a href="http://eigenbase.sourceforge.net/resgen/index.html">$Id: //open/util/resgen/doc/index.html#3 $</a></i>
(<a href="http://perforce.eigenbase.org:8080/open/util/resgen/doc/index.html?ac=22">log</a>)</td>
<td align="right">
<a href="http://sourceforge.net">SourceForge.net</a>
</td>
</tr>
</table>
</body>
</html>
|