StructureImpl.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.structure |
 |
 |
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 | |
|---|---|---|
| RETURNS | Number of return points from functions |  |
| LINE_COMMENT | Number of line comments | |
| EXEC_COMMENTS | Comments in executable code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| LINES | Number of lines in the source file | |
| EXITS | Procedure exits | |
| COMMENTS | Comment lines | |
| LOC | Lines of code | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| LOGICAL_LINES | Number of statements | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOOPS | Number of loops | |
| COMPARISONS | Number of comparison operators | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| BLOCKS | Number of blocks | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
/*
* $Header$
* $Revision: 356258 $
* $Date: 2005-12-12 09:29:55 -0500 (Mon, 12 Dec 2005) $
*
* ====================================================================
*
* Copyright 1999-2002 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.structure;
import java.util.ArrayList;
import java.util.Date;
import java.util.Enumeration;
import java.util.List;
import java.util.Vector;
import org.apache.slide.common.Domain;
import org.apache.slide.common.Namespace;
import org.apache.slide.common.NamespaceConfig;
import org.apache.slide.common.ServiceAccessException;
import org.apache.slide.common.SlideToken;
import org.apache.slide.common.Uri;
import org.apache.slide.common.UriPath;
import org.apache.slide.common.UriTokenizer;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.content.NodeRevisionNumber;
import org.apache.slide.content.RevisionDescriptorNotFoundException;
import org.apache.slide.event.EventDispatcher;
import org.apache.slide.event.StructureEvent;
import org.apache.slide.event.VetoException;
import org.apache.slide.lock.Lock;
import org.apache.slide.lock.ObjectLockedException;
import org.apache.slide.security.AccessDeniedException;
import org.apache.slide.security.Security;
import org.apache.slide.store.ResourceId;
import org.apache.slide.store.Store;
import org.apache.slide.util.Configuration;
/**
* Default implementation of the Structure interface.
*
* @version $Revision: 356258 $
*/
public class StructureImpl implements Structure {
// ----------------------------------------------------------- Constructors
/**
* Constructor.
*
* @param namespace
* the namespace associated with the helper object
* @param namespaceConfig
* configuration of the namespace
* @param securityHelper
* the associated security helper
* @param lockHelper
* the associated lock helper
*/
public StructureImpl(Namespace namespace, NamespaceConfig namespaceConfig,
Security securityHelper, Lock lockHelper) {
this.namespace = namespace;
this.namespaceConfig = namespaceConfig;
this.securityHelper = securityHelper;
this.lockHelper = lockHelper;
}
// ----------------------------------------------------- Instance Variables
/**
* Namespace.
*/
private Namespace namespace;
/**
* Namespace configuration.
*/
private NamespaceConfig namespaceConfig;
/**
* Security helper.
*/
private Security securityHelper;
/**
* Lock helper.
*/
private Lock lockHelper;
// ------------------------------------------------------ Structure Methods
public String generateUniqueUri(SlideToken token, String parentUri)
throws ServiceAccessException {
String sequenceName = parentUri.replace('/', '-');
Uri uri = namespace.getUri(token, parentUri);
Store store = uri.getStore();
if (!store.isSequenceSupported()) {
return null;
} else {
if (!store.sequenceExists(sequenceName)) {
store.createSequence(sequenceName);
}
long next = store.nextSequenceValue(sequenceName);
String uniqueUri = parentUri + "/" + next;
return uniqueUri;
}
}
public Enumeration getChildren(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException, VetoException {
Enumeration childrenUri = object.enumerateChildren();
Vector result = new Vector();
while (childrenUri.hasMoreElements()) {
String childUri = (String) childrenUri.nextElement();
try {
ObjectNode child = retrieve(token, childUri, false);
result.addElement(child);
} catch (AccessDeniedException e) {
}
}
return result.elements();
}
public ObjectNode getParent(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException, AccessDeniedException, VetoException {
String objectUriStr = object.getUri();
Uri parentUri = namespace.getUri(token, objectUriStr).getParentUri();
if (parentUri == null) {
return null;
}
String parentUriStr = parentUri.toString();
ObjectNode parent = retrieve(token, parentUriStr);
return parent;
}
public ObjectNode retrieve(SlideToken token, String strUri)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException, AccessDeniedException, VetoException {
return retrieve(token, strUri, true);
}
public ObjectNode retrieve(SlideToken token, String strUri,
boolean translateLastUriElement) throws ServiceAccessException,
ObjectNotFoundException, LinkedObjectNotFoundException,
AccessDeniedException, VetoException {
Uri uri = namespace.getUri(token, strUri);
ObjectNode result = null;
// Fire event
if (StructureEvent.RETRIEVE.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.RETRIEVE,
new StructureEvent(this, token, namespace, strUri));
// First of all, we try to load the object directly from the given Uri.
try {
result = uri.getStore().retrieveObject(uri);
securityHelper.checkCredentials(token, result, namespaceConfig
.getReadObjectAction());
if ((translateLastUriElement) && (result instanceof LinkNode)) {
LinkNode link = (LinkNode) result;
Uri linkedUri = namespace.getUri(token, link.getLinkedUri());
result = linkedUri.getStore().retrieveObject(linkedUri);
securityHelper.checkCredentials(token, result, namespaceConfig
.getReadObjectAction());
}
} catch (ObjectNotFoundException e) {
}
// If the attempt to load the uri failed, it means there is at least
// one link in the uri (or that the uri doe'sn't have any associated
// object).
if (result == null) {
String resolvedUri = uri.toString();
// 1 - Tokemization of the Uri
UriTokenizer uriTokenizer = new UriTokenizer(token, uri
.getNamespace(), resolvedUri);
// 2 - For each element of the Uri
Uri courUri = null;
ObjectNode courObject = null;
while (uriTokenizer.hasMoreElements()) {
// 3 - Load object's class from the uri. If the object
// does not exist, a DataException is thrown.
courUri = uriTokenizer.nextUri();
courObject = courUri.getStore().retrieveObject(courUri);
// We check to see if the credentials gives access to
// the current object
if (Domain.getParameter("ancestors-read-permissions-required",
"true").equals("true")) {
securityHelper.checkCredentials(token, courObject,
namespaceConfig.getReadObjectAction());
}
// 4 - Test if object is a link, ie if it is an instance
// of LinkNode or one of its subclasses
if (((translateLastUriElement) && (courObject instanceof LinkNode))
|| ((!translateLastUriElement)
&& (uriTokenizer.hasMoreElements()) && (courObject instanceof LinkNode))) {
// 5 - If the object is a link, we get the uri of
// the linked object
// Note : courUri still IS the Uri of the link, and so,
// in a way courUri is the parent of linkedUri.
Uri linkedUri = namespace.getUri(token,
((LinkNode) courObject).getLinkedUri());
// 6 - We replace the courUri scope in the original uri
String courStrUri = courUri.toString();
resolvedUri = linkedUri.toString()
+ resolvedUri.substring(courStrUri.length());
// 7 - We tokenize again the uri
uriTokenizer = new UriTokenizer(token, uri.getNamespace(),
resolvedUri);
// 8 - We parse it till we get back to the point
// where we stopped
boolean isUriFound = false;
while ((!isUriFound) && (uriTokenizer.hasMoreElements())) {
if (linkedUri.equals(uriTokenizer.nextUri())) {
isUriFound = true;
}
}
if (!isUriFound) {
throw new LinkedObjectNotFoundException(courUri,
resolvedUri);
}
}
// 9 - We continue to go down in the Uri tree
}
// 10 - We return the last object which has been found
result = courObject;
}
return result;
}
public void create(SlideToken token, ObjectNode object, String strUri)
throws ServiceAccessException, ObjectAlreadyExistsException,
ObjectNotFoundException, LinkedObjectNotFoundException,
AccessDeniedException, ObjectLockedException, VetoException {
// Fire event
if (StructureEvent.CREATE.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.CREATE,
new StructureEvent(this, token, namespace, strUri));
// Checking roles
Enumeration roles = securityHelper.getRoles(object);
while (roles.hasMoreElements()) {
if (!securityHelper.hasRole(token, (String) roles.nextElement())) {
// Allow only the namespace admin to create roles
// he doesn't have
Uri rootUri = namespace.getUri(token, "/");
ObjectNode rootObject = rootUri.getStore().retrieveObject(
rootUri);
securityHelper.checkCredentials(token, rootObject,
namespaceConfig.getGrantPermissionAction());
break;
}
}
String resolvedUri = strUri;
// 1 - Tokenization of the Uri
UriTokenizer uriTokenizer = new UriTokenizer(token, namespace,
resolvedUri);
// 2 - For each element of the Uri
Uri courUri = null;
ObjectNode courObject = null;
ObjectNode parentObject = null;
boolean alreadyExists = false;
while (uriTokenizer.hasMoreElements()) {
parentObject = courObject;
// 3 - Load object's class from the uri. If the object does
// not exist, a DataException is thrown.
courUri = uriTokenizer.nextUri();
try {
courObject = courUri.getStore().retrieveObject(courUri);
if (Domain.getParameter("ancestors-read-permissions-required",
"true").equals("true")) {
securityHelper.checkCredentials(token, courObject,
namespaceConfig.getReadObjectAction());
}
if (!uriTokenizer.hasMoreElements()) {
// The object already exists
alreadyExists = true;
}
} catch (ObjectNotFoundException e) {
// Load failed, probably because object was not found
// We try to create a new one.
// We have to test if the uri is the last in the list,
// we must create the requested element.
// By default, we create a SubjectNode.
ObjectNode newObject = null;
if (uriTokenizer.hasMoreElements()) {
throw new ObjectNotFoundException(courUri);
} else {
newObject = object;
}
if (parentObject != null) {
securityHelper.checkCredentials(token, courObject,
namespaceConfig.getBindMemberAction());
// Now creating the new object
newObject.setUri(courUri.toString());
courUri.getStore().createObject(courUri, newObject);
// re-read to obtain UURI
// newObject = courUri.getStore().retrieveObject(courUri);
// re-read the parent taking the forceEnlistment flag into
// account
Uri parentUri = namespace.getUri(token, parentObject
.getUri());
parentObject = parentUri.getStore().retrieveObject(
parentUri);
// Add the newly created object to its parent's
// children list
ObjectNode oldChild = null;
// we can check the parentUri, it's in the same store as
// newObject
if (Configuration.useBinding(parentUri.getStore())) {
String bindingName = newObject.getPath().lastSegment();
if (parentObject.hasBinding(bindingName)) {
oldChild = retrieve(token, parentObject.getUri()
+ "/" + bindingName, false);
parentObject.removeChild(oldChild);
store(token, oldChild);
}
}
lockHelper.checkLock(token, parentObject, namespaceConfig
.getCreateObjectAction());
parentObject.addChild(newObject);
// namespace.getUri(token, parentObject.getUri())
// .getDataSource().storeObject(parentObject, false);
store(token, parentObject, true);
store(token, newObject);
} else {
throw new ObjectNotFoundException(courUri);
}
courObject = newObject;
}
// 4 - Test if object is a link, ie if it is an instance of
// LinkNode or one of its subclasses
if ((uriTokenizer.hasMoreElements())
&& (courObject instanceof LinkNode)) {
// 5 - If the object is a link, we get the uri of the
// linked object
// Note : courUri still IS the Uri of the link, and so,
// in a way courUri is the parent of linkedUri.
Uri linkedUri = namespace.getUri(token, ((LinkNode) courObject)
.getLinkedUri());
// 6 - We replace the courUri scope in the original uri
String courStrUri = courUri.toString();
resolvedUri = linkedUri.toString()
+ resolvedUri.substring(courStrUri.length());
// 7 - We tokenize again the uri
uriTokenizer = new UriTokenizer(token, namespace, resolvedUri);
// 8 - We parse it till we get back to the point
// where we stopped
boolean isUriFound = false;
while ((!isUriFound) && (uriTokenizer.hasMoreElements())) {
if (linkedUri.equals(uriTokenizer.nextUri())) {
isUriFound = true;
}
}
if (!isUriFound) {
throw new LinkedObjectNotFoundException(courUri,
resolvedUri);
}
}
// 9 - We continue to go down in the Uri tree
}
if (alreadyExists) {
if (courUri.isStoreRoot()) {
// if the object already exists map it anyway into
// the node hierarchy, to prevent loose of nodes
// during start up
if (parentObject != null && !parentObject.hasChild(courObject)) {
parentObject.addChild(courObject);
store(token, parentObject, true);
}
}
throw new ObjectAlreadyExistsException(strUri);
}
}
public void createLink(SlideToken token, LinkNode link, String linkUri,
ObjectNode linkedObject) throws ServiceAccessException,
ObjectAlreadyExistsException, ObjectNotFoundException,
LinkedObjectNotFoundException, AccessDeniedException,
ObjectLockedException, VetoException {
link.setLinkedUri(linkedObject.getUri());
// Fire event
if (StructureEvent.CREATE.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.CREATE_LINK,
new StructureEvent(this, token, link, linkUri));
create(token, link, linkUri);
}
public void store(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
AccessDeniedException, LinkedObjectNotFoundException, VetoException {
store(token, object, false);
}
protected void store(SlideToken token, ObjectNode object,
boolean setModificationDate) throws ServiceAccessException,
ObjectNotFoundException, AccessDeniedException,
LinkedObjectNotFoundException, VetoException {
// Fire event
if (StructureEvent.STORE.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.STORE,
new StructureEvent(this, token, namespace, object));
// Checking roles
Enumeration roles = securityHelper.getRoles(object);
while (roles.hasMoreElements()) {
if (!securityHelper.hasRole(token, (String) roles.nextElement())) {
// Allow only the namespace admin to create roles
// he doesn't have
Uri rootUri = namespace.getUri(token, "/");
ObjectNode rootObject = rootUri.getStore().retrieveObject(
rootUri);
securityHelper.checkCredentials(token, rootObject,
namespaceConfig.getGrantPermissionAction());
break;
}
}
// working on realObject, we will lose changes immediatly done before
// call of store
// i observerd this with some BIND testcases
// ObjectNode realObject = retrieve(token, object.getUri(), false);
securityHelper.checkCredentials(token, object, namespaceConfig
.getCreateObjectAction());
Uri uri = namespace.getUri(token, object.getUri());
Store store = uri.getStore();
store.storeObject(uri, object);
if (setModificationDate) {
try {
NodeRevisionDescriptor revisionDescriptor = store
.retrieveRevisionDescriptor(uri,
new NodeRevisionNumber());
revisionDescriptor.setModificationDate(new Date());
revisionDescriptor.setModificationUser(securityHelper
.getPrincipal(token).getPath().lastSegment());
store.storeRevisionDescriptor(uri, revisionDescriptor);
} catch (RevisionDescriptorNotFoundException e) {
// ignore silently
}
}
}
/**
* Method remove
*
* @param token
* a SlideToken
* @param object
* an ObjectNode
*
* @throws ServiceAccessException
* @throws ObjectNotFoundException
* @throws ObjectHasChildrenException
* @throws AccessDeniedException
* @throws LinkedObjectNotFoundException
* @throws ObjectLockedException
*
*/
public void remove(SlideToken token, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException,
ObjectHasChildrenException, AccessDeniedException,
LinkedObjectNotFoundException, ObjectLockedException, VetoException {
ObjectNode nodeToDelete = retrieve(token, object.getUri(), false);
Uri uri = namespace.getUri(token, nodeToDelete.getUri());
// Fire event
if (StructureEvent.REMOVE.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.REMOVE,
new StructureEvent(this, token, object, uri.toString()));
if (!object.getUri().equals("/")) {
Uri curUri = namespace.getUri(token, nodeToDelete.getUri());
Uri parentUri = curUri.getParentUri();
ObjectNode parentNode = parentUri.getStore().retrieveObject(
parentUri);
securityHelper.checkCredentials(token, nodeToDelete,
namespaceConfig.getRemoveObjectAction());
securityHelper.checkCredentials(token, parentNode, namespaceConfig
.getUnbindMemberAction());
lockHelper.checkLock(token, nodeToDelete, namespaceConfig
.getRemoveObjectAction());
lockHelper.checkLock(token, parentNode, namespaceConfig
.getUnbindMemberAction());
parentNode.removeChild(nodeToDelete);
store(token, parentNode, true);
if (Configuration.useBinding(curUri.getStore())
&& nodeToDelete.numberOfParentBindings() > 0) {
store(token, nodeToDelete);
} else {
Enumeration children = nodeToDelete.enumerateChildren();
if (children.hasMoreElements()) {
throw new ObjectHasChildrenException(uri);
}
uri.getStore().removeObject(uri, nodeToDelete);
}
}
}
/**
* Modifies the collection identified by <b>collectionNode</b>, by adding a
* new binding from the specified segment to the resource identified by
* <b>sourceNode</b>.
*
* @param token
* a SlideToken
* @param collectionNode
* an ObjectNode
* @param segment
* a String
* @param sourceNode
* an ObjectNode
*
* @throws ServiceAccessException
* @throws ObjectNotFoundException
* @throws AccessDeniedException
* @throws LinkedObjectNotFoundException
* @throws ObjectLockedException
*
*/
public void addBinding(SlideToken token, ObjectNode collectionNode,
String segment, ObjectNode sourceNode)
throws ServiceAccessException, ObjectNotFoundException,
AccessDeniedException, LinkedObjectNotFoundException,
ObjectLockedException, CrossServerBindingException, VetoException {
if (Configuration.useBinding(namespace.getUri(token,
collectionNode.getUri()).getStore())) {
collectionNode = retrieve(token, collectionNode.getUri(), false);
sourceNode = retrieve(token, sourceNode.getUri(), false);
Uri collectionUri = namespace
.getUri(token, collectionNode.getUri());
// Uri sourceUri = namespace.getUri(token, sourceNode.getUri());
// Fire event
if (StructureEvent.ADD_BINDING.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.ADD_BINDING,
new StructureEvent(this, token, sourceNode,
collectionUri.toString()));
// if (collectionUri.getStore() != sourceUri.getStore()) {
// throw new CrossServerBindingException(collectionNode.getUri(),
// sourceNode.getUri());
// }
lockHelper.checkLock(token, collectionNode, namespaceConfig
.getCreateObjectAction());
ObjectNode oldChild = null;
if (collectionNode.hasBinding(segment)) {
oldChild = retrieve(token, collectionNode.getUri() + "/"
+ segment, false);
lockHelper.checkLock(token, oldChild, namespaceConfig
.getCreateObjectAction());
collectionNode.removeChild(oldChild);
store(token, oldChild);
}
collectionNode.addBinding(segment, sourceNode);
store(token, collectionNode, true);
store(token, sourceNode);
}
}
/**
* Modifies the collection identified by <b>collectionNode</b>, by removing
* the binding for the specified segment.
*
* @param token
* a SlideToken
* @param collectionNode
* an ObjectNode
* @param segment
* a String
*
* @throws ServiceAccessException
* @throws ObjectNotFoundException
* @throws AccessDeniedException
* @throws LinkedObjectNotFoundException
* @throws ObjectLockedException
*
*/
public void removeBinding(SlideToken token, ObjectNode collectionNode,
String segment) throws ServiceAccessException,
ObjectNotFoundException, AccessDeniedException,
LinkedObjectNotFoundException, ObjectLockedException, VetoException {
if (Configuration.useBinding(namespace.getUri(token,
collectionNode.getUri()).getStore())) {
collectionNode = retrieve(token, collectionNode.getUri(), false);
ObjectNode childNode = retrieve(token, collectionNode.getUri()
+ "/" + segment, false);
// Fire event
if (StructureEvent.REMOVE_BINDING.isEnabled())
EventDispatcher.getInstance().fireVetoableEvent(
StructureEvent.REMOVE_BINDING,
new StructureEvent(this, token, childNode,
collectionNode.getUri()));
lockHelper.checkLock(token, collectionNode, namespaceConfig
.getCreateObjectAction());
lockHelper.checkLock(token, childNode, namespaceConfig
.getCreateObjectAction());
collectionNode.removeChild(childNode);
store(token, childNode);
store(token, collectionNode, true);
}
}
/**
* Return all parents of this object node. If pathOnly=true, only parents on
* the path of the specified ObjectNode are returned, all parents (binding!)
* otherwise. If storeOnly=true, only parents within the scope of the store
* in charge of the specified ObjectNode are returned, parents up to the
* root ObjectNode (uri="/") otherwise.
*
* @param token
* a SlideToken
* @param object
* an ObjectNode
* @param pathOnly
* if true, only parents on the path of the specified ObjectNode
* are returned, all parents (binding!) otherwise
* @param storeOnly
* if true, only parents within the scope of the store in charge
* of the specified ObjectNode are returned, parents up to the
* root ObjectNode (uri="/") otherwise
* @param includeSelf
* if true, the ObjectNode specified by object is included,
* otherwise, it is excluded
*
* @return a List of ObjectNode instances
*
* @throws ServiceAccessException
* @throws ObjectNotFoundException
* @throws LinkedObjectNotFoundException
* @throws AccessDeniedException
*
*/
public List getParents(SlideToken token, ObjectNode object,
boolean pathOnly, boolean storeOnly, boolean includeSelf)
throws ServiceAccessException, ObjectNotFoundException,
LinkedObjectNotFoundException, AccessDeniedException, VetoException {
List result = new ArrayList();
if (pathOnly) {
String[] uriTokens = object.getPath().tokens();
UriPath path = new UriPath("/");
Uri currentUri = namespace.getUri(token, path.toString());
Uri objectUri = namespace.getUri(token, object.getUri());
if (!storeOnly || currentUri.getStore() == objectUri.getStore()) {
result.add(retrieve(token, path.toString()));
}
for (int i = 0; i < uriTokens.length; i++) {
path = path.child(uriTokens[i]);
currentUri = namespace.getUri(token, path.toString());
if (i == uriTokens.length - 1 && !includeSelf) {
break;
}
if (!storeOnly || currentUri.getStore() == objectUri.getStore()) {
result.add(retrieve(token, path.toString()));
}
}
} else {
// TODO
}
return result;
}
}
The table below shows all metrics for StructureImpl.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 69.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 220.00 | Comment lines | |
| COMMENT_DENSITY | 0.60 | Comment density | |
| COMPARISONS | 52.00 | Number of comparison operators | |
| CYCLOMATIC | 79.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 14.00 | Comments in declarations | |
| DOC_COMMENT | 114.00 | Number of javadoc comment lines | |
| ELOC | 368.00 | Effective lines of code | |
| EXEC_COMMENTS | 47.00 | Comments in executable code | |
| EXITS | 67.00 | Procedure exits | |
| FUNCTIONS | 14.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 109.95 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 263.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 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 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 7.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 2.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 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 | 1.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 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 5.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.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 | 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 | 1819.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 | 1.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 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 1.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 | 742.00 | Number of lines in the source file | |
| LINE_COMMENT | 84.00 | Number of line comments | |
| LOC | 429.00 | Lines of code | |
| LOGICAL_LINES | 195.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1179.00 | Number of operands | |
| OPERATORS | 1978.00 | Number of operators | |
| PARAMS | 41.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3157.00 | Halstead program length | |
| PROGRAM_VOCAB | 299.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 222.00 | Number of return points from functions | |
| SIZE | 24601.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 252.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 47.00 | Number of unique operators | |
| WHITESPACE | 93.00 | Number of whitespace lines | |