AbstractLuceneExpression.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.index.lucene.expressions |
 |
 |
Jakarta Slide |
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 | |
|---|---|---|
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' |  |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0119 | JAVA0119 Control variable changed within body of for loop | |
| EXITS | Procedure exits | |
| OPERANDS | Number of operands | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| JAVA0169 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| UNIQUE_OPERATORS | Number of unique operators | |
| LOGICAL_LINES | Number of statements | |
| JAVA0283 | JAVA0283 Control variable not updated in loop body | |
| LOC | Lines of code | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0080 | JAVA0080 Import declaration not used | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0171 | JAVA0171 Unused local variable | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| DOC_COMMENT | Number of javadoc comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| COMMENTS | Comment lines | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
/*
* $Header$
* $Revision: 510360 $
* $Date: 2007-02-21 21:55:26 -0500 (Wed, 21 Feb 2007) $
*
* ====================================================================
*
* Copyright 1999-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.slide.index.lucene.expressions;
import org.apache.slide.index.lucene.LuceneOrderBy;
import org.apache.slide.index.lucene.LuceneBasicResultSetImpl;
import java.io.IOException;
import java.io.StringReader;
import java.util.Iterator;
import java.util.List;
import java.util.StringTokenizer;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.BooleanClause;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.Hits;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.RangeQuery;
import org.apache.lucene.search.TermQuery;
import org.apache.lucene.search.Sort;
import org.apache.lucene.search.SortField;
import org.apache.slide.search.CompareHint;
import org.apache.slide.common.SlideException;
import org.apache.slide.common.SlideTokenWrapper;
import org.apache.slide.content.NodeProperty;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.index.lucene.Index;
import org.apache.slide.index.lucene.LuceneExpressionFactory;
import org.apache.slide.search.BadQueryException;
import org.apache.slide.search.InvalidQueryException;
import org.apache.slide.search.InvalidScopeException;
import org.apache.slide.search.QueryScope;
import org.apache.slide.search.RequestedResource;
import org.apache.slide.search.SearchException;
import org.apache.slide.search.basic.BasicResultSetImpl;
import org.apache.slide.search.basic.ComparableResourceImpl;
import org.apache.slide.search.basic.IBasicExpression;
import org.apache.slide.search.basic.IBasicExpressionFactory;
import org.apache.slide.search.basic.IBasicQuery;
import org.apache.slide.search.basic.IBasicResultSet;
import org.apache.slide.search.basic.OrderBy;
import org.apache.slide.security.AccessDeniedException;
import org.apache.slide.store.BindingStore;
import org.apache.slide.structure.ObjectNode;
import org.apache.slide.structure.SubjectNode;
import org.apache.slide.util.Configuration;
import org.apache.slide.util.logger.Logger;
import org.apache.slide.content.NodeRevisionNumber;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.Namespace;
import org.jdom.input.SAXBuilder;
/**
*
*/
public abstract class AbstractLuceneExpression implements IBasicExpression {
static final String LOG_CHANNEL = "org.apache.slide.index.lucene.expressions";
protected LuceneExpressionFactory factory;
protected Index index;
private IBasicResultSet resultSet = null;
private Query query;
private SAXBuilder saxBuilder = new SAXBuilder();
public AbstractLuceneExpression(Index index) {
this.index = index;
}
protected final void setQuery(Query query) {
this.query = query;
}
protected final Query getQuery() {
return this.query;
}
public IBasicExpressionFactory getFactory() {
return factory;
}
public void setFactory(IBasicExpressionFactory factory) {
this.factory = (LuceneExpressionFactory) factory;
}
public IBasicResultSet execute() throws SearchException {
return this.execute(null, -1);
}
public IBasicResultSet execute(OrderBy orderBy) throws SearchException {
return this.execute(orderBy, -1);
}
public IBasicResultSet execute(OrderBy orderBy, int limit)
throws SearchException {
if (this.resultSet != null) {
return this.resultSet;
}
Query luceneQuery = this.getQuery();
IBasicQuery q = factory.getQuery();
String scope = q.getSearchToken().getSlideContext().getSlidePath(
q.getScope().getHref());
if (scope.endsWith("/") && scope.length() > 1) {
scope = scope.substring(0, scope.length() - 1);
}
// add a scope restriction, this allows negated queries too
BooleanQuery booleanQuery = new BooleanQuery();
if (luceneQuery != null)
booleanQuery.add(luceneQuery, BooleanClause.Occur.MUST);
if (Configuration.useGlobalBinding()) {
booleanQuery.add(new TermQuery(
new Term(Index.SCOPE_FIELD_NAME, "/")), BooleanClause.Occur.MUST);
booleanQuery
.add(
new RangeQuery(
new Term(Index.DEPTH_FIELD_NAME, index
.getConfiguration()
.intToIndexString(getDepth(scope))),
new Term(
Index.DEPTH_FIELD_NAME,
index
.getConfiguration()
.intToIndexString(
getDepth(scope)
+ q
.getScope()
.getDepth())),
true), BooleanClause.Occur.MUST);
} else {
booleanQuery.add(new TermQuery(new Term(Index.SCOPE_FIELD_NAME,
scope)), BooleanClause.Occur.MUST);
int queryScopeHrefDepth = getDepth(scope);
// add depth restriction
switch (q.getScope().getDepth()) {
case QueryScope.DEPTH_INFINITY:
break;
case QueryScope.DEPTH_0:
booleanQuery.add(new TermQuery(new Term(Index.DEPTH_FIELD_NAME,
index.getConfiguration().intToIndexString(
getDepth(scope)))), BooleanClause.Occur.MUST);
break;
case QueryScope.DEPTH_1:
default:
booleanQuery.add(new RangeQuery(new Term(
Index.DEPTH_FIELD_NAME, index.getConfiguration()
.intToIndexString(getDepth(scope))), new Term(
Index.DEPTH_FIELD_NAME, index.getConfiguration()
.intToIndexString(
getDepth(scope)
+ q.getScope().getDepth())),
true), BooleanClause.Occur.MUST);
}
}
luceneQuery = booleanQuery;
Sort sorter = null;
if (orderBy != null && orderBy instanceof LuceneOrderBy) {
sorter = ((LuceneOrderBy) orderBy).getSorter();
if (index.getLogger().isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
index.getLogger().log(
" Gotten a sorter! from LuceneOrderBy " + sorter,
LOG_CHANNEL, Logger.DEBUG);
}
}
IndexSearcher searcher = null;
try {
if (index.getLogger().isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
index.getLogger().log(
"start query execution: " + luceneQuery.toString(),
LOG_CHANNEL, Logger.DEBUG);
}
long start = System.currentTimeMillis();
searcher = this.index.getSearcher();
Hits hits = null;
if (sorter != null) {
hits = searcher.search(luceneQuery, sorter);
if (index.getLogger().isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
index.getLogger().log(" Query uses sorter! " + sorter,
LOG_CHANNEL, Logger.DEBUG);
}
} else
hits = searcher.search(luceneQuery);
if (index.getLogger().isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
index.getLogger().log(
"finished: " + hits.length() + " hits ("
+ (System.currentTimeMillis() - start) + "ms)",
LOG_CHANNEL, Logger.DEBUG);
}
IBasicResultSet result = new LuceneBasicResultSetImpl(false);
int counter = 0;
for (int i = 0, l = hits.length(); (i < l)
&& (limit < 0 || counter < limit); i++) {
Document doc = hits.doc(i);
String uri = doc.get(Index.URI_FIELD_NAME);
String number = doc.get(Index.REVISION_FIELD_NAME);
NodeRevisionNumber nodeNumber = new NodeRevisionNumber(number);
RequestedResource resource = null;
// TODO: This is just a quick hack to enable DASL with binding
// store
// Please replace with something less evel!
// At least the INDEXED_BINDING_URI_IDENTIFIER prefix should be
// added at indexing time
if (Configuration.useGlobalBinding()) {
resource = createResource(
BindingStore.INDEXED_BINDING_URI_IDENTIFIER
.substring(1)
+ uri, nodeNumber);
if (resource != null) {
try {
NodeProperty parentProperty = resource.getProperty(
"parent-set",
NodeProperty.DEFAULT_NAMESPACE);
String parentValue = "<parents>"
+ parentProperty.getValue() + "</parents>";
// Get bindings for resource
org.jdom.Document parentDocument = saxBuilder
.build(new StringReader(
(String) parentValue));
List parents = parentDocument.getRootElement()
.getChildren();
for (Iterator parentIterator = parents.iterator(); parentIterator
.hasNext();) {
Element parent = (Element) parentIterator
.next();
String href = parent.getChild("href",
Namespace.getNamespace("DAV:"))
.getText();
String segment = parent.getChild("segment",
Namespace.getNamespace("DAV:"))
.getText();
if (href.startsWith(scope)) {
RequestedResource binding = (RequestedResource) resource
.clone();
binding.setUri(href + "/" + segment);
result.add(binding);
counter++;
}
}
} catch (SlideException e) {
throw new SearchException(
"Property 'parent-set' must be present when using binding enabled search",
e);
} catch (JDOMException e) {
throw new SearchException(
"Malformed 'parent-set' property value", e);
}
}
} else {
resource = createResource(uri, nodeNumber);
if (resource != null) {
result.add(resource);
counter++;
}
}
}
this.resultSet = result;
return result;
} catch (InvalidScopeException e) {
throw e;
} catch (SearchException e) {
throw e;
} catch (IOException e) {
throw new SearchException(e);
} finally {
if (searcher != null) {
try {
searcher.close();
} catch (IOException e1) {
// ignore
}
}
}
}
private int getDepth(String path) {
StringTokenizer tokenizer = new StringTokenizer(path, "/");
return tokenizer.countTokens();
}
protected Query negateQuery(Query query) {
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(allQuery(), BooleanClause.Occur.MUST);
booleanQuery.add(query, BooleanClause.Occur.MUST_NOT);
return booleanQuery;
}
protected Query allQuery() {
return new TermQuery(new Term(Index.SCOPE_FIELD_NAME, "/"));
}
protected RequestedResource createResource(String uri,
NodeRevisionNumber nodeNumber) throws SearchException {
ObjectNode node = new SubjectNode(uri); // this will return the root
// folder
RequestedResource resource = null;
IBasicQuery query = factory.getQuery();
SlideTokenWrapper token = new SlideTokenWrapper(query.getSearchToken()
.getSlideToken());
token.setForceLock(false);
try {
// resource = new ComparableResourceImpl(node,
// query.getSearchToken(),
// query.getScope(), factory.getPropertyProvider());
resource = new ComparableResourceImpl(node, query.getSearchToken(),
query.getScope(), factory.getPropertyProvider(), nodeNumber);
} catch (AccessDeniedException e) {
// ignore, just not visible due to permissions
resource = null;
} catch (SlideException e) {
throw new SearchException(e);
}
return resource;
}
protected static Element getFirstElement(Element node) {
List children = node.getChildren();
for (int i = 0; i < children.size(); i++) {
if (children.get(i) instanceof Element) {
return (Element) children.get(i);
}
}
return null;
}
/**
* Returns the first <code>D:prop</code> element.
*
* @param operator
* @return Element
* @throws BadQueryException
* if element not found
*/
public static Element getPropertyElement(Element operator)
throws BadQueryException {
Element prop = operator.getChild("prop",
NodeProperty.NamespaceCache.DEFAULT_NAMESPACE);
if (prop == null)
throw new InvalidQueryException("Missing prop element");
prop = getFirstElement(prop);
if (prop == null)
throw new InvalidQueryException("Empty prop element given");
return prop;
}
/**
* Retruns the first <code>D:literal</code> element.
*
* @param operator
* @return
* @throws BadQueryException
* if element not found
*/
protected Element getLiteralElement(Element operator)
throws BadQueryException {
Element literal = operator.getChild("literal",
NodeProperty.NamespaceCache.DEFAULT_NAMESPACE);
if (literal == null)
throw new InvalidQueryException("Missing literal element");
return literal;
}
protected Element getLiteral2Element(Element operator)
throws BadQueryException {
List children = operator.getChildren("literal",
NodeProperty.NamespaceCache.DEFAULT_NAMESPACE);
if (children.size() > 1) {
return (Element) children.get(1);
} else {
throw new InvalidQueryException("Missing second literal element");
}
}
}
The table below shows all metrics for AbstractLuceneExpression.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 51.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 55.00 | Comment lines | |
| COMMENT_DENSITY | 0.20 | Comment density | |
| COMPARISONS | 35.00 | Number of comparison operators | |
| CYCLOMATIC | 55.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 4.00 | Comments in declarations | |
| DOC_COMMENT | 19.00 | Number of javadoc comment lines | |
| ELOC | 278.00 | Effective lines of code | |
| EXEC_COMMENTS | 8.00 | Comments in executable code | |
| EXITS | 56.00 | Procedure exits | |
| FUNCTIONS | 16.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 86.10 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 39.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 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 1.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 | 1.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 1.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 5.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 3.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 1.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 | 4.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 1.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 | 1.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 | 10.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 2.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 | 1.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 | 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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1202.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 | 1.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 1.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 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 1.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 | 1.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 | 1.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 | 2.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 | 1.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 | 424.00 | Number of lines in the source file | |
| LINE_COMMENT | 14.00 | Number of line comments | |
| LOC | 318.00 | Lines of code | |
| LOGICAL_LINES | 157.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 8.00 | Maximum nesting depth | |
| OPERANDS | 861.00 | Number of operands | |
| OPERATORS | 1424.00 | Number of operators | |
| PARAMS | 14.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2285.00 | Halstead program length | |
| PROGRAM_VOCAB | 300.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 25.00 | Number of return points from functions | |
| SIZE | 13123.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 250.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 51.00 | Number of whitespace lines | |