File	Doc	Category	Size	Date	Package
XMLResources.java	API Doc	Apache James 2.3.1	15370	Fri Jan 12 12:56:34 GMT 2007	org.apache.james.util

XMLResources

• java.lang.Object

Fields Summary
private Map	m_resource A map of statement types to resource strings
private static Map	stringTable A set of all used String values
private org.apache.oro.text.perl.Perl5Util	m_perl5Util A Perl5 regexp matching helper class

Constructors Summary

Methods Summary
public java.lang.String	getString(java.lang.String name) Returns a named string for the specified key. param name the name of the String resource required. return the requested resource return (String)m_resource.get(name);
public java.lang.String	getString(java.lang.String name, boolean required) Returns a named string for the specified key. param name the name of the String resource required. param required true if the resource is required return the requested resource throws ConfigurationException if a required resource cannot be found. String str = getString(name); if (str == null && required) { StringBuffer exceptionBuffer = new StringBuffer(64) .append("Required String resource: '") .append(name) .append("' was not found."); throw new IllegalArgumentException(exceptionBuffer.toString()); } return str;
public java.lang.String	getString(java.lang.String name, java.util.Map parameters) Returns a named string, replacing parameters with the values set in a Map. param name the name of the String resource required. param parameters a map of parameters (name-value string pairs) which are replaced where found in the input strings return the requested resource return replaceParameters(getString(name), parameters);
public java.lang.String	getString(java.lang.String name, java.util.Map parameters, boolean required) Returns a named string, replacing parameters with the values set in a Map. param name the name of the String resource required. param parameters a map of parameters (name-value string pairs) which are replaced where found in the input strings return the requested resource return replaceParameters(getString(name, required), parameters);
public void	init(java.io.File xmlFile, java.lang.String group, java.lang.String select, java.util.Map configParameters) Configures an XMLResources object to provide string statements from a file. Parameters encoded as $(parameter} in the input file are replace by values from the parameters Map, if the named parameter exists. Parameter values may also be specified in the resourceSection element. param xmlFile the input file containing the string definitions param group xml element containing the strings to be used param select if customized elements exist for this value, use them instead of the default param configParameters a map of parameters (name-value string pairs) which are replaced where found in the input strings // Parse the xmlFile as an XML document. DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); DocumentBuilder builder = factory.newDocumentBuilder(); Document doc = builder.parse(xmlFile); // First process the matchers, to select the statements to use. Element matcherElement = (Element)(doc.getElementsByTagName("matchers").item(0)); String selectTag = null; if ( matcherElement != null ) { selectTag = match(select, matcherElement); m_perl5Util = null; // release the PERL matcher! } // Now get the section defining strings for the group required. NodeList sections = doc.getElementsByTagName("group"); int sectionsCount = sections.getLength(); Element sectionElement = null; for (int i = 0; i < sectionsCount; i++ ) { sectionElement = (Element)(sections.item(i)); String sectionName = sectionElement.getAttribute("name"); if ( sectionName != null && sectionName.equals(group) ) { break; } } if ( sectionElement == null ) { StringBuffer exceptionBuffer = new StringBuffer(64) .append("Error loading string definition file. ") .append("The element named \'") .append(group) .append("\' does not exist."); throw new RuntimeException(exceptionBuffer.toString()); } // Get parameters defined within the file as defaults, // and use supplied parameters as overrides. Map parameters = new HashMap(); // First read from the <params> element, if it exists. Element parametersElement = (Element)(sectionElement.getElementsByTagName("parameters").item(0)); if ( parametersElement != null ) { NamedNodeMap params = parametersElement.getAttributes(); int paramCount = params.getLength(); for (int i = 0; i < paramCount; i++ ) { Attr param = (Attr)params.item(i); String paramName = param.getName(); String paramValue = param.getValue(); parameters.put(paramName, paramValue); } } // Then copy in the parameters supplied with the call. parameters.putAll(configParameters); // 2 maps - one for storing default statements, // the other for statements with a "for" attribute matching this // connection. Map defaultStrings = new HashMap(); Map selectTagStrings = new HashMap(); // Process each string resource, replacing string parameters, // and adding to the appropriate map.. NodeList resDefs = sectionElement.getElementsByTagName("resource"); int resCount = resDefs.getLength(); for ( int i = 0; i < resCount; i++ ) { // See if this needs to be processed (is default or product specific) Element resElement = (Element)(resDefs.item(i)); String resSelect = resElement.getAttribute("for"); Map resMap; if ( resSelect.equals("")) { // default resMap = defaultStrings; } else if (resSelect.equals(selectTag) ) { // Specific to this product resMap = selectTagStrings; } else { // for a different product continue; } // Get the key and value for this string resource. String resKey = resElement.getAttribute("name"); if ( resKey == null ) { // ignore elements without a "name" attribute. continue; } String resString = resElement.getFirstChild().getNodeValue(); // Do parameter replacements for this string resource. Iterator paramNames = parameters.keySet().iterator(); while ( paramNames.hasNext() ) { String paramName = (String)paramNames.next(); String paramValue = (String)parameters.get(paramName); StringBuffer replaceBuffer = new StringBuffer(64) .append("${") .append(paramName) .append("}"); resString = substituteSubString(resString, replaceBuffer.toString(), paramValue); } // See if we already have registered a string of this value String shared = (String) stringTable.get(resString); // If not, register it -- we will use it next time if (shared == null) { stringTable.put(resString, resString); } else { resString = shared; } // Add to the resMap - either the "default" or the "product" map resMap.put(resKey, resString); } // Copy in default strings, then overwrite product-specific ones. m_resource.putAll(defaultStrings); m_resource.putAll(selectTagStrings);
private java.lang.String	match(java.lang.String select, org.w3c.dom.Element matchersElement) Compares the "select" value against a set of regular expressions defined in XML. The first successful match defines the name of a selector tag. This value is then used to choose the specific expressions to use. param select the String to be checked param matchersElement the XML element containing selector patterns return the selector tag that will be used to select custom resources String selectTagName = select; NodeList matchers = matchersElement.getElementsByTagName("matcher"); for ( int i = 0; i < matchers.getLength(); i++ ) { // Get the values for this matcher element. Element matcher = (Element)matchers.item(i); String matchName = matcher.getAttribute("for"); StringBuffer selectTagPatternBuffer = new StringBuffer(64) .append("/") .append(matcher.getAttribute("match")) .append("/i"); // If the select string matches the pattern, use the match // name from this matcher. if ( m_perl5Util.match(selectTagPatternBuffer.toString(), selectTagName) ) { return matchName; } } return null;
public static java.lang.String	replaceParameters(java.lang.String str, java.util.Map parameters) Returns a named string, replacing parameters with the values set. param name the name of the String resource required. param parameters a map of parameters (name-value string pairs) which are replaced where found in the input strings return the requested resource if (str != null && parameters != null) { // Do parameter replacements for this string resource. Iterator paramNames = parameters.keySet().iterator(); StringBuffer replaceBuffer = new StringBuffer(64); while ( paramNames.hasNext() ) { String paramName = (String)paramNames.next(); String paramValue = (String)parameters.get(paramName); replaceBuffer.append("${").append(paramName).append("}"); str = substituteSubString(str, replaceBuffer.toString(), paramValue); if (paramNames.hasNext()) replaceBuffer.setLength(0); } } return str;
private static java.lang.String	substituteSubString(java.lang.String input, java.lang.String find, java.lang.String replace) Replace substrings of one string with another string and return altered string. param input input string param find the string to replace param replace the string to replace with return the substituted string int find_length = find.length(); int replace_length = replace.length(); StringBuffer output = new StringBuffer(input); int index = input.indexOf(find); int outputOffset = 0; while ( index > -1 ) { output.replace(index + outputOffset, index + outputOffset + find_length, replace); outputOffset = outputOffset + (replace_length - find_length); index = input.indexOf(find, index + find_length); } String result = output.toString(); return result;