ChartHelper.java
| Index Score | ||
|---|---|---|
 |
 |
org.pentaho.ui |
 |
 |
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 | |
|---|---|---|
| SIZE | Size of the file in bytes |  |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| OPERANDS | Number of operands | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| PROGRAM_LENGTH | Halstead program length | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| EXITS | Procedure exits | |
| ELOC | Effective lines of code | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| LOC | Lines of code | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| LINES | Number of lines in the source file | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0006 | JAVA0006 Empty finally block | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| EXEC_COMMENTS | Comments in executable code | |
| PROGRAM_VOLUME | Halstead program volume | |
| BLOCKS | Number of blocks | |
| COMPARISONS | Number of comparison operators | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| RETURNS | Number of return points from functions | |
| FUNCTIONS | Number of function declarations | |
| LOOPS | Number of loops | |
| DECL_COMMENTS | Comments in declarations | |
| 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 Apr 17, 2006
* @author James Dixon
*/
package org.pentaho.ui;
import java.io.File;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.StringTokenizer;
import org.dom4j.Document;
import org.dom4j.Node;
import org.pentaho.commons.connection.DataUtilities;
import org.pentaho.commons.connection.IPentahoConnection;
import org.pentaho.commons.connection.IPentahoResultSet;
import org.pentaho.core.runtime.IRuntimeContext;
import org.pentaho.core.services.BaseRequestHandler;
import org.pentaho.core.session.IPentahoSession;
import org.pentaho.core.solution.ActionResource;
import org.pentaho.core.solution.HttpRequestParameterProvider;
import org.pentaho.core.solution.IActionResource;
import org.pentaho.core.solution.IParameterProvider;
import org.pentaho.core.solution.SimpleOutputHandler;
import org.pentaho.core.system.PentahoSystem;
import org.pentaho.core.ui.SimpleUrlFactory;
import org.pentaho.core.util.TemplateUtil;
import org.pentaho.core.util.UIUtil;
import org.pentaho.data.connection.sql.SQLConnection;
import org.pentaho.messages.Messages;
import org.pentaho.messages.util.LocaleHelper;
import org.pentaho.plugin.jfreechart.ChartDefinition;
import org.pentaho.plugin.jfreechart.JFreeChartEngine;
import org.pentaho.ui.component.DashboardWidgetComponent;
import org.pentaho.ui.component.charting.AbstractChartComponent;
import org.pentaho.ui.component.charting.AbstractJFreeChartComponent;
import org.pentaho.ui.component.charting.CategoryDatasetChartComponent;
import org.pentaho.ui.component.charting.DialChartComponent;
import org.pentaho.ui.component.charting.PieDatasetChartComponent;
import org.pentaho.ui.component.charting.TimeSeriesCollectionChartComponent;
import org.pentaho.ui.component.charting.XYSeriesCollectionChartComponent;
import org.pentaho.ui.component.charting.XYZSeriesCollectionChartComponent;
import org.pentaho.util.logging.ILogger;
/**
* This class provides wrapper functions to make it easier to execute action
* sequences and generate a widget.
*/
public class ChartHelper {
/**
* doChart generates the images and html necessary to render various charts within a web page.
*
* @param solutionName the solution name
* @param actionPath the action path
* @param chartName the xml file describing the chart
* @param parameterProvider the collection of parameters to customize the chart
* @param outputStream the output string buffer for the content
* @param userSession the user session object
* @param messages a collection to store error and logging messages
* @param logger logging object
*
* @return true if successful
*/
public static boolean doChart(String solutionName, String actionPath, String chartName,
IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages,
ILogger logger) {
boolean result = true;
String content = null;
StringBuffer messageBuffer = new StringBuffer();
if (logger == null) {
// No logger? The usersession extends ILogger, use it for logging
logger = userSession;
}
// Retrieve all parameters from parameter provider
String outerParams = parameterProvider.getStringParameter("outer-params", null); //$NON-NLS-1$
String innerParam = parameterProvider.getStringParameter("inner-param", null); //$NON-NLS-1$
String urlDrillTemplate = parameterProvider.getStringParameter("drill-url", null); //$NON-NLS-1$
String imageUrl = parameterProvider.getStringParameter("image-url", null); //$NON-NLS-1$
// Very likely null; allow API users to continue to pass the dial value via parameters
String dialValue = parameterProvider.getStringParameter("value", null); //$NON-NLS-1$
if (imageUrl == null) {
imageUrl = PentahoSystem.getApplicationContext().getBaseUrl();
}
if (urlDrillTemplate == null) {
urlDrillTemplate = ""; //$NON-NLS-1$
}
int width = (int) parameterProvider.getLongParameter("image-width", 150); //$NON-NLS-1$
int height = (int) parameterProvider.getLongParameter("image-height", 150); //$NON-NLS-1$
SimpleUrlFactory urlFactory = new SimpleUrlFactory(urlDrillTemplate);
// Determine the type of chart we are building; these values can come from the chart xml definition, or
// from the parameter provider. Try the parameter provider first, for performance reasons.
String chartTypeStr = parameterProvider.getStringParameter(ChartDefinition.TYPE_NODE_NAME, null);
String datasetType = ChartDefinition.CATAGORY_DATASET_STR;
String definitionPath = solutionName + File.separator + actionPath + File.separator + chartName;
if ((chartTypeStr == null) || (chartTypeStr.length() == 0)) {
// load the XML document that defines the chart
ActionResource resource = new ActionResource(chartName, IActionResource.SOLUTION_FILE_RESOURCE, "text/xml", //$NON-NLS-1$
definitionPath);
try {
// attempt to get the chart type and possibly data type from the xml doc
Document chartDefinition = AbstractJFreeChartComponent.getResourceAsDocument(userSession, resource);
Node chartAttributes = chartDefinition.selectSingleNode("//" + AbstractChartComponent.CHART_NODE_NAME); //$NON-NLS-1$
chartTypeStr = chartAttributes.selectSingleNode(ChartDefinition.TYPE_NODE_NAME).getText();
Node datasetTypeNode = chartAttributes.selectSingleNode(ChartDefinition.DATASET_TYPE_NODE_NAME);
if (datasetTypeNode != null) {
datasetType = datasetTypeNode.getText();
}
} catch (Exception e) {
logger.error(Messages.getErrorString("ChartHelper.ERROR_0001_IO_PROBLEM_GETTING_CHART_TYPE"), e); //$NON-NLS-1$
UIUtil
.formatErrorMessage(
"text/html", Messages.getString("ChartHelper.ERROR_0001_IO_PROBLEM_GETTING_CHART_TYPE"), messages, messageBuffer); //$NON-NLS-1$ //$NON-NLS-2$
content = messageBuffer.toString();
result = false;
}
}
// Check again - do we have a chart type now? If not, bail out, we have no idea what to try to generate
if ((chartTypeStr == null) || (chartTypeStr.length() == 0)) {
logger.error(Messages.getString("ChartHelper.ERROR_0002_COULD_NOT_DETERMINE_CHART_TYPE")); //$NON-NLS-1$
UIUtil
.formatErrorMessage(
"text/html", Messages.getString("ChartHelper.ERROR_0002_COULD_NOT_DETERMINE_CHART_TYPE"), messages, messageBuffer); //$NON-NLS-1$ //$NON-NLS-2$
content = messageBuffer.toString();
result = false;
}
if (!result) {
outputStream.append(content);
return result;
}
int chartType = JFreeChartEngine.getChartType(chartTypeStr);
AbstractJFreeChartComponent chartComponent = null;
try {
// Some charts are determined by the dataset that is passed in; check these first...
if (datasetType.equalsIgnoreCase(ChartDefinition.TIME_SERIES_COLLECTION_STR)) {
chartComponent = new TimeSeriesCollectionChartComponent(chartType, definitionPath, width, height, urlFactory,
messages);
} else if (datasetType.equalsIgnoreCase(ChartDefinition.XY_SERIES_COLLECTION_STR)) {
chartComponent = new XYSeriesCollectionChartComponent(chartType, definitionPath, width, height, urlFactory,
messages);
} else if (datasetType.equalsIgnoreCase(ChartDefinition.XYZ_SERIES_COLLECTION_STR)) {
chartComponent = new XYZSeriesCollectionChartComponent(chartType, definitionPath, width, height, urlFactory,
messages);
}
// Didn't find a dataset, so try to create the component based on chart type.
if (chartComponent == null) {
switch (chartType) {
case JFreeChartEngine.BAR_CHART_TYPE:
case JFreeChartEngine.AREA_CHART_TYPE:
case JFreeChartEngine.BAR_LINE_CHART_TYPE:
case JFreeChartEngine.LINE_CHART_TYPE:
case JFreeChartEngine.DIFFERENCE_CHART_TYPE:
case JFreeChartEngine.DOT_CHART_TYPE:
case JFreeChartEngine.STEP_AREA_CHART_TYPE:
case JFreeChartEngine.STEP_CHART_TYPE:
case JFreeChartEngine.PIE_GRID_CHART_TYPE:
chartComponent = new CategoryDatasetChartComponent(chartType, definitionPath, width, height, urlFactory,
messages);
break;
case JFreeChartEngine.PIE_CHART_TYPE:
chartComponent = new PieDatasetChartComponent(chartType, definitionPath, width, height, urlFactory,
messages);
break;
case JFreeChartEngine.DIAL_CHART_TYPE:
chartComponent = new DialChartComponent(chartType, definitionPath, width, height, urlFactory, messages);
if (dialValue != null) {
Number numericDialValue = DataUtilities.toNumber(dialValue, LocaleHelper
.getCurrencyFormat(), LocaleHelper.getNumberFormat());
((DialChartComponent) chartComponent).setValue(numericDialValue.doubleValue());
}
break;
case JFreeChartEngine.BUBBLE_CHART_TYPE:
chartComponent = new XYZSeriesCollectionChartComponent(chartType, definitionPath, width, height,
urlFactory, messages);
break;
case JFreeChartEngine.UNDEFINED_CHART_TYPE:
default:
// Unsupported chart type, bail out
logger.error(Messages.getString(
"ChartHelper.ERROR_0003_INVALID_CHART_TYPE", chartTypeStr, Integer.toString(chartType))); //$NON-NLS-1$
UIUtil.formatErrorMessage("text/html", Messages.getString("ChartHelper.ERROR_0003_INVALID_CHART_TYPE", //$NON-NLS-1$ //$NON-NLS-2$
chartTypeStr, Integer.toString(chartType)), messages, messageBuffer);
content = messageBuffer.toString();
result = false;
}
}
if (result && (chartComponent != null)) {
try {
chartComponent.setLoggingLevel(logger.getLoggingLevel());
chartComponent.validate(userSession, null);
chartComponent.setDataAction(definitionPath);
chartComponent.setUrlTemplate(urlDrillTemplate);
String seriesName = parameterProvider.getStringParameter("series-name", null); //$NON-NLS-1$
if (chartComponent instanceof CategoryDatasetChartComponent) {
((CategoryDatasetChartComponent) chartComponent).setSeriesName(seriesName);
}
// WARNING!!! This is an atypical way to access data for the chart... these parameters and their
// usage are undocumented, and only left in here to support older solutions that may be using them.
// *************** START QUESTIONABLE CODE ********************************************************
String connectionName = parameterProvider.getStringParameter("connection", null); //$NON-NLS-1$
String query = parameterProvider.getStringParameter("query", null); //$NON-NLS-1$
String dataAction = parameterProvider.getStringParameter("data-process", null); //$NON-NLS-1$
IPentahoConnection connection = null;
try {
chartComponent.setParamName(innerParam);
chartComponent.setParameterProvider(HttpRequestParameterProvider.SCOPE_REQUEST, parameterProvider);
if (connectionName != null && query != null) {
connection = new SQLConnection(connectionName, logger);
try {
query = TemplateUtil.applyTemplate(query, TemplateUtil.parametersToProperties(parameterProvider), null);
IPentahoResultSet results = connection.executeQuery(query);
chartComponent.setValues(results);
} finally {
}
chartComponent.setUrlTemplate(urlDrillTemplate);
if (outerParams != null) {
StringTokenizer tokenizer = new StringTokenizer(outerParams, ";"); //$NON-NLS-1$
while (tokenizer.hasMoreTokens()) {
chartComponent.addOuterParamName(tokenizer.nextToken());
}
}
} else if (dataAction != null) {
PentahoSystem.ActionInfo actionInfo = PentahoSystem.parseActionString(dataAction);
if (actionInfo != null) {
chartComponent.setDataAction(actionInfo.getSolutionName(), actionInfo.getPath(), actionInfo
.getActionName(), "rule-result"); //$NON-NLS-1$
}
}
// ***************** END QUESTIONABLE CODE ********************************************************
content = chartComponent.getContent("text/html"); //$NON-NLS-1$
} finally {
if (connection != null) {
connection.close();
}
}
} catch (Throwable e) {
logger.error(Messages.getErrorString("Widget.ERROR_0001_COULD_NOT_CREATE_WIDGET"), e); //$NON-NLS-1$
}
} // end of if(result)
try {
if (content == null) {
UIUtil
.formatErrorMessage(
"text/html", Messages.getErrorString("Widget.ERROR_0001_COULD_NOT_CREATE_WIDGET"), messages, messageBuffer); //$NON-NLS-1$ //$NON-NLS-2$
content = messageBuffer.toString();
result = false;
}
outputStream.append(content);
} catch (Exception e) {
logger.error(Messages.getErrorString("Widget.ERROR_0001_COULD_NOT_CREATE_WIDGET"), e); //$NON-NLS-1$
}
} finally {
if (chartComponent != null)
chartComponent.dispose();
}
return result;
}
/**
* doPieChart generates the images and html necessary to render pie charts.
* It provides a simple wrapper around the class
* org.pentaho.ui.component.charting.PieDatasetChartComponent
*
* @param solutionName the solution name
* @param actionPath the action path
* @param chartName the xml file describing the chart
* @param parameterProvider the collection of parameters to customize the chart
* @param outputStream the output string buffer for the content
* @param userSession the user session object
* @param messages a collection to store error and logging messages
* @param logger logging object
*
* @return true if successful
* @deprecated use doChart instead
*/
public static boolean doPieChart(String solutionName, String actionPath, String chartName,
IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages,
ILogger logger) {
boolean result = true;
String outerParams = parameterProvider.getStringParameter("outer-params", null); //$NON-NLS-1$
String innerParam = parameterProvider.getStringParameter("inner-param", null); //$NON-NLS-1$
String urlDrillTemplate = parameterProvider.getStringParameter("drill-url", null); //$NON-NLS-1$
String imageUrl = parameterProvider.getStringParameter("image-url", null); //$NON-NLS-1$
if (imageUrl == null) {
imageUrl = PentahoSystem.getApplicationContext().getBaseUrl();
}
if (urlDrillTemplate == null) {
urlDrillTemplate = ""; //$NON-NLS-1$
}
int width = (int) parameterProvider.getLongParameter("image-width", 150); //$NON-NLS-1$
int height = (int) parameterProvider.getLongParameter("image-height", 150); //$NON-NLS-1$
SimpleUrlFactory urlFactory = new SimpleUrlFactory(urlDrillTemplate);
PieDatasetChartComponent chartComponent = null;
try {
String chartDefinitionStr = solutionName + File.separator + actionPath + File.separator + chartName;
chartComponent = new PieDatasetChartComponent(JFreeChartEngine.PIE_CHART_TYPE, chartDefinitionStr, width, height,
urlFactory, messages);
if (logger != null) {
chartComponent.setLoggingLevel(logger.getLoggingLevel());
}
chartComponent.validate(userSession, null);
chartComponent.setUrlTemplate(urlDrillTemplate);
if (outerParams != null) {
StringTokenizer tokenizer = new StringTokenizer(outerParams, ";"); //$NON-NLS-1$
while (tokenizer.hasMoreTokens()) {
chartComponent.addOuterParamName(tokenizer.nextToken());
}
}
chartComponent.setParamName(innerParam);
chartComponent.setDataAction(chartDefinitionStr);
chartComponent.setParameterProvider(HttpRequestParameterProvider.SCOPE_REQUEST, parameterProvider);
String content = chartComponent.getContent("text/html"); //$NON-NLS-1$
if (content == null || content.equals("")) { //$NON-NLS-1$
content = " "; //$NON-NLS-1$
}
if (content == null) {
StringBuffer buffer = new StringBuffer();
UIUtil.formatErrorMessage(
"text/html", Messages.getString("Widget.ERROR_0001_COULD_NOT_CREATE_WIDGET"), messages, buffer); //$NON-NLS-1$ //$NON-NLS-2$
content = buffer.toString();
result = false;
}
outputStream.append(content);
} finally {
if (chartComponent != null)
chartComponent.dispose();
}
return result;
}
/**
* doDial generates the images and html necessary to render dials. It
* provides a simple wrapper around the class
* org.pentaho.ui.component.DashboardWidgetComponent
*
* @param solutionName the solution name
* @param actionPath the action path
* @param chartName the xml file describing the chart
* @param parameterProvider the collection of parameters to customize the chart
* @param outputStream the output string buffer for the content
* @param userSession the user session object
* @param messages a collection to store error and logging messages
* @param logger logging object
*
* @return true if successful
* @deprecated use doChart() instead
*/
public static boolean doDial(String solutionName, String actionPath, String chartName,
IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages,
ILogger logger) {
boolean result = true;
String linkUrl = parameterProvider.getStringParameter("drill-url", null); //$NON-NLS-1$
String imageUrl = parameterProvider.getStringParameter("image-url", null); //$NON-NLS-1$
if (imageUrl == null) {
imageUrl = PentahoSystem.getApplicationContext().getBaseUrl();
}
if (linkUrl == null) {
linkUrl = ""; //$NON-NLS-1$
}
int width = (int) parameterProvider.getLongParameter("image-width", 150); //$NON-NLS-1$
int height = (int) parameterProvider.getLongParameter("image-height", 150); //$NON-NLS-1$
SimpleUrlFactory urlFactory = new SimpleUrlFactory(linkUrl);
DashboardWidgetComponent widget = null;
try {
widget = new DashboardWidgetComponent(DashboardWidgetComponent.TYPE_DIAL, solutionName + File.separator
+ actionPath + File.separator + chartName, width, height, urlFactory, messages);
if (logger != null) {
widget.setLoggingLevel(logger.getLoggingLevel());
}
widget.validate(userSession, null);
widget.setParameterProvider(HttpRequestParameterProvider.SCOPE_REQUEST, parameterProvider);
String value = parameterProvider.getStringParameter("value", "0"); //$NON-NLS-1$//$NON-NLS-2$
Number numericValue = DataUtilities.toNumber(value, LocaleHelper.getCurrencyFormat(), LocaleHelper.getNumberFormat());
widget.setValue(numericValue.doubleValue());
String title = parameterProvider.getStringParameter("title", ""); //$NON-NLS-1$ //$NON-NLS-2$
widget.setTitle(title);
String content = widget.getContent("text/html"); //$NON-NLS-1$
if (content == null) {
StringBuffer buffer = new StringBuffer();
UIUtil.formatErrorMessage(
"text/html", Messages.getString("Widget.ERROR_0001_COULD_NOT_CREATE_WIDGET"), messages, buffer); //$NON-NLS-1$ //$NON-NLS-2$
content = buffer.toString();
result = false;
}
if (content == null || content.equals("")) { //$NON-NLS-1$
content = " "; //$NON-NLS-1$
}
outputStream.append(content);
} finally {
if (widget != null)
widget.dispose();
}
return result;
}
/**
* doAction executes an action within the bi platform and returns true if successful.
*
* @param solutionName the solution name
* @param actionPath the action path
* @param actionName the action name
* @param processId the process id
* @param parameterProvider the collection of parameters to customize the chart
* @param userSession the user session object
* @param messages a collection to store error and logging messages
* @param logger logging object
*
* @return the runtime context
*/
public static boolean doAction(String solutionName, String actionPath, String actionName, String processId,
IParameterProvider parameterProvider, OutputStream outputStream, IPentahoSession userSession, ArrayList messages,
ILogger logger) {
SimpleOutputHandler outputHandler = new SimpleOutputHandler(outputStream, false);
BaseRequestHandler requestHandler = new BaseRequestHandler(userSession, null, outputHandler, parameterProvider,
null);
requestHandler.setProcessId(processId);
requestHandler.setAction(actionPath, actionName);
requestHandler.setSolutionName(solutionName);
IRuntimeContext runtime = null;
int status = IRuntimeContext.RUNTIME_STATUS_FAILURE;
try {
runtime = requestHandler.handleActionRequest(0, 0);
if (runtime != null) {
status = runtime.getStatus();
}
} finally {
if (runtime != null) {
runtime.dispose();
}
}
return status == IRuntimeContext.RUNTIME_STATUS_SUCCESS;
}
/**
* doAction executes an action within the bi platform and returns the runtime context.
*
* @param solutionName the solution name
* @param actionPath the action path
* @param actionName the action name
* @param processId the process id
* @param parameterProvider the collection of parameters to customize the chart
* @param userSession the user session object
* @param messages a collection to store error and logging messages
* @param logger logging object
*
* @return the runtime context
*/
public static IRuntimeContext doAction(String solutionName, String actionPath, String actionName, String processId,
IParameterProvider parameterProvider, IPentahoSession userSession, ArrayList messages, ILogger logger) {
SimpleOutputHandler outputHandler = new SimpleOutputHandler((OutputStream) null, false);
BaseRequestHandler requestHandler = new BaseRequestHandler(userSession, null, outputHandler, parameterProvider,
null);
requestHandler.setProcessId(processId);
requestHandler.setAction(actionPath, actionName);
requestHandler.setSolutionName(solutionName);
IRuntimeContext runtime = null;
try {
runtime = requestHandler.handleActionRequest(0, 0);
} catch (Throwable t) {
}
return runtime;
}
}
The table below shows all metrics for ChartHelper.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 60.00 | Number of blocks | |
| BLOCK_COMMENT | 15.00 | Number of block comment lines | |
| COMMENTS | 110.00 | Comment lines | |
| COMMENT_DENSITY | 0.36 | Comment density | |
| COMPARISONS | 42.00 | Number of comparison operators | |
| CYCLOMATIC | 67.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 7.00 | Comments in declarations | |
| DOC_COMMENT | 80.00 | Number of javadoc comment lines | |
| ELOC | 308.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 57.00 | Procedure exits | |
| FUNCTIONS | 5.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 68.00 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 47.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 | 1.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 1.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 | 1.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 | 1.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 | 3.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 | 3.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 | 6.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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.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 | 1.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 | 0.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 | 0.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 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 5.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 | 0.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 | 4.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 2.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 4.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 3.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 | 0.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 | 0.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 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 2.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 554.00 | Number of lines in the source file | |
| LINE_COMMENT | 15.00 | Number of line comments | |
| LOC | 356.00 | Lines of code | |
| LOGICAL_LINES | 196.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 8.00 | Maximum nesting depth | |
| OPERANDS | 1045.00 | Number of operands | |
| OPERATORS | 1684.00 | Number of operators | |
| PARAMS | 41.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2729.00 | Halstead program length | |
| PROGRAM_VOCAB | 330.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 6.00 | Number of return points from functions | |
| SIZE | 24429.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 292.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 38.00 | Number of unique operators | |
| WHITESPACE | 88.00 | Number of whitespace lines | |