FilterSpecCompiler.java
| Index Score | ||
|---|---|---|
 |
 |
com.espertech.esper.filter |
 |
 |
Esper |
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 | |
|---|---|---|
| JAVA0144 | JAVA0144 Line exceeds maximum M characters |  |
| SIZE | Size of the file in bytes | |
| LINE_COMMENT | Number of line comments | |
| RETURNS | Number of return points from functions | |
| EXITS | Procedure exits | |
| EXEC_COMMENTS | Comments in executable code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LOC | Lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| OPERANDS | Number of operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| BLOCKS | Number of blocks | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| PARAMS | Number of formal parameter declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| LINES | Number of lines in the source file | |
| ELOC | Effective lines of code | |
| NEST_DEPTH | Maximum nesting depth | |
| LOGICAL_LINES | Number of statements | |
| COMPARISONS | Number of comparison operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0009 | JAVA0009 Protected member in final class | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**************************************************************************************
* Copyright (C) 2006 Esper Team. All rights reserved. *
* http://esper.codehaus.org *
* ---------------------------------------------------------------------------------- *
* The software in this package is published under the terms of the GPL license *
* a copy of which has been included with this distribution in the license.txt file. *
**************************************************************************************/
package com.espertech.esper.filter;
import com.espertech.esper.collection.Pair;
import com.espertech.esper.epl.core.MethodResolutionService;
import com.espertech.esper.epl.core.StreamTypeService;
import com.espertech.esper.epl.expression.*;
import com.espertech.esper.epl.variable.VariableService;
import com.espertech.esper.event.EventType;
import com.espertech.esper.schedule.TimeProvider;
import com.espertech.esper.type.RelationalOpEnum;
import com.espertech.esper.util.JavaClassHelper;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.util.*;
/**
* Helper to compile (validate and optimize) filter expressions as used in pattern and filter-based streams.
*/
public final class FilterSpecCompiler
{
private static final Log log = LogFactory.getLog(FilterSpecCompiler.class);
/**
* Assigned for filter parameters that are based on boolean expression and not on
* any particular property name.
* <p>
* Keeping this artificial property name is a simplification as optimized filter parameters
* generally keep a property name.
*/
public final static String PROPERTY_NAME_BOOLEAN_EXPRESSION = ".boolean_expression";
/**
* Factory method for compiling filter expressions into a filter specification
* for use with filter service.
* @param eventType is the filtered-out event type
* @param filterExpessions is a list of filter expressions
* @param taggedEventTypes is a map of stream names (tags) and event types available
* @param streamTypeService is used to set rules for resolving properties
* @param methodResolutionService resolved imports for static methods and such
* @param timeProvider - provides engine current time
* @param variableService - provides access to variables
* @return compiled filter specification
* @throws ExprValidationException if the expression or type validations failed
*/
public static FilterSpecCompiled makeFilterSpec(EventType eventType,
List<ExprNode> filterExpessions,
LinkedHashMap<String, EventType> taggedEventTypes,
StreamTypeService streamTypeService,
MethodResolutionService methodResolutionService,
TimeProvider timeProvider,
VariableService variableService)
throws ExprValidationException
{
// Validate all nodes, make sure each returns a boolean and types are good;
// Also decompose all AND super nodes into individual expressions
List<ExprNode> constituents = FilterSpecCompiler.validateAndDecompose(filterExpessions, streamTypeService, methodResolutionService, timeProvider, variableService);
// From the constituents make a filter specification
FilterSpecCompiled spec = makeFilterSpec(eventType, constituents, taggedEventTypes, variableService);
if (log.isDebugEnabled())
{
log.debug(".makeFilterSpec spec=" + spec);
}
return spec;
}
// remove duplicate propertyName + filterOperator items making a judgement to optimize or simply remove the optimized form
private static void consolidate(List<FilterSpecParam> items, FilterParamExprMap filterParamExprMap)
{
FilterOperator op = items.get(0).getFilterOperator();
if (op == FilterOperator.NOT_EQUAL)
{
handleConsolidateNotEqual(items, filterParamExprMap);
}
else
{
// for all others we simple remove the second optimized form (filter param with same prop name and filter op)
// and thus the boolean expression that started this is included
for (int i = 1; i < items.size(); i++)
{
filterParamExprMap.removeValue(items.get(i));
}
}
}
/**
* Validates expression nodes and returns a list of validated nodes.
* @param exprNodes is the nodes to validate
* @param streamTypeService is provding type information for each stream
* @param methodResolutionService for resolving functions
* @param timeProvider for providing current time
* @param variableService provides access to variables
* @return list of validated expression nodes
* @throws ExprValidationException for validation errors
*/
public static List<ExprNode> validateDisallowSubquery(List<ExprNode> exprNodes, StreamTypeService streamTypeService, MethodResolutionService methodResolutionService, TimeProvider timeProvider, VariableService variableService)
throws ExprValidationException
{
List<ExprNode> validatedNodes = new ArrayList<ExprNode>();
for (ExprNode node : exprNodes)
{
// Ensure there is no subselects
ExprNodeSubselectVisitor visitor = new ExprNodeSubselectVisitor();
node.accept(visitor);
if (visitor.getSubselects().size() > 0)
{
throw new ExprValidationException("Subselects not allowed within filters");
}
ExprNode validated = node.getValidatedSubtree(streamTypeService, methodResolutionService, null, timeProvider, variableService);
validatedNodes.add(validated);
if ((validated.getType() != Boolean.class) && ((validated.getType() != boolean.class)))
{
throw new ExprValidationException("Filter expression not returning a boolean value: '" + validated.toExpressionString() + "'");
}
}
return validatedNodes;
}
private static List<ExprNode> validateAndDecompose(List<ExprNode> exprNodes, StreamTypeService streamTypeService, MethodResolutionService methodResolutionService, TimeProvider timeProvider, VariableService variableService)
throws ExprValidationException
{
List<ExprNode> validatedNodes = validateDisallowSubquery(exprNodes, streamTypeService, methodResolutionService, timeProvider, variableService);
// Break a top-level AND into constituent expression nodes
List<ExprNode> constituents = new ArrayList<ExprNode>();
for (ExprNode validated : validatedNodes)
{
if (validated instanceof ExprAndNode)
{
recursiveAndConstituents(constituents, validated);
}
else
{
constituents.add(validated);
}
// Ensure there is no aggregation nodes
List<ExprAggregateNode> aggregateExprNodes = new LinkedList<ExprAggregateNode>();
ExprAggregateNode.getAggregatesBottomUp(validated, aggregateExprNodes);
if (!aggregateExprNodes.isEmpty())
{
throw new ExprValidationException("Aggregation functions not allowed within filters");
}
}
return constituents;
}
private static void consolidate(FilterParamExprMap filterParamExprMap)
{
// consolidate or place in a boolean expression (by removing filter spec param from the map)
// any filter parameter that feature the same property name and filter operator,
// i.e. we are looking for "a!=5 and a!=6" to transform to "a not in (5,6)" which can match faster
// considering that "a not in (5,6) and a not in (7,8)" is "a not in (5, 6, 7, 8)" therefore
// we need to consolidate until there is no more work to do
Map<Pair<String, FilterOperator>, List<FilterSpecParam>> mapOfParams =
new HashMap<Pair<String, FilterOperator>, List<FilterSpecParam>>();
boolean haveConsolidated;
do
{
haveConsolidated = false;
mapOfParams.clear();
// sort into buckets of propertyName + filterOperator combination
for (FilterSpecParam currentParam : filterParamExprMap.getFilterParams())
{
String propName = currentParam.getPropertyName();
FilterOperator op = currentParam.getFilterOperator();
Pair<String, FilterOperator> key = new Pair<String, FilterOperator>(propName, op);
List<FilterSpecParam> existingParam = mapOfParams.get(key);
if (existingParam == null)
{
existingParam = new ArrayList<FilterSpecParam>();
mapOfParams.put(key, existingParam);
}
existingParam.add(currentParam);
}
for (List<FilterSpecParam> entry : mapOfParams.values())
{
if (entry.size() > 1)
{
haveConsolidated = true;
consolidate(entry, filterParamExprMap);
}
}
}
while(haveConsolidated);
}
private static FilterSpecCompiled makeFilterSpec(EventType eventType,
List<ExprNode> constituents,
LinkedHashMap<String, EventType> taggedEventTypes,
VariableService variableService)
throws ExprValidationException
{
FilterParamExprMap filterParamExprMap = new FilterParamExprMap();
// Make filter parameter for each expression node, if it can be optimized
for (ExprNode constituent : constituents)
{
FilterSpecParam param = makeFilterParam(constituent);
filterParamExprMap.put(constituent, param); // accepts null values as the expression may not be optimized
}
// Consolidate entries as possible, i.e. (a != 5 and a != 6) is (a not in (5,6))
// Removes duplicates for same property and same filter operator for filter service index optimizations
consolidate(filterParamExprMap);
// Use all filter parameter and unassigned expressions
List<FilterSpecParam> filterParams = new ArrayList<FilterSpecParam>();
filterParams.addAll(filterParamExprMap.getFilterParams());
List<ExprNode> remainingExprNodes = filterParamExprMap.getUnassignedExpressions();
// any unoptimized expression nodes are put under one AND
ExprNode exprNode = null;
if (!remainingExprNodes.isEmpty())
{
if (remainingExprNodes.size() == 1)
{
exprNode = remainingExprNodes.get(0);
}
else
{
ExprAndNode andNode = new ExprAndNode();
for (ExprNode unoptimized : remainingExprNodes)
{
andNode.addChildNode(unoptimized);
}
exprNode = andNode;
}
}
// if there are boolean expressions, add
if (exprNode != null)
{
FilterSpecParamExprNode param = new FilterSpecParamExprNode(PROPERTY_NAME_BOOLEAN_EXPRESSION, FilterOperator.BOOLEAN_EXPRESSION, exprNode, taggedEventTypes, variableService);
filterParams.add(param);
}
return new FilterSpecCompiled(eventType, filterParams);
}
// consolidate "val != 3 and val != 4 and val != 5"
// to "val not in (3, 4, 5)"
private static void handleConsolidateNotEqual(List<FilterSpecParam> params, FilterParamExprMap filterParamExprMap)
{
List<FilterSpecParamInValue> values = new ArrayList<FilterSpecParamInValue>();
ExprNode lastNotEqualsExprNode = null;
for (FilterSpecParam param : params)
{
if (param instanceof FilterSpecParamConstant)
{
FilterSpecParamConstant constantParam = (FilterSpecParamConstant) param;
Object constant = constantParam.getFilterConstant();
values.add(new InSetOfValuesConstant(constant));
}
else if (param instanceof FilterSpecParamEventProp)
{
FilterSpecParamEventProp eventProp = (FilterSpecParamEventProp) param;
values.add(new InSetOfValuesEventProp(eventProp.getResultEventAsName(), eventProp.getResultEventProperty(),
eventProp.isMustCoerce(), eventProp.getCoercionType()));
}
else
{
throw new IllegalArgumentException("Unknown filter parameter:" + param.toString());
}
lastNotEqualsExprNode = filterParamExprMap.removeEntry(param);
}
FilterSpecParamIn param = new FilterSpecParamIn(params.get(0).getPropertyName(),
FilterOperator.NOT_IN_LIST_OF_VALUES, values);
filterParamExprMap.put(lastNotEqualsExprNode, param);
}
/**
* For a given expression determine if this is optimizable and create the filter parameter
* representing the expression, or null if not optimizable.
* @param constituent is the expression to look at
* @return filter parameter representing the expression, or null
* @throws ExprValidationException if the expression is invalid
*/
protected static FilterSpecParam makeFilterParam(ExprNode constituent)
throws ExprValidationException
{
// Is this expresson node a simple compare, i.e. a=5 or b<4; these can be indexed
if ((constituent instanceof ExprEqualsNode) ||
(constituent instanceof ExprRelationalOpNode))
{
FilterSpecParam param = handleEqualsAndRelOp(constituent);
if (param != null)
{
return param;
}
}
// Is this expresson node a simple compare, i.e. a=5 or b<4; these can be indexed
if (constituent instanceof ExprInNode)
{
FilterSpecParam param = handleInSetNode((ExprInNode)constituent);
if (param != null)
{
return param;
}
}
if (constituent instanceof ExprBetweenNode)
{
FilterSpecParam param = handleRangeNode((ExprBetweenNode)constituent);
if (param != null)
{
return param;
}
}
return null;
}
private static FilterSpecParam handleRangeNode(ExprBetweenNode betweenNode)
{
ExprNode left = betweenNode.getChildNodes().get(0);
if (left instanceof ExprIdentNode)
{
ExprIdentNode identNode = (ExprIdentNode) left;
String propertyName = identNode.getResolvedPropertyName();
FilterOperator op = FilterOperator.parseRangeOperator(betweenNode.isLowEndpointIncluded(), betweenNode.isHighEndpointIncluded(),
betweenNode.isNotBetween());
FilterSpecParamRangeValue low = handleRangeNodeEndpoint(betweenNode.getChildNodes().get(1));
FilterSpecParamRangeValue high = handleRangeNodeEndpoint(betweenNode.getChildNodes().get(2));
if ((low != null) && (high != null))
{
return new FilterSpecParamRange(propertyName, op, low, high);
}
}
return null;
}
private static FilterSpecParamRangeValue handleRangeNodeEndpoint(ExprNode endpoint)
{
// constant
if (endpoint instanceof ExprConstantNode)
{
ExprConstantNode node = (ExprConstantNode) endpoint;
Number result = (Number) node.evaluate(null, true);
return new RangeValueDouble(result.doubleValue());
}
// or property
if (endpoint instanceof ExprIdentNode)
{
ExprIdentNode identNodeInner = (ExprIdentNode) endpoint;
if (identNodeInner.getStreamId() == 0)
{
return null;
}
return new RangeValueEventProp(identNodeInner.getResolvedStreamName(), identNodeInner.getResolvedPropertyName());
}
return null;
}
private static FilterSpecParam handleInSetNode(ExprInNode constituent)
throws ExprValidationException
{
ExprNode left = constituent.getChildNodes().get(0);
if (left instanceof ExprIdentNode)
{
ExprIdentNode identNodeInSet = (ExprIdentNode) left;
String propertyName = identNodeInSet.getResolvedPropertyName();
FilterOperator op = FilterOperator.IN_LIST_OF_VALUES;
if (constituent.isNotIn())
{
op = FilterOperator.NOT_IN_LIST_OF_VALUES;
}
List<FilterSpecParamInValue> listofValues = new ArrayList<FilterSpecParamInValue>();
Iterator<ExprNode> it = constituent.getChildNodes().iterator();
it.next(); // ignore the first node as it's the identifier
while (it.hasNext())
{
ExprNode subNode = it.next();
if (subNode instanceof ExprConstantNode)
{
ExprConstantNode constantNode = (ExprConstantNode) subNode;
Object constant = constantNode.evaluate(null, true);
constant = handleConstantsCoercion(identNodeInSet, constant);
listofValues.add(new InSetOfValuesConstant(constant));
}
if (subNode instanceof ExprIdentNode)
{
ExprIdentNode identNodeInner = (ExprIdentNode) subNode;
if (identNodeInner.getStreamId() == 0)
{
break; // for same event evals use the boolean expression, via count compare failing below
}
boolean isMustCoerce = false;
Class numericCoercionType = identNodeInSet.getType();
if (identNodeInner.getType() != identNodeInSet.getType())
{
if (JavaClassHelper.isNumeric(identNodeInSet.getType()))
{
if (!JavaClassHelper.canCoerce(identNodeInner.getType(), identNodeInSet.getType()))
{
throwConversionError(identNodeInner.getType(), identNodeInSet.getType(), identNodeInSet.getResolvedPropertyName());
}
isMustCoerce = true;
}
}
listofValues.add(new InSetOfValuesEventProp(identNodeInner.getResolvedStreamName(), identNodeInner.getResolvedPropertyName(), isMustCoerce, numericCoercionType));
}
}
// Fallback if not all values in the in-node can be resolved to properties or constants
if (listofValues.size() == constituent.getChildNodes().size() - 1)
{
return new FilterSpecParamIn(propertyName, op, listofValues);
}
}
return null;
}
private static FilterSpecParam handleEqualsAndRelOp(ExprNode constituent)
throws ExprValidationException
{
FilterOperator op;
if (constituent instanceof ExprEqualsNode)
{
op = FilterOperator.EQUAL;
if (((ExprEqualsNode) constituent).isNotEquals())
{
op = FilterOperator.NOT_EQUAL;
}
}
else
{
ExprRelationalOpNode relNode = (ExprRelationalOpNode) constituent;
if (relNode.getRelationalOpEnum() == RelationalOpEnum.GT)
{
op = FilterOperator.GREATER;
}
else if (relNode.getRelationalOpEnum() == RelationalOpEnum.LT)
{
op = FilterOperator.LESS;
}
else if (relNode.getRelationalOpEnum() == RelationalOpEnum.LE)
{
op = FilterOperator.LESS_OR_EQUAL;
}
else if (relNode.getRelationalOpEnum() == RelationalOpEnum.GE)
{
op = FilterOperator.GREATER_OR_EQUAL;
}
else
{
throw new IllegalStateException("Opertor '" + relNode.getRelationalOpEnum() + "' not mapped");
}
}
ExprNode left = constituent.getChildNodes().get(0);
ExprNode right = constituent.getChildNodes().get(1);
// check identifier and constant combination
if ((right instanceof ExprConstantNode) && (left instanceof ExprIdentNode))
{
ExprIdentNode identNode = (ExprIdentNode) left;
ExprConstantNode constantNode = (ExprConstantNode) right;
String propertyName = identNode.getResolvedPropertyName();
Object constant = constantNode.evaluate(null, true);
constant = handleConstantsCoercion(identNode, constant);
return new FilterSpecParamConstant(propertyName, op, constant);
}
if ((left instanceof ExprConstantNode) && (right instanceof ExprIdentNode))
{
ExprIdentNode identNode = (ExprIdentNode) right;
ExprConstantNode constantNode = (ExprConstantNode) left;
String propertyName = identNode.getResolvedPropertyName();
Object constant = constantNode.evaluate(null, true);
constant = handleConstantsCoercion(identNode, constant);
return new FilterSpecParamConstant(propertyName, op, constant);
}
// check identifier and expression containing other streams
if ((left instanceof ExprIdentNode) && (right instanceof ExprIdentNode))
{
ExprIdentNode identNodeLeft = (ExprIdentNode) left;
ExprIdentNode identNodeRight = (ExprIdentNode) right;
if ((identNodeLeft.getStreamId() == 0) && (identNodeRight.getStreamId() != 0))
{
return handleProperty(op, identNodeLeft, identNodeRight);
}
if ((identNodeRight.getStreamId() == 0) && (identNodeLeft.getStreamId() != 0))
{
return handleProperty(op, identNodeRight, identNodeLeft);
}
}
return null;
}
private static FilterSpecParamEventProp handleProperty(FilterOperator op, ExprIdentNode identNodeLeft, ExprIdentNode identNodeRight)
throws ExprValidationException
{
String propertyName = identNodeLeft.getResolvedPropertyName();
boolean isMustCoerce = false;
Class numericCoercionType = identNodeLeft.getType();
if (identNodeRight.getType() != identNodeLeft.getType())
{
if (JavaClassHelper.isNumeric(identNodeRight.getType()))
{
if (!JavaClassHelper.canCoerce(identNodeRight.getType(), identNodeLeft.getType()))
{
throwConversionError(identNodeRight.getType(), identNodeLeft.getType(), identNodeLeft.getResolvedPropertyName());
}
isMustCoerce = true;
}
}
return new FilterSpecParamEventProp(propertyName, op, identNodeRight.getResolvedStreamName(), identNodeRight.getResolvedPropertyName(),
isMustCoerce, numericCoercionType);
}
private static void throwConversionError(Class fromType, Class toType, String propertyName)
throws ExprValidationException
{
String text = "Implicit conversion from datatype '" +
fromType.getSimpleName() +
"' to '" +
toType.getSimpleName() +
"' for property '" +
propertyName +
"' is not allowed (strict filter type coercion)";
throw new ExprValidationException(text);
}
// expressions automatically coerce to the most upwards type
// filters require the same type
private static Object handleConstantsCoercion(ExprIdentNode identNode, Object constant)
throws ExprValidationException
{
Class identNodeType = identNode.getType();
if (!JavaClassHelper.isNumeric(identNodeType))
{
return constant; // no coercion required, other type checking performed by expression this comes from
}
if (constant == null) // null constant type
{
return null;
}
if (!JavaClassHelper.canCoerce(constant.getClass(), identNodeType))
{
throwConversionError(constant.getClass(), identNodeType, identNode.getResolvedPropertyName());
}
Class identNodeTypeBoxed = JavaClassHelper.getBoxedType(identNodeType);
return JavaClassHelper.coerceBoxed((Number) constant, identNodeTypeBoxed);
}
private static void recursiveAndConstituents(List<ExprNode> constituents, ExprNode exprNode)
{
for (ExprNode inner : exprNode.getChildNodes())
{
if (inner instanceof ExprAndNode)
{
recursiveAndConstituents(constituents, inner);
}
else
{
constituents.add(inner);
}
}
}
}
The table below shows all metrics for FilterSpecCompiler.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 85.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 79.00 | Comment lines | |
| COMMENT_DENSITY | 0.28 | Comment density | |
| COMPARISONS | 46.00 | Number of comparison operators | |
| CYCLOMATIC | 77.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 9.00 | Comments in declarations | |
| DOC_COMMENT | 47.00 | Number of javadoc comment lines | |
| ELOC | 283.00 | Effective lines of code | |
| EXEC_COMMENTS | 20.00 | Comments in executable code | |
| EXITS | 79.00 | Procedure exits | |
| FUNCTIONS | 16.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 74.21 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 111.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 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 1.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 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 1.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 | 1.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 | 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 | 1.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 | 13.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 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 2.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 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 595.00 | Number of lines in the source file | |
| LINE_COMMENT | 32.00 | Number of line comments | |
| LOC | 455.00 | Lines of code | |
| LOGICAL_LINES | 168.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 997.00 | Number of operands | |
| OPERATORS | 1773.00 | Number of operators | |
| PARAMS | 41.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2770.00 | Halstead program length | |
| PROGRAM_VOCAB | 355.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 70.00 | Number of return points from functions | |
| SIZE | 26423.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 309.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 46.00 | Number of unique operators | |
| WHITESPACE | 61.00 | Number of whitespace lines | |