<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0b400696-5f10-41c9-a9cc-6a17cd5137c5"><ac:plain-text-body><![CDATA[ | [http://jakarta.apache.org/commons/resources/ Home] | [wiki:Resources Wiki] [wiki | :ResourcesUserGuide Guide] | [wiki:ResourcesUserGuideIntro Getting Started] [ | wiki:ResourcesUserGuideMessages Messages] | [wiki:ResourcesUserGuideImplementations Standard] [wiki | :ResourcesUserGuideCreating Creating] | [http://jakarta.apache.org/commons/resources/apidocs/ API] [http://jakarta.apache.org/commons/resources/xref/ | Source] ]]></ac:plain-text-body></ac:structured-macro> |
...
3. Standard Resources / ResourcesFactory Implementations
Commons Resources ships with the following implementations of \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/Resources.html Resources\] and \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/ResourcesFactory.html ResourcesFactory\] provided: Wiki Markup
Resources | ResourcesFactory | Description | |||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e86810c8-2a58-473f-9820-d104b4a5068c"><ac:plain-text-body><![CDATA[ | [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResources.html PropertyResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResourcesFactory.html | retrieves values from properties files | ]]></ac:plain-text-body></ac:structured-macro> | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7ba33c85-9907-4700-939e-ee89eb962e9b"><ac:plain-text-body><![CDATA[ | |
[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResources.html XMLResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResourcesFactory.html | retrieves values from XML documents]]></ac:plain-text-body></ac:structured-macro> | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f36f37a8-8f36-43ee-befc-d83f8eadb77c"><ac:plain-text-body><![CDATA[ | |||
[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/JDBCResources.html JDBCResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ | PropertyResourcesFactory.html PropertyResourcesFactory] | retrieves values from a database using JDBC | ]]></ac:plain-text-body></ac:structured-macro> | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e332c8cb-e1bb-4520-9264-10cfa44cc666"><ac:plain-text-body><![CDATA[ | |
[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResources.html WebappPropertyResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ | WebappPropertyResourcesFactory.html WebappPropertyResourcesFactory] | Web App: retrieves values from properties files. | ]]></ac:plain-text-body></ac:structured-macro> | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f04c74f8-8df3-4143-9e23-4ca20d15d148"><ac:plain-text-body><![CDATA[ | |
[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResources.html WebappXMLResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ | WebappXMLResourcesFactory.html WebappXMLResourcesFactory] | Web App: retrieves values from XML documents | ]]></ac:plain-text-body></ac:structured-macro> | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a3bc5672-c828-410d-890a-72db984cedff"><ac:plain-text-body><![CDATA[ | |
[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResources.html ResourceBundleResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.html | wraps java.util.ResourceBundle]]></ac:plain-text-body></ac:structured-macro> |
The following sections describe how to use these implementations:
...
No Format |
---|
// Create the ResourcesFactory ResourcesFactory factory = new PropertyResourcesFactory(); // Create the Resources Resources resources = factory.getResources("Bar", "file:c:/myapp/foo/Bar"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null); |
See *PropertyResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/PropertyResources.html source\] and *PropertyResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/PropertyResourcesFactory.html source\] / Wiki Markup
source and PropertyResourcesFactory JavaDoc / source.
...
3.2 XML Resources
XMLResources works in pretty much the same way as PropertyResources, except the files are in XML format and XMLResources assumes a .xml file extension. Using the same example, if the configuration URL is passed as file:c:/myapp/foo/Bar
then... ...
...
No Format |
---|
// Create the ResourcesFactory ResourcesFactory factory = new XMLResourcesFactory(); // Create the Resources Resources resources = factory.getResources("Bar", "file:c:myapp/foo/Bar"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null); |
...
See *XMLResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/XMLResources.html source\] and *XMLResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/XMLResourcesFactory.html source\] /
source and XMLResourcesFactory JavaDoc / source.
...
3.3 JDBC Resources
JDBCResources retrieves messages from a database using JDBC. The table you use to store the messages needs three columns containing:
...
No Format |
---|
// Create the ResourcesFactory ResourcesFactory factory = new JDBCResourcesFactory(); // Create the Resources Resources resources = factory.getResources("Bar", "file:c:myapp/foo/Bar"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null); |
See *JDBCResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/JDBCResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/JDBCResources.html source\] and *JDBCResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/JDBCResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/JDBCResourcesFactory.html source\] / Wiki Markup
source and JDBCResourcesFactory JavaDoc / source.
...
3.4 Web Application Property Resources
...
No Format |
---|
// Create the ResourcesFactory ResourcesFactory factory = new WebappPropertyResourcesFactory(); factory.setServletContext(servletContext); // Create the Resources Resources resources = factory.getResources("Bar", "/org/apache/struts/Bar"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null); |
See *WebappPropertyResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappPropertyResources.html source\] and *WebappPropertyResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.html source\] / Wiki Markup
source and WebappPropertyResourcesFactory JavaDoc / source.
...
3.5 Web Application XML Resources
...
No Format |
---|
// Create the ResourcesFactory ResourcesFactory factory = new WebappXMLResourcesFactory(); factory.setServletContext(servletContext); // Create the Resources Resources resources = factory.getResources("Bar", "/org/apache/struts/Bar"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null); |
See *Webapp{{`}}{{`}}XMLResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappXMLResources.html source\] and *WebappXMLResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappXMLResourcesFactory.html source\] / Wiki Markup
source and WebappXMLResourcesFactory JavaDoc / source.
...
3.6 java.util.ResourceBundle Resources
...
No Format |
---|
// Create the ResourcesFactory ResourcesFactory factory = new ResourceBundleResourcesFactory(); // Create the Resources Resources resources = factory.getResources("Bar", "BarResources"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null); |
...
See *ResourceBundleResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/ResourceBundleResources.html source\] and *ResourceBundleResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.html source\]. /
source and ResourceBundleResourcesFactory JavaDoc / source.
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="dfe7233e-89a5-44e2-a879-a236dbf42a93"><ac:plain-text-body><![CDATA[ | [http://jakarta.apache.org/commons/resources/ Home] | [wiki:Resources Wiki] | [wiki:ResourcesUserGuide Guide] | [wiki:ResourcesUserGuideIntro Getting Started] | [wiki:ResourcesUserGuideMessages Messages] | [wiki:ResourcesUserGuideImplementations Standard] | [wiki:ResourcesUserGuideCreating Creating] | [http://jakarta.apache.org/commons/resources/apidocs/ API] | [http://jakarta.apache.org/commons/resources/xref/ Source] | ]]></ac:plain-text-body></ac:structured-macro> |