Java Doc for LocaleMatcher.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » matching » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Content Management System » apache lenya 2.0 » org.apache.cocoon.matching 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.cocoon.matching.LocaleMatcher

LocaleMatcher
public class LocaleMatcher extends AbstractLogEnabled implements Matcher,ThreadSafe,Serviceable,Configurable,Disposable(Code)
A matcher that locates and identifies to the pipeline a source document to be used as the content for an i18n site, based upon a locale provided in a range of ways.

Configuration

A sample configuration (given in the <map:matchers> section of the sitemap) is given below. This configuration shows default values.

 <map:matcher name="i18n" src="org.apache.cocoon.matching.LocaleMatcher">
 <locale-attribute>locale</locale-attribute>
 <negotiate>false</negotiate>
 <use-locale>true</use-locale>
 <use-locales>false</use-locales>
 <use-blank-locale>true</use-blank-locale>
 <default-locale language="en" country="US"/>
 <store-in-request>false<store-in-request>
 <create-session>false<create-session>
 <store-in-session>false<store-in-session>
 <store-in-cookie>false<store-in-cookie>
 </map:matcher>
 

Above configuration parameters mean:

  • locale-attribute specifies the name of the request parameter / session attribute / cookie that is to be used as a locale (defaults to locale)
  • negotiate specifies whether matcher should check that resource exists. If set to true, matcher will look for the locale till matching resource is found. If no resource found even with default or blank locale, matcher will not match.
  • use-locale specifies whether the primary locale provided by the user agent (or server default, is no locale passed by the agent) is to be used
  • use-locales specifies whether each locale provided by the user agent should be tested in turn (makes sense only when negotiate is set to true)
  • default-locale specifies the default locale to be used when none matches any of the previous ones.
  • use-blank-locale specifies whether a file should be looked for without a locale in its filename or filepath (e.g. after looking for index.en.html, try index.html) if none matches any of the previous locales.
  • store-in-request specifies whether found locale should be stored as request attribute.
  • create-session specifies whether session should be created when storing found locale as session attribute.
  • store-in-session specifies whether found locale should be stored as session attribute.
  • store-in-cookie specifies whether found locale should be stored as cookie.

Usage

This matcher will be used in a pipeline like so:

 <map:match pattern="*.html">
 <map:match type="i18n" pattern="xml/{1}.*.xml">
 <map:generate src="{source}"/>
 ...
 </map:match>
 </map:match>
 

* in the pattern identifies the place where locale should be inserted. In case of a blank locale, if character before and after * is the same (like in example above), duplicate will be removed (xml/{1}.*.xml becomes xml/{1}.xml).

Locale Identification

Locales will be tested in following order:

  • Locale provided as a request parameter
  • Locale provided as a session attribute
  • Locale provided as a cookie
  • Locale provided using a sitemap parameter
    (<map:parameter name="locale" value="{1}"/> style parameter within the <map:match> node)
  • Locale provided by the user agent, or server default, if use-locale is set to true
  • Locales provided by the user agent, if use-locales is set to true.
  • The default locale, if specified in the matcher's configuration
  • Resources with no defined locale (blank locale)

If negotiate mode is set to true, a source will be looked up using each locale. Where the full locale (language, country, variant) doesn't match, it will fall back first to language and country, and then just language, before moving on to the next locale.

If negotiate mode is set to false (default), first found locale will be returned.

Sitemap Variables

Once a matching locale has been found, the following sitemap variables will be available to sitemap elements contained within the matcher:

  • {source}: The URI of the source that matched
  • {locale}: The locale that matched that resource
  • {matched-locale}: The part of the locale that matched the resource
  • {language}: The language of the matching resource
  • {country}: The country of the matching resource
  • {variant}: The variant of the matching resource

since:
   2.1.6
author:
   Upayavira
author:
   Vadim Gritsenko
version:
   CVS $Id: LocaleMatcher.java 433543 2006-08-22 06:22:54Z crossley $




Method Summary
public  voidconfigure(Configuration config)
    
public  voiddispose()
    
public  Mapmatch(String pattern, Map objectModel, Parameters parameters)
    
public  voidservice(ServiceManager manager)
    



Method Detail
configure
public void configure(Configuration config)(Code)



dispose
public void dispose()(Code)



match
public Map match(String pattern, Map objectModel, Parameters parameters) throws PatternException(Code)



service
public void service(ServiceManager manager) throws ServiceException(Code)



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.