HibernateUtil.java

Index Score
org.pentaho.repository
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.

MetricDescription
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0034JAVA0034 Missing braces in if statement
JAVA0166JAVA0166 Generic exception caught
EXITSProcedure exits
BLOCKSNumber of blocks
JAVA0115JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
SIZESize of the file in bytes
CYCLOMATICCyclomatic complexity
OPERATORSNumber of operators
UNIQUE_OPERANDSNumber of unique operands
JAVA0177JAVA0177 Variable declaration missing initializer
PROGRAM_LENGTHHalstead program length
PROGRAM_VOCABHalstead program vocabulary
LOGICAL_LINESNumber of statements
OPERANDSNumber of operands
RETURNSNumber of return points from functions
EXEC_COMMENTSComments in executable code
ELOCEffective lines of code
LOCLines of code
JAVA0265JAVA0265 Use of Throwable.printStackTrace()
LINESNumber of lines in the source file
LINE_COMMENTNumber of line comments
JAVA0170JAVA0170 Caught exception not derived from java.lang.Exception
DECL_COMMENTSComments in declarations
JAVA0150JAVA0150 java.lang.Error (or subclass) thrown
COMMENTSComment lines
LOOPSNumber of loops
INTERFACE_COMPLEXITYInterface complexity
DOC_COMMENTNumber of javadoc comment lines
UNIQUE_OPERATORSNumber of unique operators
PROGRAM_VOLUMEHalstead program volume
FUNCTIONSNumber of function declarations
JAVA0136JAVA0136 N methods defined in class (maximum: M)
COMPARISONSNumber of comparison operators
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0068JAVA0068 Modifiers not declared in recommended order
JAVA0145JAVA0145 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 20, 2005 * @author Marc Batchelor * */ package org.pentaho.repository; import java.io.File; import java.util.ArrayList; import java.util.List; import java.util.StringTokenizer; import javax.naming.Context; import javax.naming.InitialContext; import javax.naming.NamingException; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.dom4j.Node; import org.hibernate.HibernateException; import org.hibernate.Interceptor; import org.hibernate.Query; import org.hibernate.Session; import org.hibernate.SessionFactory; import org.hibernate.Transaction; import org.hibernate.cfg.Configuration; import org.hibernate.cfg.Environment; import org.hibernate.dialect.Dialect; import org.pentaho.core.repository.RepositoryException; import org.pentaho.core.repository.content.ContentException; import org.pentaho.core.system.IApplicationContext; import org.pentaho.core.system.IPentahoSystemEntryPoint; import org.pentaho.core.system.IPentahoSystemExitPoint; import org.pentaho.core.system.ISystemSettings; import org.pentaho.core.system.PentahoSystem; import org.pentaho.core.util.DatasourceHelper; import org.pentaho.messages.MessageUtil; import org.pentaho.messages.Messages; public class HibernateUtil implements IPentahoSystemEntryPoint, IPentahoSystemExitPoint { private static Log log = LogFactory.getLog(HibernateUtil.class); private final static boolean debug = PentahoSystem.debug; private static Configuration configuration; private static SessionFactory sessionFactory; private static final byte[] lock = new byte[0]; private static final ThreadLocal threadSession = new ThreadLocal(); private static final ThreadLocal threadTransaction = new ThreadLocal(); private static final ThreadLocal threadInterceptor = new ThreadLocal(); // private static final ThreadLocal commitNeeded = new ThreadLocal(); private static boolean hibernateManaged; private static String factoryJndiName; private static String dialect; private static Context iniCtx; private static List objectHandlers = new ArrayList(); private static final String QUERYWILDCARD = "%{0}%"; //$NON-NLS-1$ static { // JIRA case #PLATFORM 150: removed listener and changed to lazy init initialize(); } // private HibernateUtil() {} protected static boolean initialize() { IApplicationContext applicationContext = PentahoSystem.getApplicationContext(); // Add to entry/exit points list HibernateUtil hUtil = new HibernateUtil(); applicationContext.addEntryPointHandler(hUtil); applicationContext.addExitPointHandler(hUtil); // Look for some hibernate-specific properties... String hibernateConfigurationFile = applicationContext.getProperty("hibernateConfigPath", null); //$NON-NLS-1$ if ((hibernateConfigurationFile != null)) { if (hibernateConfigurationFile.trim().length() == 0) { hibernateConfigurationFile = null; } } String tmp = applicationContext.getProperty("hibernateManaged", "false").trim().toLowerCase(); //$NON-NLS-1$ //$NON-NLS-2$ hibernateManaged = tmp.equals("true"); //$NON-NLS-1$ try { configuration = new Configuration(); configuration.setEntityResolver(new PentahoEntityResolver()); configuration.setListener("load", new HibernateLoadEventListener()); //$NON-NLS-1$ if (hibernateConfigurationFile != null) { String configPath = applicationContext.getSolutionPath(hibernateConfigurationFile); File cfgFile = new File(configPath); if (cfgFile.exists()) { configuration.configure(cfgFile); } else { log.error(Messages.getErrorString("HIBUTIL.ERROR_0012_CONFIG_NOT_FOUND", configPath)); //$NON-NLS-1$ return false; } } else { configuration.configure(); // Read in the .xml document } String dsName = configuration.getProperty("connection.datasource"); //$NON-NLS-1$ if ((dsName != null) && dsName.toUpperCase().endsWith("HIBERNATE")) { //$NON-NLS-1$ String actualDSName = DatasourceHelper.getDSBoundName("Hibernate"); //$NON-NLS-1$ configuration.setProperty("hibernate.connection.datasource", actualDSName); //$NON-NLS-1$ } dialect = configuration.getProperty("dialect"); //$NON-NLS-1$ setupConfigurationHandlers(); // Add in the classes we know about. addConfigurations(configuration); /* * configuration.addResource("org/pentaho/repository/runtime/RuntimeElement.hbm.xml"); * //$NON-NLS-1$ * configuration.addResource("org/pentaho/repository/content/ContentLocation.hbm.xml");//$NON-NLS-1$ * configuration.addResource("org/pentaho/repository/content/ContentItem.hbm.xml");//$NON-NLS-1$ * configuration.addResource("org/pentaho/repository/content/ContentItemFile.hbm.xml");//$NON-NLS-1$ * configuration.addResource("org/pentaho/repository/DefinitionVersionManager.hbm.xml");//$NON-NLS-1$ */ if (!hibernateManaged) { log.info(Messages.getString("HIBUTIL.USER_HIBERNATEUNMANAGED")); //$NON-NLS-1$ sessionFactory = configuration.buildSessionFactory(); } else { factoryJndiName = configuration.getProperty(Environment.SESSION_FACTORY_NAME); if (factoryJndiName == null) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0013_NO_SESSION_FACTORY"));//$NON-NLS-1$ return false; } log.info(Messages.getString("HIBUTIL.USER_HIBERNATEMANAGED")); //$NON-NLS-1$ configuration.buildSessionFactory(); // Let hibernate Bind it // to JNDI... } Dialect.getDialect(configuration.getProperties()); DefinitionVersionManager.performAutoUpdateIfRequired(); return true; } catch (Throwable ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0006_BUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ throw new ExceptionInInitializerError(ex); } } private static void setupConfigurationHandlers() { ISystemSettings systemSettings = PentahoSystem.getSystemSettings(); List objectHandlerDefs = systemSettings.getSystemSettings("HibernatedObjectHandlers/*"); //$NON-NLS-1$ if ((objectHandlerDefs != null) && (objectHandlerDefs.size() > 0)) { String handlerClass; for (int i = 0; i < objectHandlerDefs.size(); i++) { handlerClass = ((Node) objectHandlerDefs.get(i)).getText(); IHibernatedObjectExtensionList extension = (IHibernatedObjectExtensionList) PentahoSystem .createObject(handlerClass); if (extension != null) { objectHandlers.add(extension); } } } else { // Handle old condition where it didn't exist in pentaho.xml objectHandlers.add(new StdHibernateClassHandler()); } } private static void addConfigurations(Configuration theConfiguration) { IHibernatedObjectExtensionList extension; for (int i = 0; i < objectHandlers.size(); i++) { extension = (IHibernatedObjectExtensionList) objectHandlers.get(i); List resourceList = extension.getHibernatedObjectResourceList(); for (int j = 0; j < resourceList.size(); j++) { theConfiguration.addResource((String) resourceList.get(j)); } } } /** * Returns the SessionFactory used for this static class. * * @return SessionFactory */ public static SessionFactory getSessionFactory() { if (!hibernateManaged) { return sessionFactory; } SessionFactory sf = null; try { if (iniCtx == null) { iniCtx = new InitialContext(); } String jndiName = factoryJndiName; try { sf = (SessionFactory) iniCtx.lookup(jndiName); } catch (Exception ignored) { } if (sf == null) { try { sf = (SessionFactory) iniCtx.lookup("java:" + jndiName); //$NON-NLS-1$ } catch (Exception ignored) { ignored.printStackTrace(); } } } catch (NamingException ignored) { } return sf; } /** * Returns the original Hibernate configuration. * * @return Configuration */ public static Configuration getConfiguration() { return configuration; } public static void updateSchema() throws RepositoryException { PentahoSchemaUpdate upd = new PentahoSchemaUpdate(getConfiguration()); upd.execute(true, true); } /** * Rebuild the SessionFactory with the static Configuration. * */ public static void rebuildSessionFactory() throws RepositoryException { if (!hibernateManaged) { synchronized (lock) { try { sessionFactory = getConfiguration().buildSessionFactory(); } catch (Exception ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ } } } else { try { getConfiguration().buildSessionFactory(); } catch (Exception ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ } } } /** * Rebuild the SessionFactory with the given Hibernate Configuration. * * @param cfg */ public static void rebuildSessionFactory(Configuration cfg) throws RepositoryException { if (!hibernateManaged) { synchronized (lock) { try { sessionFactory = cfg.buildSessionFactory(); configuration = cfg; } catch (Exception ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ } } } else { try { cfg.buildSessionFactory(); configuration = cfg; } catch (Exception ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0007_REBUILD_SESSION_FACTORY"), ex); //$NON-NLS-1$ } } } /** * Retrieves the current Session local to the thread. <p/> If no Session is * open, opens a new Session for the running thread. * * @return Session */ public static Session getSession() throws RepositoryException { Session s = (Session) threadSession.get(); try { if (s == null) { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_OPEN_NEW_SESSION")); //$NON-NLS-1$ if (getInterceptor() != null) { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_USING_INTERCEPTOR") + getInterceptor().getClass()); //$NON-NLS-1$ s = getSessionFactory().openSession(getInterceptor()); } else { s = getSessionFactory().openSession(); } threadSession.set(s); } } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0005_GET_SESSION"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0005_GET_SESSION"), ex); //$NON-NLS-1$ } return s; } public static void flushSession() throws RepositoryException { try { Session s = getSession(); s.flush(); } catch (HibernateException ex) { throw new RepositoryException(ex); } } /** * Closes the Session local to the thread. */ public static void closeSession() throws RepositoryException { try { Session s = (Session) threadSession.get(); threadSession.set(null); if (s != null && s.isOpen()) { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_CLOSING_SESSION")); //$NON-NLS-1$ s.close(); } threadTransaction.set(null); } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0009_CLOSE_SESSION"), ex); //$NON-NLS-1$ threadTransaction.set(null); throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0009_CLOSE_SESSION"), ex); //$NON-NLS-1$ } } /** * Start a new database transaction. */ public static void beginTransaction() throws RepositoryException { // commitNeeded.set(Boolean.TRUE); Transaction tx = (Transaction) threadTransaction.get(); try { if (tx == null) { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_START_TRANS")); //$NON-NLS-1$ tx = getSession().beginTransaction(); threadTransaction.set(tx); } } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0004_START_TRANS"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0004_START_TRANS"), ex); //$NON-NLS-1$ } } /** * Commit the database transaction. */ public static void commitTransaction() throws RepositoryException { // Boolean needed = (Boolean)commitNeeded.get(); // if (needed.booleanValue()){ Transaction tx = (Transaction) threadTransaction.get(); try { if (tx != null && !tx.wasCommitted() && !tx.wasRolledBack()) { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_COMMIT_TRANS")); //$NON-NLS-1$ tx.commit(); } } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0008_COMMIT_TRANS"), ex); //$NON-NLS-1$ try { rollbackTransaction(); } catch (Exception e2) { } // throw new // RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0008_COMMIT_TRANS"), // ex); //$NON-NLS-1$ } finally { threadTransaction.set(null); } // } // commitNeeded.set(Boolean.FALSE); } /** * Commit the database transaction. */ public static void rollbackTransaction() throws RepositoryException { Transaction tx = (Transaction) threadTransaction.get(); try { threadTransaction.set(null); if (tx != null && !tx.wasCommitted() && !tx.wasRolledBack()) { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_ROLLBACK")); //$NON-NLS-1$ tx.rollback(); } } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0003_ROLLBACK"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0003_ROLLBACK"), ex); //$NON-NLS-1$ } finally { closeSession(); } } /** * Reconnects a Hibernate Session to the current Thread. * * @param session * The Hibernate Session to be reconnected. */ /* * public static void reconnect(Session session) throws RepositoryException { * try { session.reconnect(); threadSession.set(session); } catch * (HibernateException ex) { * log.error(Messages.getErrorString("HIBUTIL.ERROR_0001_RECONNECT"), ex); * //$NON-NLS-1$ throw new RepositoryException(ex); } } */ /** * Disconnect and return Session from current Thread. * * @return Session the disconnected Session */ public static Session disconnectSession() throws RepositoryException { Session session = getSession(); try { threadSession.set(null); if (session.isConnected() && session.isOpen()) session.disconnect(); } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0002_DISCONNECT"), ex); //$NON-NLS-1$ throw new RepositoryException(Messages.getErrorString("HIBUTIL.ERROR_0002_DISCONNECT"), ex); //$NON-NLS-1$ } return session; } /** * Register a Hibernate interceptor with the current thread. * <p> * Every Session opened is opened with this interceptor after registration. * Has no effect if the current Session of the thread is already open, * effective on next close()/getSession(). */ public static void registerInterceptor(Interceptor interceptor) { threadInterceptor.set(interceptor); } private static Interceptor getInterceptor() { Interceptor interceptor = (Interceptor) threadInterceptor.get(); return interceptor; } /** * Searches an ISearchable object for a search term. The search rules are as * follows: * * If the searchType is ISearchable.SEARCH_TYPE_PHRASE, then the fields in * the table are searched for the exact phrase given. * * If the searchType is ISearchable.SEARCH_TYPE_WORDS_AND or ..._OR, then * the following happens: a- Each word in the searchTerm is extracted and * put into a list of search terms. b- Each search term is surrounded by the * SQL wildcard '%'. So each search term becomes %term%. c- A dynamic query * is generated searching each of the columns for each search term d- The * searchType is used to determine the connector between each search term. * e- The AND will match only if all of the terms appear in a specific * column - cross-column searching using ..._AND will NOT work. In other * words, if your search term is "East Sales", and your search type is * ..._AND, a row will be returned if one of the columns contains East and * the same column contains Sales. A row will NOT be returned if one column * only contains East, and another column only contains Sales. This type of * functionality could be obtained using a view that concatenates all of the * searchable columns together into one large column, but this would be * costly and database-specific. * * @param searchable * ISearchable to search * @param searchTerm * Search Term - see above for rules * @param searchType * One of: * ISearchable.SEARCH_TYPE_PHRASE,ISearchable.SEARCH_TYPE_WORDS_AND, * ISearchable.SEARCH_TYPE_WORDS_OR * @return A list of objects from Hibernate that met the conditions * specified. */ public static List searchForTerm(ISearchable searchable, String searchTerm, int searchType) { Session session = getSession(); if (searchType == ISearchable.SEARCH_TYPE_PHRASE) { Query qry = session.getNamedQuery(searchable.getPhraseSearchQueryName()); String searchWildcard = MessageUtil.formatErrorMessage(QUERYWILDCARD, searchTerm); qry.setString("searchTerm", searchWildcard); //$NON-NLS-1$ List rtn = qry.list(); return rtn; } String connector; if (searchType == ISearchable.SEARCH_TYPE_WORDS_AND) { connector = " and "; //$NON-NLS-1$ } else { connector = " or "; //$NON-NLS-1$ } StringTokenizer st = new StringTokenizer(searchTerm, " "); //$NON-NLS-1$ List searchWords = new ArrayList(); while (st.hasMoreTokens()) { searchWords.add(MessageUtil.formatErrorMessage(QUERYWILDCARD, st.nextToken())); } // Ok, we now have a list of search words. StringBuffer assembly = assembleQuery(searchable.getSearchableTable(), connector, searchWords, searchable .getSearchableColumns()); Query qry = session.createQuery(assembly.toString()); for (int j = 0; j < searchWords.size(); j++) { qry.setParameter("searchTerm" + j, searchWords.get(j)); //$NON-NLS-1$ } List rtn = qry.list(); return rtn; } private static StringBuffer assembleQuery(String tableName, String connector, List terms, String[] columns) { StringBuffer qry = new StringBuffer(); qry.append("from ").append(tableName).append(" tbl where "); //$NON-NLS-1$ //$NON-NLS-2$ String currCol, term; for (int colno = 0; colno < columns.length; colno++) { currCol = columns[colno]; qry.append("("); //$NON-NLS-1$ for (int termNo = 0; termNo < terms.size(); termNo++) { term = (String) terms.get(termNo); qry.append("tbl.").append(currCol).append(" like :searchTerm").append(term).append(" "); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ if (termNo < terms.size() - 1) { qry.append(connector); } } qry.append(")"); //$NON-NLS-1$ if (colno < columns.length - 1) { qry.append(" or "); // Columns are always or'd //$NON-NLS-1$ } } return qry; } public static void clear() { getSession().clear(); } /** * Persists changes to the object. Object must be defined to hibernate. * * @param obj * The object to make persistent * @throws RepositoryException */ public static void makePersistent(Object obj) throws RepositoryException { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_MAKE_PERSISTENT", obj.toString())); //$NON-NLS-1$ try { getSession().saveOrUpdate(obj); } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0010_SAVING_UPDATING"), ex); //$NON-NLS-1$ throw new ContentException(Messages.getErrorString("HIBUTIL.ERROR_0010_SAVING_UPDATING"), ex); //$NON-NLS-1$ } } /** * Deletes the object from Hibernate * * @param obj * The object to make transient * @throws RepositoryException */ public static void makeTransient(Object obj) throws RepositoryException { if (debug) log.debug(Messages.getString("HIBUTIL.DEBUG_MAKE_TRANSIENT", obj.toString())); //$NON-NLS-1$ try { getSession().delete(obj); } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0011_DELETING_OBJ"), ex); //$NON-NLS-1$ throw new ContentException(Messages.getErrorString("HIBUTIL.ERROR_0011_DELETING_OBJ"), ex); //$NON-NLS-1$ } } /** * HACK This method is necessary to determine whether code should execute based on Oracle * in use as the RDBMS repository for the platform. Helps us work around Oracle * JDBC driver bugs. * * @return true if Hibernate dialect for oracle is in use. */ public static boolean isOracleDialect(){ return dialect.indexOf("oracle") >= 0 || //$NON-NLS-1$ dialect.indexOf("Oracle") >= 0 || //$NON-NLS-1$ dialect.indexOf("ORACLE") >= 0; //$NON-NLS-1$ } /** * Evicts the object from the Hibernate cache. Call this if you don't * believe you'll need this object in the cache. This is also good to call * if you're doing semi-mass updates. * * @param obj */ public static void evict(Object obj) { // if (debug) // log.debug(Messages.getString("HIBUTIL.DEBUG_EVICT", obj.toString())); //$NON-NLS-1$ try { getSession().evict(obj); } catch (HibernateException ex) { log.error(Messages.getErrorString("HIBUTIL.ERROR_0014_EVICTING_OBJECT"), ex); //$NON-NLS-1$ } } public static List getHibernatedObjectHandlerList() { return objectHandlers; } public void systemEntryPoint() { // No need to do anything for Hibernate here. } public void systemExitPoint() { try { HibernateUtil.commitTransaction(); } catch (Throwable t) { // get some real logging code in here t.printStackTrace(); } try { HibernateUtil.closeSession(); } catch (Throwable t) { // get some real logging code in here t.printStackTrace(); } } }

The table below shows all metrics for HibernateUtil.java.

MetricValueDescription
BLOCKS114.00Number of blocks
BLOCK_COMMENT31.00Number of block comment lines
COMMENTS170.00Comment lines
COMMENT_DENSITY 0.50Comment density
COMPARISONS42.00Number of comparison operators
CYCLOMATIC99.00Cyclomatic complexity
DECL_COMMENTS21.00Comments in declarations
DOC_COMMENT117.00Number of javadoc comment lines
ELOC337.00Effective lines of code
EXEC_COMMENTS16.00Comments in executable code
EXITS89.00Procedure exits
FUNCTIONS28.00Number of function declarations
HALSTEAD_DIFFICULTY76.25Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY69.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 9.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 0.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 1.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 1.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 0.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 0.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 8.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 5.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 1.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA012612.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 0.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 1.00JAVA0144 Line exceeds maximum M characters
JAVA0145 0.00JAVA0145 Tab character used in source file
JAVA0150 1.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA016610.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 3.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 5.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 0.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 1.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 3.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES648.00Number of lines in the source file
LINE_COMMENT22.00Number of line comments
LOC420.00Lines of code
LOGICAL_LINES221.00Number of statements
LOOPS 7.00Number of loops
NEST_DEPTH 4.00Maximum nesting depth
OPERANDS999.00Number of operands
OPERATORS1960.00Number of operators
PARAMS13.00Number of formal parameter declarations
PROGRAM_LENGTH2959.00Halstead program length
PROGRAM_VOCAB370.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS56.00Number of return points from functions
SIZE24736.00Size of the file in bytes
UNIQUE_OPERANDS321.00Number of unique operands
UNIQUE_OPERATORS49.00Number of unique operators
WHITESPACE58.00Number of whitespace lines