XmlHelper.java
| Index Score | ||
|---|---|---|
 |
 |
org.pentaho.core.util |
 |
 |
Pentaho |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| PARAMS | Number of formal parameter declarations |  |
| SIZE | Size of the file in bytes | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| EXITS | Procedure exits | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| RETURNS | Number of return points from functions | |
| OPERATORS | Number of operators | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| LOGICAL_LINES | Number of statements | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMMENTS | Comment lines | |
| LOC | Lines of code | |
| BLOCK_COMMENT | Number of block comment lines | |
| LOOPS | Number of loops | |
| FUNCTIONS | Number of function declarations | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| COMPARISONS | Number of comparison operators | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright 2006 Pentaho Corporation. All rights reserved.
* This software was developed by Pentaho Corporation and is provided under the terms
* of the Mozilla Public License, Version 1.1, or any later version. You may not use
* this file except in compliance with the license. If you need a copy of the license,
* please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
* BI Platform. The Initial Developer is Pentaho Corporation.
*
* Software distributed under the Mozilla Public License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
* the license for the specific language governing your rights and limitations.
*
* @created Jun 17, 2005
* @author James Dixon
* @author Marc Batchelor
*/
package org.pentaho.core.util;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.math.BigDecimal;
import java.net.MalformedURLException;
import java.net.URL;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;
import javax.xml.transform.TransformerException;
import javax.xml.transform.URIResolver;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.Node;
import org.pentaho.core.session.IPentahoSession;
import org.pentaho.core.system.PentahoSystem;
import org.pentaho.messages.Messages;
import org.pentaho.messages.util.LocaleHelper;
import org.pentaho.repository.PentahoEntityResolver;
import org.pentaho.util.PentahoChainedException;
import org.pentaho.util.logging.Logger;
import org.xml.sax.EntityResolver;
/**
* A set of static methods for performing various operations on DOM Documents
* and XML text (in the form of streams, Strings, and files). The operations include
* creating DOM Documents (dom4j)
* transforming DOM Documents
* creating XML from Objects, Lists and Maps
* creating Lists or Maps from XML
* getting an XML node's text
*
* @author mbatchel/jdixon
*
*/
public class XmlHelper extends CleanXmlHelper {
private static final String DEFAULT_XSL_FOLDER = "system/custom/xsl/"; //$NON-NLS-1$
private static final Log logger = LogFactory.getLog(XmlHelper.class);
private static final EntityResolver entityResolver = new PentahoEntityResolver();
/**
* Should never be called.
*
*/
private XmlHelper() {
}
/**
* Create a <code>Document</code> from <code>str</code>.
*
* @param str String containing the XML that will be used to create the Document
* @return <code>Document</code> initialized with the xml in <code>strXml</code>.
*/
public static Document getDocFromString(String strXml) {
Document doc = null;
try {
doc = CleanXmlHelper.getDocFromString(strXml, entityResolver);
} catch (DocumentException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0014_FAILED_TO_PARSE_XML_DOCUMENT", //$NON-NLS-1$
strXml), e);
doc = null;
}
return doc;
}
/**
* Create a <code>Document</code> from the contents of the input file
* <code>file</code>.
*
* @param file <code>File</code> usd to create the input stream that will be
* used to create the <code>Document</code>
* @return <code>Document</code> containing the contents of the file f.
*/
public static Document getDocFromFile(File file) {
Document document = null;
try {
document = CleanXmlHelper.getDocFromFile(file, entityResolver);
} catch (IOException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0013_FAILED_TO_CREATE_FILEINPUTSTREAM", //$NON-NLS-1$
file.getPath()), e);
} catch (DocumentException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0014_FAILED_TO_PARSE_XML_DOCUMENT", //$NON-NLS-1$
file.getPath()), e);
}
return document;
}
/**
* Use the transform specified by xslName and xslPath, and transform the document specified
* by document, and return the resulting document.
*
* @param xslName String containing the path in the repository of the file containing the xsl transform
* @param document Document containing the document to be transformed
* @param params Map of properties to set on the transform
* @param session IPentahoSession containing a URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform. Null if there was an error.
* @throws TransformerException If attempt to transform the document fails.
*/
public static final StringBuffer transformXml(String xslName, String xslPath, Document document, Map params,
IPentahoSession session) throws TransformerException {
InputStream inStrm = null;
try {
String xml = document.asXML();
String encoding = XmlHelper.getEncoding(xml);
inStrm = new ByteArrayInputStream(xml.getBytes(encoding));
} catch (UnsupportedEncodingException e) {
if (logger.isErrorEnabled()) {
logger.error(e);
}
}
StringBuffer result = transformXml(xslName, xslPath, inStrm, params, session);
CleanXmlHelper.closeInputStream(inStrm);
return result;
}
/**
* Not currently used.
*
* Use the transform specified by xslName and transform the document specified
* by document, and return the resulting document.
*
* @param xslName String containing the path in the repository of the file containing the xsl transform
* @param document Document containing the document to be transformed
* @param params Map of properties to set on the transform
* @param session IPentahoSession containing a URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform. Null if there was an error.
* @throws TransformerException If attempt to transform the document fails.
*/
public static final StringBuffer transformXml(String xslName, Document document, Map params, IPentahoSession session)
throws TransformerException {
return transformXml(xslName, null, document, params, session);
}
/**
* Not currently used.
*
* Use the transform specified by xslName and xslPath,and transform the document specified
* by uri, and return the resulting document.
*
* @param xslName String containing the name of a file in the repository containing the xsl transform
* @param xslPath String containing the path to the file identifyied by <code>xslName</code>
* @param uri String containing the URI of a resource containing the document to be transformed
* @param params Map of properties to set on the transform
* @param session IPentahoSession containing a URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform. Null if there was an error.
* @throws TransformerException If attempt to transform the document fails.
*/
public static final StringBuffer transformXmlUrl(String xslName, String xslPath, String uri, Map params,
IPentahoSession session) throws TransformerException {
URL url = null;
try {
url = new URL(uri);
} catch (MalformedURLException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0007_TRANSFORM_XML_URL", e.getMessage(), xslName), e); //$NON-NLS-1$
return null;
}
InputStream inStrm = null;
try {
inStrm = url.openStream();
} catch (IOException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0007_TRANSFORM_XML_URL", e.getMessage(), xslName), e); //$NON-NLS-1$
return null;
}
return transformXml(xslName, xslPath, inStrm, params, session);
}
/**
* Use the transform specified by xslName and transform the document specified
* by docInStrm, and return the resulting document.
*
* @param xslName String containing the name of a file in the repository containing the xsl transform
* @param xslPath String containing the path to the file identifyied by <code>xslName</code>
* @param uri String containing the URI of a resource containing the document to be transformed
* @param params Map of properties to set on the transform
* @param session IPentahoSession containing a URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform. Null if there was an error.
* @throws TransformerException If attempt to transform the document fails.
*/
public static final StringBuffer transformXml(String xslName, String xslPath, String strDocument, Map params,
IPentahoSession session) throws TransformerException {
InputStream inStrm = null;
try {
String encoding = XmlHelper.getEncoding(strDocument);
inStrm = new ByteArrayInputStream(strDocument.getBytes(encoding));
} catch (UnsupportedEncodingException e) {
if (logger.isErrorEnabled()) {
logger.error(e);
}
}
StringBuffer result = transformXml(xslName, xslPath, inStrm, params, session);
CleanXmlHelper.closeInputStream(inStrm);
return result;
}
/**
* Use the transform specified by xslPath and xslName and transform the document specified
* by docInStrm, and return the resulting document.
*
* @param xslSrc StreamSrc containing the xsl transform
* @param docSrc StreamSrc containing the document to be transformed
* @param params Map of properties to set on the transform
* @param session IPentahoSession containing a URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform. Null if there was an error.
* @throws TransformerException If attempt to transform the document fails.
*/
public static final StringBuffer transformXml(String xslName, String xslPath, InputStream docInStrm, Map params,
IPentahoSession session) throws TransformerException {
StringBuffer result = null;
File localeXsl = getLocalizedXsl(xslPath, xslName);
if (null == localeXsl) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString("XmlHelper.ERROR_0003_NULL_XSL_SOURCE")); //$NON-NLS-1$
} else if (null == docInStrm) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString("XmlHelper.ERROR_0004_NULL_DOCUMENT")); //$NON-NLS-1$
} else {
FileInputStream xslInStrm = null;
try {
xslInStrm = new FileInputStream(localeXsl);
} catch (FileNotFoundException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0013_FAILED_TO_CREATE_FILEINPUTSTREAM", e.getMessage(), xslName), e); //$NON-NLS-1$
}
// at this point, we have both of our InputStreams
// Add encoding for any xsl that may set/use it
if (params == null) {
params = new HashMap();
}
params.put("output-encoding", LocaleHelper.getSystemEncoding()); //$NON-NLS-1$
URIResolver resolver = new SolutionURIResolver(session);
try {
result = CleanXmlHelper.transformXml(xslInStrm, docInStrm, params, resolver);
} catch (TransformerException e) {
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0006_TRANSFORM_XML_ERROR", e.getMessage(), xslName), e); //$NON-NLS-1$
throw e;
} finally {
CleanXmlHelper.closeInputStream(xslInStrm);
}
}
return result;
}
/**
* Find the character encoding specification in the xml String. If it exists, return
* the character encoding. Otherwise, return the system encoding.
*
* @param xml String containing the xml
* @return String containing the character encoding in the xml processing instruction
* if it exists, else the system encoding.
*/
public static String getEncoding(String xml) {
String enc = CleanXmlHelper.getEncoding(xml);
return null != enc ? enc : LocaleHelper.getSystemEncoding();
}
/*
TODO sbarkdull, delete this, these methods exist in the SolutionRepository
public static ResourceBundle getBundle(String baseName, File localeDir, Locale locale) {
try {
URL localeDirUrl = localeDir.getParentFile().toURL();
URLClassLoader loader = new URLClassLoader(new URL[] { localeDirUrl });
ResourceBundle bundle = ResourceBundle.getBundle(baseName, locale, loader);
return bundle;
} catch (Exception e) {
Logger.error("XmlHelper", Messages.getErrorString("XmlHelper.ERROR_0012_COULD_NOT_READ_PROPERTIES", localeDir.getAbsolutePath() + File.separator + baseName), e); //$NON-NLS-1$ //$NON-NLS-2$
}
return null;
}
// TODO sbarkdull, the caller of this method has no way of knowing if it succeeded or failed, needs
// to be fixed, should throw exception when something fails so caller knows of failure
// code is not currently used
public static void localizeDoc(Node document, File file, Locale locale, boolean xmlEncode) {
String fileName = file.getName();
int dotIndex = fileName.indexOf('.');
String baseName = fileName.substring(0, dotIndex);
ResourceBundle bundle = null;
bundle = getBundle(baseName, file, locale);
if (bundle == null) {
return;
}
localizeDoc(document, bundle, locale, file.getAbsolutePath(), xmlEncode);
}
// TODO sbarkdull, this code is duplicated in LocaleHelper
// public static String getXmlEncodedString(String rawValue) {
// return CleanXmlHelper.getXmlEncodedString( rawValue );
// }
public static void localizeDoc(Node document, ResourceBundle bundle, Locale locale, String bundlePath, boolean xmlEncode) {
if (bundle == null) {
return;
}
try {
List nodes = document.selectNodes("descendant::*"); //$NON-NLS-1$
Iterator nodeIterator = nodes.iterator();
while (nodeIterator.hasNext()) {
Node node = (Node) nodeIterator.next();
String name = node.getText();
if (name.startsWith("%") && !node.getPath().endsWith("/text()")) { //$NON-NLS-1$ //$NON-NLS-2$
try {
if (bundle != null) {
String localeText = bundle.getString(name.substring(1));
if (localeText != null) {
if (xmlEncode) {
node.setText(CleanXmlHelper.getXmlEncodedString(localeText));
} else {
node.setText(localeText);
}
}
}
} catch (Exception e) {
Logger.warn("XmlHelper", Messages.getString("XmlHelper.WARN_MISSING_RESOURCE_PROPERTY", name.substring(1), bundlePath, locale.toString())); //$NON-NLS-1$ //$NON-NLS-2$
}
}
}
} catch (Exception e) {
Logger.error("XmlHelper", Messages.getErrorString("XmlHelper.ERROR_0012_COULD_NOT_READ_PROPERTIES", bundlePath), e); //$NON-NLS-1$ //$NON-NLS-2$
}
}
*/
public static File getLocalizedFile(String fullPath, Locale locale) {
String language = locale.getLanguage();
String country = locale.getCountry();
String variant = locale.getVariant();
File file = new File(fullPath);
String fileName = file.getName();
int dotIndex = fileName.indexOf('.');
String baseName = dotIndex == -1 ? fileName : fileName.substring(0, dotIndex); // These two lines fix an index out of bounds
String extension = dotIndex == -1 ? "" : fileName.substring(dotIndex); // Exception that occurs when a filename has no extension //$NON-NLS-1$
File directory = file.getParentFile();
File localeFile = null;
if (!variant.equals("")) { //$NON-NLS-1$
localeFile = new File(directory, baseName + "_" + language + "_" + country + "_" + variant + extension); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
if (localeFile == null || !localeFile.exists()) {
localeFile = new File(directory, baseName + "_" + language + "_" + country + extension); //$NON-NLS-1$//$NON-NLS-2$
}
if (!localeFile.exists()) {
localeFile = new File(directory, baseName + "_" + language + extension); //$NON-NLS-1$
}
if (!localeFile.exists()) {
localeFile = new File(directory, baseName + extension);
}
if (localeFile.exists()) {
return localeFile;
} else {
return null;
}
}
/**
* Get the File object corresponding to the path, filename (xslName), and
* locale. The path is relative to the solution path.
*
* @param path
* @param xslName
* @return
*/
public static final File getLocalizedXsl(String path, String xslName) {
String fullPath = null;
File file = null;
if (null != path) {
// try to find it on the specified path
fullPath = PentahoSystem.getApplicationContext().getSolutionPath(path + File.separator + xslName).replace('\\',
'/');
file = getLocalizedFile(fullPath, LocaleHelper.getLocale());
}
if (null == file) {
// didn't find the file, let's try default path
fullPath = PentahoSystem.getApplicationContext().getSolutionPath(DEFAULT_XSL_FOLDER + xslName).replace('\\', '/');
file = getLocalizedFile(fullPath, LocaleHelper.getLocale());
}
if (null == file) {
// we should not get this far...
Logger.error(XmlHelper.class.getName(), Messages.getErrorString(
"XmlHelper.ERROR_0011_TRANSFORM_XSL_DOES_NOT_EXIST", fullPath)); //$NON-NLS-1$
}
return file;
}
public static Document getDomFromResource(String path) {
String fullPath = PentahoSystem.getApplicationContext().getSolutionPath(path);
File f = new File(fullPath);
return getDocFromFile(f);
}
public static String getContentFromResource(String fullPath) {
Document doc = getDomFromResource(fullPath);
return doc.asXML();
}
public static String getContentFromSolutionResource(String path) {
return getContentFromResource(path);
}
/*
* The following methods converts lists/maps to/from XML. author: mbatchelor
*/
public static String listToXML(List l) throws UnsupportedOperationException {
return listToXML(l, ""); //$NON-NLS-1$
}
public static String listToXML(List l, String indent) throws UnsupportedOperationException {
StringBuffer sb = new StringBuffer();
sb.append(indent).append("<list>\r"); //$NON-NLS-1$
String newIndent = indent + " "; //$NON-NLS-1$
Object obj;
for (int i = 0; i < l.size(); i++) {
obj = l.get(i);
sb.append(newIndent).append("<list-element>\r"); //$NON-NLS-1$
objToXML(obj, sb, newIndent);
sb.append(newIndent).append("</list-element>\r"); //$NON-NLS-1$
}
sb.append(indent).append("</list>\r"); //$NON-NLS-1$
return sb.toString();
}
public static String mapToXML(Map m) throws UnsupportedOperationException {
return mapToXML(m, ""); //$NON-NLS-1$
}
public static String mapToXML(Map mp, String indent) throws UnsupportedOperationException {
StringBuffer sb = new StringBuffer();
sb.append(indent).append("<map>\r"); //$NON-NLS-1$
String newIndent = indent + " "; //$NON-NLS-1$
Iterator it = mp.entrySet().iterator();
Map.Entry ent;
Object obj;
while (it.hasNext()) {
ent = (Map.Entry) it.next();
if (!(ent.getKey() instanceof String)) {
throw new UnsupportedOperationException(Messages.getErrorString("XMLUTL.ERROR_0011_MAP_KEYS")); //$NON-NLS-1$
}
sb.append(newIndent).append("<map-entry>\r"); //$NON-NLS-1$
sb.append(newIndent).append("<key>\r"); //$NON-NLS-1$
sb.append(newIndent).append("<![CDATA[").append(ent.getKey().toString()).append("]]>\r"); //$NON-NLS-1$ //$NON-NLS-2$
sb.append(newIndent).append("</key>\r"); //$NON-NLS-1$
obj = ent.getValue();
objToXML(obj, sb, newIndent);
sb.append(newIndent).append("</map-entry>\r"); //$NON-NLS-1$
}
sb.append(indent).append("</map>\r"); //$NON-NLS-1$
return sb.toString();
}
private static void objToXML(Object obj, StringBuffer sb, String newIndent) {
if (obj instanceof String) {
sb.append(newIndent).append("<string-value>\r"); //$NON-NLS-1$
sb.append(newIndent).append("<![CDATA[").append((String) obj).append("]]>\r"); //$NON-NLS-1$ //$NON-NLS-2$
sb.append(newIndent).append("</string-value>\r"); //$NON-NLS-1$
} else if (obj instanceof StringBuffer) {
sb.append(newIndent).append("<stringbuffer-value>\r"); //$NON-NLS-1$
sb.append(newIndent).append("<![CDATA[").append(obj.toString()).append("]]>\r"); //$NON-NLS-1$ //$NON-NLS-2$
sb.append(newIndent).append("</stringbuffer-value>\r"); //$NON-NLS-1$
} else if (obj instanceof BigDecimal) {
sb.append(newIndent).append("<bigdecimal-value>").append(obj.toString()).append("</bigdecimal-value>\r"); //$NON-NLS-1$ //$NON-NLS-2$
} else if (obj instanceof Date) {
SimpleDateFormat fmt = new SimpleDateFormat();
fmt.setTimeZone(TimeZone.getTimeZone("GMT")); //$NON-NLS-1$
sb.append(newIndent).append("<date-value>"); //$NON-NLS-1$
sb.append(fmt.format((Date) obj)).append("</date-value>\r"); //$NON-NLS-1$
} else if (obj instanceof Long) {
sb.append(newIndent).append("<long-value>"); //$NON-NLS-1$
sb.append(obj.toString()).append("</long-value>\r"); //$NON-NLS-1$
} else if (obj instanceof Map) {
sb.append(newIndent).append("<map-value>\r"); //$NON-NLS-1$
sb.append(mapToXML((Map) obj, newIndent));
sb.append(newIndent).append("</map-value>\r"); //$NON-NLS-1$
} else if (obj instanceof List) {
sb.append(newIndent).append("<list-value>\r"); //$NON-NLS-1$
sb.append(listToXML((List) obj, newIndent));
sb.append(newIndent).append("</list-value>\r"); //$NON-NLS-1$
} else {
throw new UnsupportedOperationException(Messages.getErrorString(
"XMLUTL.ERROR_0012_DATA_TYPE", obj.getClass().getName())); //$NON-NLS-1$
}
}
public static List xmlToList(String s) throws PentahoChainedException {
try {
Document doc = XmlHelper.getDocFromString(s);
Element root = doc.getRootElement();
return processList(root);
} catch (ParseException pex) {
throw new PentahoChainedException(Messages.getErrorString("XMLUTL.ERROR_0013_PARSING"), pex); //$NON-NLS-1$
}
}
public static Map xmlToMap(String s) throws PentahoChainedException {
try {
Document doc = XmlHelper.getDocFromString(s);
Element root = doc.getRootElement();
return processMap(root);
} catch (ParseException pex) {
throw new PentahoChainedException(Messages.getErrorString("XMLUTL.ERROR_0013_PARSING"), pex); //$NON-NLS-1$
}
}
public static List processList(Element ele) throws ParseException {
List rtn = new ArrayList();
Iterator it = ele.elementIterator();
Element anElement;
while (it.hasNext()) {
anElement = (Element) it.next();
processListElement(anElement, rtn);
}
return rtn;
}
public static Map processMap(Element ele) throws ParseException {
Map rtn = new HashMap();
Iterator it = ele.elementIterator();
Element anElement;
while (it.hasNext()) {
anElement = (Element) it.next();
processMapElement(anElement, rtn);
}
return rtn;
}
public static Object elementToObject(Element anElement) throws ParseException {
if (anElement.getName().equals("string-value")) { //$NON-NLS-1$
return anElement.getTextTrim();
} else if (anElement.getName().equals("stringbuffer-value")) { //$NON-NLS-1$
return new StringBuffer(anElement.getTextTrim());
} else if (anElement.getName().equals("bigdecimal-value")) { //$NON-NLS-1$
return new BigDecimal(anElement.getTextTrim());
} else if (anElement.getName().equals("long-value")) { //$NON-NLS-1$
return new Long(anElement.getTextTrim());
} else if (anElement.getName().equals("date-value")) { //$NON-NLS-1$
SimpleDateFormat fmt = new SimpleDateFormat();
fmt.setTimeZone(TimeZone.getTimeZone("GMT")); //$NON-NLS-1$
return fmt.parse(anElement.getTextTrim());
} else if (anElement.getName().equals("list-value")) { //$NON-NLS-1$
return processList(anElement.element("list")); //$NON-NLS-1$
} else if (anElement.getName().equals("map-value")) { //$NON-NLS-1$
return processMap(anElement.element("map")); //$NON-NLS-1$
} else {
throw new ParseException(Messages.getErrorString("XMLUTL.ERROR_0014_UNKNOWN_TYPE", anElement.getName()), 0); //$NON-NLS-1$
}
}
public static void processListElement(Element ele, List rtn) throws ParseException {
Iterator it = ele.elementIterator();
Element anElement;
while (it.hasNext()) {
anElement = (Element) it.next();
Object anObj = elementToObject(anElement);
rtn.add(anObj);
}
}
public static void processMapElement(Element ele, Map rtn) throws ParseException {
Iterator it = ele.elementIterator();
Element keyElement = null;
Element valueElement = null;
Element anElement = null;
while (it.hasNext()) {
anElement = (Element) it.next();
if (anElement.getName().equals("key")) { //$NON-NLS-1$
keyElement = anElement;
} else {
valueElement = anElement;
}
}
// Now, we have our key and our value. Let's figure out what kind of
// processing is required.
Object anObj = elementToObject(valueElement);
rtn.put(keyElement.getTextTrim(), anObj);
}
// TODO sbarkdull begin, these methods could be moved to CleanXmlHelper
public static String getNodeText(String xpath, Node rootNode) {
return (getNodeText(xpath, rootNode, null));
}
public static long getNodeText(String xpath, Node rootNode, long defaultValue) {
String valueStr = getNodeText(xpath, rootNode, Long.toString(defaultValue));
try {
return Long.parseLong(valueStr);
} catch (NumberFormatException e) {
logger.error(e.getLocalizedMessage(), e);
}
return defaultValue;
}
public static double getNodeText(String xpath, Node rootNode, double defaultValue) {
String valueStr = getNodeText(xpath, rootNode, null);
if (valueStr == null) {
return defaultValue;
}
try {
return Double.parseDouble(valueStr);
} catch (NumberFormatException e) {
logger.error(e.getLocalizedMessage(), e);
}
return defaultValue;
}
public static String getNodeText(String xpath, Node rootNode, String defaultValue) {
if (rootNode == null) {
return (defaultValue);
}
Node node = rootNode.selectSingleNode(xpath);
if (node == null) {
return defaultValue;
}
return node.getText();
}
public static void decode(String[] strings) {
if (strings != null) {
for (int i = 0; i < strings.length; ++i) {
strings[i] = decode(strings[i]);
}
}
}
public static String decode(String string) {
// TODO replace this is a more robust encoder
if (string != null) {
string = string.replaceAll("<", "<") //$NON-NLS-1$ //$NON-NLS-2$
.replaceAll(">", ">") //$NON-NLS-1$ //$NON-NLS-2$
.replaceAll("'", "'") //$NON-NLS-1$ //$NON-NLS-2$
.replaceAll(""", "\"") //$NON-NLS-1$ //$NON-NLS-2$
.replaceAll("&", "&"); //$NON-NLS-1$ //$NON-NLS-2$ // DO THE & LAST!!!!
}
return string;
}
public static void encode(String[] strings) {
if (strings != null) {
for (int i = 0; i < strings.length; ++i) {
strings[i] = encode(strings[i]);
}
}
}
public static String encode(String string) {
return StringEscapeUtils.escapeXml( string );
}
// TODO sbarkdull end, some of these preceeding methods could be moved to CleanXmlHelper
}
The table below shows all metrics for XmlHelper.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 108.00 | Number of blocks | |
| BLOCK_COMMENT | 95.00 | Number of block comment lines | |
| COMMENTS | 217.00 | Comment lines | |
| COMMENT_DENSITY | 0.59 | Comment density | |
| COMPARISONS | 42.00 | Number of comparison operators | |
| CYCLOMATIC | 94.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 16.00 | Comments in declarations | |
| DOC_COMMENT | 112.00 | Number of javadoc comment lines | |
| ELOC | 366.00 | Effective lines of code | |
| EXEC_COMMENTS | 7.00 | Comments in executable code | |
| EXITS | 87.00 | Procedure exits | |
| FUNCTIONS | 34.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 75.11 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 136.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 6.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 4.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 23.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 6.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 6.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 6.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 5.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 1.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 722.00 | Number of lines in the source file | |
| LINE_COMMENT | 10.00 | Number of line comments | |
| LOC | 443.00 | Lines of code | |
| LOGICAL_LINES | 241.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 1322.00 | Number of operands | |
| OPERATORS | 2228.00 | Number of operators | |
| PARAMS | 67.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3550.00 | Halstead program length | |
| PROGRAM_VOCAB | 441.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 69.00 | Number of return points from functions | |
| SIZE | 28942.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 396.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 45.00 | Number of unique operators | |
| WHITESPACE | 62.00 | Number of whitespace lines | |