BIRTReportComponent.java
| Index Score | ||
|---|---|---|
 |
 |
org.pentaho.plugin.eclipsebirt |
 |
 |
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 | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| EXITS | Procedure exits | |
| SIZE | Size of the file in bytes | |
| NEST_DEPTH | Maximum nesting depth | |
| BLOCK_COMMENT | Number of block comment lines | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| BLOCKS | Number of blocks | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| ELOC | Effective lines of code | |
| LINES | Number of lines in the source file | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| COMMENTS | Comment lines | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOC | Lines of code | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| FUNCTIONS | Number of function declarations | |
| PARAMS | Number of formal parameter declarations | |
| LOOPS | Number of loops | |
| 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 Jul 25, 2005
* @author James Dixon
*/
package org.pentaho.plugin.eclipsebirt;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.eclipse.birt.report.engine.api.EngineConstants;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.HTMLRenderContext;
import org.eclipse.birt.report.engine.api.HTMLRenderOption;
import org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask;
import org.eclipse.birt.report.engine.api.IParameterDefn;
import org.eclipse.birt.report.engine.api.IParameterSelectionChoice;
import org.eclipse.birt.report.engine.api.IRenderOption;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportRunnable;
import org.eclipse.birt.report.engine.api.IRunAndRenderTask;
import org.eclipse.birt.report.engine.api.IScalarParameterDefn;
import org.eclipse.birt.report.engine.api.PDFRenderContext;
import org.eclipse.birt.report.engine.api.ReportParameterConverter;
import org.eclipse.birt.report.engine.api.impl.ScalarParameterDefn;
import org.pentaho.actionsequence.dom.ActionOutput;
import org.pentaho.actionsequence.dom.IActionInputVariable;
import org.pentaho.actionsequence.dom.actions.BirtReportAction;
import org.pentaho.core.repository.IContentItem;
import org.pentaho.core.runtime.IActionParameter;
import org.pentaho.core.runtime.IRuntimeContext;
import org.pentaho.core.session.IPentahoSession;
import org.pentaho.core.solution.IActionResource;
import org.pentaho.core.solution.IOutputHandler;
import org.pentaho.core.system.PentahoSystem;
import org.pentaho.messages.Messages;
import org.pentaho.plugin.ComponentBase;
/**
* @author James Dixon
*
* This component uses the BIRT report engine to generate PDF and HTML report
* output. It uses inputs provided by the runtime context and writes the output
* to the
*
*/
public class BIRTReportComponent extends ComponentBase {
protected static final Log logger = LogFactory.getLog(BIRTReportComponent.class);
protected static IReportEngine reportEngine = null;
private static final long serialVersionUID = -6051215996386090147L;
private static final int OUTPUT_TYPE_HTML = 0;
private static final int OUTPUT_TYPE_PDF = 1;
private static final ArrayList outputTypeStrings = new ArrayList();
private String type;
private int typeIdx = -1;
private String mimeType;
private String extension = ""; //$NON-NLS-1$
private IRenderOption renderOptions;
private IGetParameterDefinitionTask parameterDefinitionTask;
static {
outputTypeStrings.add("html"); //$NON-NLS-1$
outputTypeStrings.add("pdf"); //$NON-NLS-1$
}
public Log getLogger() {
return LogFactory.getLog(BIRTReportComponent.class);
}
protected boolean validateSystemSettings() {
// This component does not have any system settings to validate
return true;
}
/*
* This validates that the inputs, outputs, and resoruces that are available
* to us are correct. The actual values are not available at this point.
*
* @see org.pentaho.component.ComponentBase#validate()
*/
protected boolean validateAction() {
boolean actionValidated = true;
BirtReportAction reportAction = null;
if (getActionDefinition() instanceof BirtReportAction) {
reportAction = (BirtReportAction)getActionDefinition();
if (reportEngine == null) {
error(Messages.getErrorString("BIRTReportComponent.ERROR_0016_ENGINE_NOT_INITIALIZED")); //$NON-NLS-1$
actionValidated = false;
}
// Check that we have an input called 'output-typ' that will specified
// 'html' or 'pdf' output
if (actionValidated) {
if (reportAction.getOutputType() != IActionInputVariable.NULL_INPUT) {
String outputType = reportAction.getOutputType().getStringValue();
if (!outputType.equals("html") && !outputType.equals("pdf")) {
actionValidated = false;
error(Messages.getErrorString("BIRT.ERROR_0003_REPORT_TYPE_NOT_VALID", type)); //$NON-NLS-1$
}
} else {
// We don't know what kind of output to produce, so return an error
actionValidated = false;
error(Messages.getErrorString("BIRT.ERROR_0001_REPORT_TYPE_NOT_SPECIFIED")); //$NON-NLS-1$
}
}
} else {
actionValidated = false;
error(Messages.getErrorString("ComponentBase.ERROR_0001_UNKNOWN_ACTION_TYPE", getActionDefinition().getElement().asXML())); //$NON-NLS-1$
}
// Check that we have a resource called 'report-definition' tht should
// be the BIRT report definition file
if (actionValidated &&
reportAction.getReportDefinition() == null) {
// We don't have a report definition resource, so return an error
error(Messages.getErrorString("BIRT.ERROR_0002_REPORT_DEFINITION_NOT_SPECIFIED")); //$NON-NLS-1$
actionValidated = false;
}
// Looks like everything is ok so far
return actionValidated;
}
/*
* perform any initialization required
*
* @see org.pentaho.component.ComponentBase#init()
*/
public boolean init() {
// BIRT report engine is initialized by the BIRT System Listener so just return
return true;
}
/*
* Execute the BIRT report using the input, resources and outputs defined.
* If we require parameters to be selected by the user, generate a form
* definition for the user
*
* @see org.pentaho.component.ComponentBase#execute()
*/
protected boolean executeAction() {
// IRuntimeContext context = getRuntimeContext();
// Get the real location of the report definition file
BirtReportAction reportAction = (BirtReportAction)getActionDefinition();
IActionResource reportDefResource = getResource(reportAction.getReportDefinition().getName());
String reportDefinitionPath = reportDefResource.getAddress();
InputStream reportDefinition;
try {
reportDefinition = PentahoSystem.getSolutionRepository(getSession()).getResourceInputStream(
reportDefResource, true);
} catch (FileNotFoundException e1) {
error(e1.getLocalizedMessage());
return false;
}
// Get the type of the output
type = reportAction.getOutputType().getStringValue();
typeIdx = outputTypeStrings.indexOf(type);
if (typeIdx < 0) {
error(Messages.getErrorString("BIRT.ERROR_0003_REPORT_TYPE_NOT_VALID", type)); //$NON-NLS-1$
return false;
}
switch (typeIdx) {
case OUTPUT_TYPE_HTML: {
mimeType = "text/html"; //$NON-NLS-1$
extension = ".html"; //$NON-NLS-1$
renderOptions = new HTMLRenderOption();
break;
}
case OUTPUT_TYPE_PDF: {
mimeType = "application/pdf"; //$NON-NLS-1$
extension = ".pdf"; //$NON-NLS-1$
renderOptions = new HTMLRenderOption();
break;
}
default: {
error(Messages.getErrorString("BIRT.ERROR_0003_REPORT_TYPE_NOT_VALID", type)); //$NON-NLS-1$
return false;
}
}
if (debug)
debug(Messages.getString("BIRT.DEBUG_EXECUTING_REPORT", reportDefinitionPath, type)); //$NON-NLS-1$
String baseUrl = PentahoSystem.getApplicationContext().getBaseUrl();
boolean result = false;
try {
// TODO support caching or the ReportRunnable object
// Create an isntance of a runnable report using the report
// definition file provided
IReportRunnable design = reportEngine.openReportDesign(reportDefinition);
if (design == null) {
return false;
}
//getParameterDefns
//IGetParameterDefinitionTask parameterDefinitionTask = reportEngine.createGetParameterDefinitionTask(design);
parameterDefinitionTask = reportEngine.createGetParameterDefinitionTask(design);
// Set up the parameters for the report
HashMap parameterMap = new HashMap();
int parameterStatus = setupParameters(parameterDefinitionTask.getParameterDefns(false), parameterMap);
if (parameterStatus == IRuntimeContext.PARAMETERS_FAIL) {
error(Messages.getErrorString("BIRT.ERROR_0005_INVALID_REPORT_PARAMETERS")); //$NON-NLS-1$
return false;
} else if (parameterStatus == IRuntimeContext.PARAMETERS_UI_NEEDED) {
return true;
}
parameterDefinitionTask.close();
// Run task
IRunAndRenderTask runTask = reportEngine.createRunAndRenderTask(design);
IPentahoSession session = this.getSession();
runTask.setLocale(session.getLocale());
// Get the output stream that the content is going into
OutputStream outputStream = null;
IContentItem contentItem = null;
ActionOutput actionOutput = reportAction.getOutputReport();
if (actionOutput != null) {
if (actionOutput.getName().equals(BirtReportAction.REPORT_OUTPUT_ELEMENT)) {
contentItem = getOutputItem(reportAction.getOutputReport().getName(), mimeType, extension);
} else {
contentItem = getOutputContentItem(actionOutput.getName());
contentItem.setMimeType(mimeType);
}
try {
outputStream = contentItem.getOutputStream(getActionName());
} catch (Exception e) {
}
} else {
// There was no output in the action-sequence document, so make
// a default
// outputStream.
warn(Messages.getString("Base.WARN_NO_OUTPUT_STREAM")); //$NON-NLS-1$
outputStream = getDefaultOutputStream(mimeType);
if (outputStream != null) {
setOutputMimeType(mimeType);
}
}
if (outputStream == null) {
// We could not get an output stream for the content
error(Messages.getErrorString("BIRT.ERROR_0006_INVALID_OUTPUT_STREAM")); //$NON-NLS-1$
return false;
}
// Execute the report
try {
result = generateReport(parameterMap, outputStream, runTask, baseUrl);
} finally {
if (contentItem != null) {
contentItem.closeOutputStream();
}
}
} catch (Throwable e) {
error(Messages.getErrorString("BIRT.ERROR_0007_REPORT_ERRORS_ENCOUNTERED", reportDefinitionPath), e); //$NON-NLS-1$
}
return result;
}
/*
* Create an instance of the EngineConfig class for the BIRT report engine.
*/
/*
* Set up the report parameters
*/
private int setupParameters(Collection params, HashMap reportParameterMap) {
try {
boolean parameterUINeeded = false;
if (getOutputPreference() == IOutputHandler.OUTPUT_TYPE_PARAMETERS) {
parameterUINeeded = true;
}
// Process each parameter in turn
Iterator it = params.iterator();
while (it.hasNext()) {
IParameterDefn param = (IParameterDefn) it.next();
ScalarParameterDefn scalarParm = null;
if (param instanceof ScalarParameterDefn) {
scalarParm = (ScalarParameterDefn) param;
}
String paramName = param.getName();
String defaultValue = ""; //$NON-NLS-1$
if (scalarParm != null) {
defaultValue = scalarParm.getDefaultValue();
}
if (!isDefinedInput(paramName)) {
// what do we do here?
continue;
}
String contextValue = getInputStringValue(paramName);
// Get the value for the parameter from the current context
IActionParameter paramParameter = getInputParameter(paramName);
// if(debug)
// debug(Messages.getString("BIRT.DEBUG_SETTING_PARAMETER",
// paramName, paramValue )); //$NON-NLS-1$
// There is no parameter in the runtime or the parameter found
// has no value and no selections
if (paramParameter == null
|| ((!paramParameter.hasValue() || parameterUINeeded) && !paramParameter.hasSelections())) {
if (paramParameter.getPromptStatus() == IActionParameter.PROMPT_PENDING) {
parameterUINeeded = true;
continue;
} else {
paramParameter = null;
}
}
if (paramParameter == null) { // Still no parameter, use BIRTs
// default way
if ((scalarParm != null)) {
if (parameterUIOk()) {
// The parameter value was not provided, and we are
// allowed to create user interface forms
int controlType = scalarParm.getControlType();
if ((controlType == IScalarParameterDefn.LIST_BOX)) {
ArrayList values = new ArrayList();
HashMap displayNames = new HashMap();
Collection coll = parameterDefinitionTask.getSelectionList(scalarParm.getName());
if(coll != null) {
Iterator valueIterator = coll.iterator();
while (valueIterator.hasNext()) {
IParameterSelectionChoice selectionItem = (IParameterSelectionChoice) valueIterator.next( );
Object value = selectionItem.getValue();
if (value != null) {
String label = selectionItem.getLabel();
displayNames.put(value.toString(), (label != null) ? label : value);
values.add(value);
}
}
}
createFeedbackParameter(param.getName(), /*param.getDisplayName()*/ scalarParm.getPromptText(), scalarParm.getHelpText(),
defaultValue, values, displayNames, null);
} else {
createFeedbackParameter(param.getName(), /*param.getDisplayName()*/ scalarParm.getPromptText(), scalarParm.getHelpText(),
defaultValue, true);
}
parameterUINeeded = true;
continue;
} else {
return IRuntimeContext.PARAMETERS_FAIL;
}
} else if (defaultValue.length() == 0) {
// If the length of the defaultValue is not zero, then:
// 1- It's a scalar parameter
// 2- There's a default value expression associated with
// the parameter.
// Therefore, let BIRT use that expression
// automatically.
// The parameter was not provided and we are not allowed
// to create forms
error(Messages.getErrorString("BIRT.ERROR_0009_PARAMETER_NOT_PROVIDED", paramName)); //$NON-NLS-1$
return IRuntimeContext.PARAMETERS_FAIL;
}
}
String paramValue = contextValue;
if ((paramValue != null) && (!"".equals(paramValue))) { //$NON-NLS-1$
if (scalarParm != null) {
String format = scalarParm.getDisplayFormat();
ReportParameterConverter cfgConverter = new ReportParameterConverter(format, Locale.getDefault());
Object configValueObj = cfgConverter.parse(paramValue, scalarParm.getDataType());
reportParameterMap.put(paramName, configValueObj);
} else {
reportParameterMap.put(paramName, paramValue);
}
}
}
if (parameterUINeeded) {
return IRuntimeContext.PARAMETERS_UI_NEEDED;
} else if (getRuntimeContext().isPromptPending()) {
return IRuntimeContext.PARAMETERS_UI_NEEDED;
}
return IRuntimeContext.PARAMETERS_OK;
} catch (Throwable error) {
error(Messages.getErrorString("BIRT.ERROR_0005_INVALID_REPORT_PARAMETERS"), error); //$NON-NLS-1$
}
return IRuntimeContext.PARAMETERS_FAIL;
}
private boolean parameterUIOk() {
/*
* See if we are allowed to generate a parameter selection user
* interface. If we are being called as part of a process, this will not
* be allowed.
*/
if (!feedbackAllowed()) {
return false;
}
// We need input from the user, we have delivered an input form into the
// feeback stream
setFeedbackMimeType("text/html"); //$NON-NLS-1$
return true;
}
/*
* Generate the report output
*/
private boolean generateReport(HashMap parameterMap, OutputStream outputStream, IRunAndRenderTask task, String baseUrl) {
try {
HashMap appContextMap = new HashMap();
// Set the output options for the report
if (typeIdx == OUTPUT_TYPE_HTML) {
HTMLRenderContext htmlContext = new HTMLRenderContext();
htmlContext.setBaseImageURL(baseUrl + "getImage?image="); //$NON-NLS-1$
htmlContext.setImageDirectory(PentahoSystem.getApplicationContext().getSolutionPath("system/tmp")); //$NON-NLS-1$
htmlContext.setSupportedImageFormats("PNG;GIF;JPG;BMP"); //$NON-NLS-1$
appContextMap.put(EngineConstants.APPCONTEXT_HTML_RENDER_CONTEXT, htmlContext);
} else if (typeIdx == OUTPUT_TYPE_PDF) {
PDFRenderContext pdfContext = new PDFRenderContext();
pdfContext.setBaseURL(baseUrl + "getImage?image="); //$NON-NLS-1$
pdfContext.setSupportedImageFormats("PNG;GIF;JPG;BMP"); //$NON-NLS-1$
appContextMap.put(EngineConstants.APPCONTEXT_PDF_RENDER_CONTEXT, pdfContext);
}
task.setAppContext(appContextMap);
task.setRenderOption(renderOptions);
renderOptions.setOutputFormat(type);
// Set the output stream for the content
renderOptions.setOutputStream(outputStream);
task.setParameterValues(parameterMap);
if (debug) {
debug(task.toString());
}
task.run();
outputStream.flush();
outputStream.close();
return true;
} catch (IOException ioe) {
error(null, ioe);
error(Messages.getErrorString("BIRT.ERROR_0010_REPORT_COULD_NOT_BE_RUN", ioe.getMessage())); //$NON-NLS-1$
} catch (EngineException ee) {
error(null, ee);
error(Messages.getErrorString("BIRT.ERROR_0010_REPORT_COULD_NOT_BE_RUN", ee.getMessage())); //$NON-NLS-1$
}
return false;
}
/*
* Perform any cleanup necessary
*
* @see org.pentaho.component.ComponentBase#done()
*/
public void done() {
// we don't have anything to clean up to do
}
/* DM This should be removed when the JPivot/BIRT conflict is resolved
* Create an instance of the EngineConfig class for the BIRT report engine.
private IReportEngine createBIRTEngine() {
try {
// Get the global settings for the BIRT engine from our system settings
String birtHome = PentahoSystem.getApplicationContext().getSolutionPath("system/BIRT"); //$NON-NLS-1$
birtHome = birtHome.replaceAll("\\\\.\\\\", "\\\\"); //$NON-NLS-1$ //$NON-NLS-2$
if (PentahoSystem.debug)
Logger.debug(BirtSystemListener.class.getName(), Messages.getString("BIRT.DEBUG_BIRT_HOME", birtHome)); //$NON-NLS-1$
// Create an appropriate Config object
EngineConfig config = new EngineConfig();
config.setEngineHome(birtHome); // Configuring where BIRT engine is installed
// Set the directory where the BIRT log files will go
String logDest = PentahoSystem.getApplicationContext().getFileOutputPath("system/logs/BIRT"); //$NON-NLS-1$
// Set the logging level
int loggingLevel = Logger.getLogLevel();
if (loggingLevel == ILogger.TRACE) {
config.setLogConfig(logDest, Level.ALL);
} else if (loggingLevel == ILogger.DEBUG) {
config.setLogConfig(logDest, Level.FINE);
} else if (loggingLevel == ILogger.INFO) {
config.setLogConfig(logDest, Level.INFO);
} else if (loggingLevel == ILogger.WARN) {
config.setLogConfig(logDest, Level.WARNING);
} else if (loggingLevel == ILogger.ERROR) {
config.setLogConfig(logDest, Level.SEVERE);
} else if (loggingLevel == ILogger.FATAL) {
config.setLogConfig(logDest, Level.SEVERE);
}
// Register new image handler
HTMLEmitterConfig emitterConfig = new HTMLEmitterConfig( );
emitterConfig.setActionHandler( new HTMLActionHandler( ) );
emitterConfig.setImageHandler( new HTMLServerImageHandler( ) );
config.getEmitterConfigs( ).put( RenderOptionBase.OUTPUT_FORMAT_HTML, emitterConfig );
Platform.startup( config );
IReportEngineFactory factory = (IReportEngineFactory) Platform.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
IReportEngine engine = factory.createReportEngine( config );
return engine;
}
catch (Throwable error) {
error.printStackTrace();
Logger.error(BirtSystemListener.class.getName(), Messages.getErrorString("BIRT.ERROR_0008_INVALID_CONFIGURATION")); //$NON-NLS-1$
}
return null;
}
*/
}
The table below shows all metrics for BIRTReportComponent.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 72.00 | Number of blocks | |
| BLOCK_COMMENT | 107.00 | Number of block comment lines | |
| COMMENTS | 164.00 | Comment lines | |
| COMMENT_DENSITY | 0.60 | Comment density | |
| COMPARISONS | 38.00 | Number of comparison operators | |
| CYCLOMATIC | 64.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 10.00 | Comments in declarations | |
| DOC_COMMENT | 8.00 | Number of javadoc comment lines | |
| ELOC | 274.00 | Effective lines of code | |
| EXEC_COMMENTS | 32.00 | Comments in executable code | |
| EXITS | 95.00 | Procedure exits | |
| FUNCTIONS | 9.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 70.73 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 31.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 | 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 | 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 | 1.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 | 2.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 | 1.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 | 0.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 | 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 | 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 | 1.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 | 4.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 5.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 | 3.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 | 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 | 1.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 | 2.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 | 2.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 | 556.00 | Number of lines in the source file | |
| LINE_COMMENT | 49.00 | Number of line comments | |
| LOC | 329.00 | Lines of code | |
| LOGICAL_LINES | 194.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 10.00 | Maximum nesting depth | |
| OPERANDS | 791.00 | Number of operands | |
| OPERATORS | 1514.00 | Number of operators | |
| PARAMS | 6.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2305.00 | Halstead program length | |
| PROGRAM_VOCAB | 323.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 25.00 | Number of return points from functions | |
| SIZE | 21559.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 274.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 63.00 | Number of whitespace lines | |