TaggingServiceImpl.java
| Index Score | ||
|---|---|---|
 |
 |
org.alfresco.repo.tagging |
 |
 |
Alfresco |
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 | |
|---|---|---|
| JAVA0081 | JAVA0081 Boolean literal in comparison |  |
| EXEC_COMMENTS | Comments in executable code | |
| DECL_COMMENTS | Comments in declarations | |
| LINE_COMMENT | Number of line comments | |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| OPERANDS | Number of operands | |
| LINES | Number of lines in the source file | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| EXITS | Procedure exits | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| COMMENTS | Comment lines | |
| FUNCTIONS | Number of function declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| COMPARISONS | Number of comparison operators | |
| JAVA0111 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOOPS | Number of loops | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (C) 2005-2008 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.repo.tagging;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.node.NodeServicePolicies;
import org.alfresco.repo.policy.JavaBehaviour;
import org.alfresco.repo.policy.PolicyComponent;
import org.alfresco.repo.policy.Behaviour.NotificationFrequency;
import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
import org.alfresco.repo.transaction.RetryingTransactionHelper;
import org.alfresco.repo.transaction.TransactionListener;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionService;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.Path;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.search.CategoryService;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.cmr.tagging.TagDetails;
import org.alfresco.service.cmr.tagging.TagScope;
import org.alfresco.service.cmr.tagging.TaggingService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.ISO9075;
/**
* Tagging service implementation
*
* @author Roy Wetherall
*/
public class TaggingServiceImpl implements TaggingService,
TransactionListener,
NodeServicePolicies.BeforeDeleteNodePolicy
{
/** Node service */
private NodeService nodeService;
/** Categorty Service */
private CategoryService categoryService;
/** Search Service */
private SearchService searchService;
/** Action Service */
private ActionService actionService;
/** Content Service */
private ContentService contentService;
/** Namespace Service */
private NamespaceService namespaceService;
/** Policy componenet */
private PolicyComponent policyComponent;
private TransactionService transactionService;
/** Tag Details Delimiter */
private static final String TAG_DETAILS_DELIMITER = "|";
/**
* Set the cateogry service
*
* @param categoryService trhe category service
*/
public void setCategoryService(CategoryService categoryService)
{
this.categoryService = categoryService;
}
/**
* Set the node service
*
* @param nodeService the node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* Set the search service
*
* @param searchService the search service
*/
public void setSearchService(SearchService searchService)
{
this.searchService = searchService;
}
/**
* Set the action service
*
* @return ActionService action service
*/
public void setActionService(ActionService actionService)
{
this.actionService = actionService;
}
/**
* Set the content service
*
* @param contentService content service
*/
public void setContentService(ContentService contentService)
{
this.contentService = contentService;
}
/**
* Set the namespace service
*
* @param namespaceService namespace service
*/
public void setNamespaceService(NamespaceService namespaceService)
{
this.namespaceService = namespaceService;
}
/**
* Policy component
*
* @param policyComponent
*/
public void setPolicyComponent(PolicyComponent policyComponent)
{
this.policyComponent = policyComponent;
}
public void setTransactionService(TransactionService transactionService)
{
this.transactionService = transactionService;
}
/**
* Init method
*/
public void init()
{
// Register policy behaviours
this.policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "beforeDeleteNode"),
ContentModel.ASPECT_TAGGABLE,
new JavaBehaviour(this, "beforeDeleteNode", NotificationFrequency.FIRST_EVENT));
}
/**
* @see org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy#beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef)
*/
public void beforeDeleteNode(NodeRef nodeRef)
{
if (this.nodeService.exists(nodeRef) == true &&
this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGGABLE) == true)
{
ChildAssociationRef assocRef = this.nodeService.getPrimaryParent(nodeRef);
if (assocRef != null)
{
NodeRef parent = assocRef.getParentRef();
if (parent != null)
{
List<String> tags = getTags(nodeRef);
Map<String, Boolean> tagUpdates = new HashMap<String, Boolean>(tags.size());
for (String tag : tags)
{
tagUpdates.put(tag, Boolean.FALSE);
}
updateTagScope(parent, tagUpdates, false);
}
}
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#isTag(java.lang.String)
*/
public boolean isTag(StoreRef storeRef, String tag)
{
// Lower the case of the tag
tag = tag.toLowerCase();
return (getTagNodeRef(storeRef, tag) != null);
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#createTag(java.lang.String)
*/
public void createTag(StoreRef storeRef, String tag)
{
// Lower the case of the tag
tag = tag.toLowerCase();
if (isTag(storeRef, tag) == false)
{
this.categoryService.createRootCategory(storeRef, ContentModel.ASPECT_TAGGABLE, tag);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#deleteTag(org.alfresco.service.cmr.repository.StoreRef, java.lang.String)
*/
public void deleteTag(StoreRef storeRef, String tag)
{
// Lower the case of the tag
tag = tag.toLowerCase();
NodeRef tagNodeRef = getTagNodeRef(storeRef, tag);
if (tagNodeRef != null)
{
this.categoryService.deleteCategory(tagNodeRef);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#getTags()
*/
public List<String> getTags(StoreRef storeRef)
{
Collection<ChildAssociationRef> rootCategories = this.categoryService.getRootCategories(storeRef, ContentModel.ASPECT_TAGGABLE);
List<String> result = new ArrayList<String>(rootCategories.size());
for (ChildAssociationRef rootCategory : rootCategories)
{
String name = (String)this.nodeService.getProperty(rootCategory.getChildRef(), ContentModel.PROP_NAME);
result.add(name);
}
return result;
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#getTags(org.alfresco.service.cmr.repository.StoreRef, java.lang.String)
*/
public List<String> getTags(StoreRef storeRef, String filter)
{
Collection<ChildAssociationRef> rootCategories = this.categoryService.getRootCategories(storeRef, ContentModel.ASPECT_TAGGABLE);
List<String> result = new ArrayList<String>(rootCategories.size());
for (ChildAssociationRef rootCategory : rootCategories)
{
String name = (String)this.nodeService.getProperty(rootCategory.getChildRef(), ContentModel.PROP_NAME);
if (name.contains(filter.toLowerCase()) == true)
{
result.add(name);
}
}
return result;
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#addTag(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
*/
public void addTag(final NodeRef nodeRef, final String tagName)
{
// Lower the case of the tag
String tag = tagName.toLowerCase();
// Get the tag node reference
NodeRef newTagNodeRef = getTagNodeRef(nodeRef.getStoreRef(), tag);
if (newTagNodeRef == null)
{
// Create the new tag
newTagNodeRef = categoryService.createRootCategory(nodeRef.getStoreRef(), ContentModel.ASPECT_TAGGABLE, tag);
}
List<NodeRef> tagNodeRefs = new ArrayList(5);
if (nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGGABLE) == false)
{
// Add the aspect
nodeService.addAspect(nodeRef, ContentModel.ASPECT_TAGGABLE, null);
}
else
{
// Get the current tags
List<NodeRef> currentTagNodes = (List<NodeRef>)nodeService.getProperty(nodeRef, ContentModel.PROP_TAGS);
if (currentTagNodes != null)
{
tagNodeRefs = currentTagNodes;
}
}
// Add the new tag (assuming it's not already been added
if (tagNodeRefs.contains(newTagNodeRef) == false)
{
tagNodeRefs.add(newTagNodeRef);
nodeService.setProperty(nodeRef, ContentModel.PROP_TAGS, (Serializable)tagNodeRefs);
queueTagUpdate(nodeRef, tag, true);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#addTags(org.alfresco.service.cmr.repository.NodeRef, java.util.List)
*/
public void addTags(NodeRef nodeRef, List<String> tags)
{
for (String tag : tags)
{
addTag(nodeRef, tag);
}
}
/**
* Gets the node reference for a given tag.
* <p>
* Returns null if tag is not present.
*
* @param storeRef store reference
* @param tag tag
* @return NodeRef tag node reference or null not exist
*/
private NodeRef getTagNodeRef(StoreRef storeRef, String tag)
{
NodeRef tagNodeRef = null;
String query = "+PATH:\"cm:taggable/cm:" + ISO9075.encode(tag) + "\"";
ResultSet resultSet = this.searchService.query(storeRef, SearchService.LANGUAGE_LUCENE, query);
if (resultSet.length() != 0)
{
tagNodeRef = resultSet.getNodeRef(0);
}
return tagNodeRef;
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#removeTag(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
*/
public void removeTag(NodeRef nodeRef, String tag)
{
// Lower the case of the tag
tag = tag.toLowerCase();
// Check for the taggable aspect
if (this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGGABLE) == true)
{
// Get the tag node reference
NodeRef newTagNodeRef = getTagNodeRef(nodeRef.getStoreRef(), tag);
if (newTagNodeRef != null)
{
// Get the current tags
List<NodeRef> currentTagNodes = (List<NodeRef>)this.nodeService.getProperty(nodeRef, ContentModel.PROP_TAGS);
if (currentTagNodes != null &&
currentTagNodes.size() != 0 &&
currentTagNodes.contains(newTagNodeRef) == true)
{
currentTagNodes.remove(newTagNodeRef);
this.nodeService.setProperty(nodeRef, ContentModel.PROP_TAGS, (Serializable)currentTagNodes);
queueTagUpdate(nodeRef, tag, false);
}
}
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#removeTags(org.alfresco.service.cmr.repository.NodeRef, java.util.List)
*/
public void removeTags(NodeRef nodeRef, List<String> tags)
{
for (String tag : tags)
{
removeTag(nodeRef, tag);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#getTags(org.alfresco.service.cmr.repository.NodeRef)
*/
public List<String> getTags(NodeRef nodeRef)
{
List<String> result = new ArrayList<String>(10);
// Check for the taggable aspect
if (this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGGABLE) == true)
{
// Get the current tags
List<NodeRef> currentTagNodes = (List<NodeRef>)this.nodeService.getProperty(nodeRef, ContentModel.PROP_TAGS);
if (currentTagNodes != null)
{
for (NodeRef currentTagNode : currentTagNodes)
{
String tag = (String)this.nodeService.getProperty(currentTagNode, ContentModel.PROP_NAME);
result.add(tag);
}
}
}
return result;
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#setTags(org.alfresco.service.cmr.repository.NodeRef, java.util.List)
*/
public void setTags(NodeRef nodeRef, List<String> tags)
{
List<NodeRef> tagNodeRefs = new ArrayList(tags.size());
if (this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGGABLE) == false)
{
// Add the aspect
this.nodeService.addAspect(nodeRef, ContentModel.ASPECT_TAGGABLE, null);
}
// Get the current list of tags
List<String> oldTags = getTags(nodeRef);
for (String tag : tags)
{
// Lower the case of the tag
tag = tag.toLowerCase();
// Get the tag node reference
NodeRef newTagNodeRef = getTagNodeRef(nodeRef.getStoreRef(), tag);
if (newTagNodeRef == null)
{
// Create the new tag
newTagNodeRef = this.categoryService.createRootCategory(nodeRef.getStoreRef(), ContentModel.ASPECT_TAGGABLE, tag);
}
if (tagNodeRefs.contains(newTagNodeRef) == false)
{
// Add to the list
tagNodeRefs.add(newTagNodeRef);
// Trigger scope update
if (oldTags.contains(tag) == false)
{
queueTagUpdate(nodeRef, tag, true);
}
else
{
// Remove the tag from the old list
oldTags.remove(tag);
}
}
}
// Remove the old tags from the tag scope
for (String oldTag : oldTags)
{
queueTagUpdate(nodeRef, oldTag, false);
}
// Update category property
this.nodeService.setProperty(nodeRef, ContentModel.PROP_TAGS, (Serializable)tagNodeRefs);
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#clearTags(org.alfresco.service.cmr.repository.NodeRef)
*/
public void clearTags(NodeRef nodeRef)
{
setTags(nodeRef, Collections.EMPTY_LIST);
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#isTagScope(org.alfresco.service.cmr.repository.NodeRef)
*/
public boolean isTagScope(NodeRef nodeRef)
{
// Determines whether the node has the tag scope aspect
return this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE);
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#addTagScope(org.alfresco.service.cmr.repository.NodeRef)
*/
public void addTagScope(NodeRef nodeRef)
{
if (this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE) == false)
{
// Add the tag scope aspect
this.nodeService.addAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE, null);
// Refresh the tag scope
refreshTagScope(nodeRef, false);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#refreshTagScopt(org.alfresco.service.cmr.repository.NodeRef, boolean)
*/
public void refreshTagScope(NodeRef nodeRef, boolean async)
{
if (this.nodeService.exists(nodeRef) == true &&
this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE) == true)
{
Action action = this.actionService.createAction(RefreshTagScopeActionExecuter.NAME);
this.actionService.executeAction(action, nodeRef, false, async);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#removeTagScope(org.alfresco.service.cmr.repository.NodeRef)
*/
public void removeTagScope(NodeRef nodeRef)
{
if (this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE) == true)
{
this.nodeService.removeAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE);
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#findTagScope(org.alfresco.service.cmr.repository.NodeRef)
*/
public TagScope findTagScope(NodeRef nodeRef)
{
TagScope tagScope = null;
if (this.nodeService.exists(nodeRef) == true)
{
List<NodeRef> tagScopeNodeRefs = new ArrayList<NodeRef>(3);
getTagScopes(nodeRef, tagScopeNodeRefs);
if (tagScopeNodeRefs.size() != 0)
{
tagScope = new TagScopeImpl(tagScopeNodeRefs.get(0), getTagDetails(tagScopeNodeRefs.get(0)));
}
}
return tagScope;
}
/**
* Gets the tag details list for a given tag scope node reference
*
* @param nodeRef tag scope node reference
* @return List<TagDetails> ordered list of tag details for the tag scope
*/
private List<TagDetails> getTagDetails(NodeRef nodeRef)
{
List<TagDetails> tagDetails = new ArrayList<TagDetails>(13);
ContentReader reader = this.contentService.getReader(nodeRef, ContentModel.PROP_TAGSCOPE_CACHE);
if (reader != null)
{
tagDetails = TaggingServiceImpl.readTagDetails(reader.getContentInputStream());
}
return tagDetails;
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#findAllTagScopes(org.alfresco.service.cmr.repository.NodeRef)
*/
public List<TagScope> findAllTagScopes(NodeRef nodeRef)
{
List<TagScope> result = null;
if (this.nodeService.exists(nodeRef) == true)
{
List<NodeRef> tagScopeNodeRefs = new ArrayList<NodeRef>(3);
getTagScopes(nodeRef, tagScopeNodeRefs);
if (tagScopeNodeRefs.size() != 0)
{
result = new ArrayList<TagScope>(tagScopeNodeRefs.size());
for (NodeRef tagScopeNodeRef : tagScopeNodeRefs)
{
result.add(new TagScopeImpl(tagScopeNodeRef, getTagDetails(tagScopeNodeRef)));
}
}
else
{
result = Collections.emptyList();
}
}
return result;
}
/**
* Traverses up the node's primary parent placing all tag scope's in a list.
* <p>
* If none are found then the list is empty.
*
* @param nodeRef node reference
* @param tagScopes list of tag scopes
*/
private void getTagScopes(NodeRef nodeRef, List<NodeRef> tagScopes)
{
if (this.nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TAGSCOPE) == true)
{
tagScopes.add(nodeRef);
}
ChildAssociationRef assoc = this.nodeService.getPrimaryParent(nodeRef);
if (assoc != null)
{
NodeRef parent = assoc.getParentRef();
if (parent != null)
{
getTagScopes(parent, tagScopes);
}
}
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#findTaggedNodes(java.lang.String)
*/
public List<NodeRef> findTaggedNodes(StoreRef storeRef, String tag)
{
// Lower the case of the tag
tag = tag.toLowerCase();
// Do the search for nodes
ResultSet resultSet = this.searchService.query(
storeRef,
SearchService.LANGUAGE_LUCENE,
"+PATH:\"/cm:taggable/cm:" + ISO9075.encode(tag) + "/member\"");
return resultSet.getNodeRefs();
}
/**
* @see org.alfresco.service.cmr.tagging.TaggingService#findTaggedNodes(java.lang.String, org.alfresco.service.cmr.repository.NodeRef)
*/
public List<NodeRef> findTaggedNodes(StoreRef storeRef, String tag, NodeRef nodeRef)
{
// Lower the case of the tag
tag = tag.toLowerCase();
// Get path
Path nodePath = this.nodeService.getPath(nodeRef);
String pathString = nodePath.toPrefixString(this.namespaceService);
// Do query
ResultSet resultSet = this.searchService.query(
storeRef,
SearchService.LANGUAGE_LUCENE,
"+PATH:\"" + pathString + "//*\" +PATH:\"/cm:taggable/cm:" + ISO9075.encode(tag) + "/member\"");
return resultSet.getNodeRefs();
}
/**
* Helper method that takes an input stream and converts it into a list of tag details
*
* @param is input stream
* @return List<TagDetails> list of tag details
*/
/*package*/ static List<TagDetails> readTagDetails(InputStream is)
{
List<TagDetails> result = new ArrayList<TagDetails>(25);
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
try
{
String nextLine = reader.readLine();
while (nextLine != null)
{
String[] values = nextLine.split("\\" + TAG_DETAILS_DELIMITER);
result.add(new TagDetailsImpl(values[0], Integer.parseInt(values[1])));
nextLine = reader.readLine();
}
}
catch (IOException exception)
{
throw new AlfrescoRuntimeException("Unable to read tag details", exception);
}
return result;
}
/**
* Helper method to convert a list of tag details into a string.
*
* @param tagDetails list of tag details
* @return String string of tag details
*/
/*package*/ static String tagDetailsToString(List<TagDetails> tagDetails)
{
StringBuffer result = new StringBuffer(255);
boolean bFirst = true;
for (TagDetails details : tagDetails)
{
if (bFirst == false)
{
result.append("\n");
}
else
{
bFirst = false;
}
result.append(details.getName());
result.append(TAG_DETAILS_DELIMITER);
result.append(details.getCount());
}
return result.toString();
}
// ===== Methods Dealing with TagScope Updates ==== //
public static final String TAG_UPDATES = "tagUpdates";
/**
* Update the relevant tag scopes when a tag is added or removed from a node.
*
* @param nodeRef node reference
* @param updates
* @param async indicates whether the action is execute asynchronously
*/
private void updateTagScope(NodeRef nodeRef, Map<String, Boolean> updates, boolean async)
{
// The map must be serializable
if (updates instanceof HashMap)
{
Action action = this.actionService.createAction(UpdateTagScopesActionExecuter.NAME);
action.setParameterValue(UpdateTagScopesActionExecuter.PARAM_TAG_UPDATES, (HashMap<String, Boolean>)updates);
this.actionService.executeAction(action, nodeRef, false, async);
}
}
private void queueTagUpdate(NodeRef nodeRef, String tag, boolean add)
{
// Get the updates map
Map<NodeRef, Map<String, Boolean>> updates = (Map<NodeRef, Map<String, Boolean>>)AlfrescoTransactionSupport.getResource(TAG_UPDATES);
if (updates == null)
{
updates = new HashMap<NodeRef, Map<String,Boolean>>(10);
AlfrescoTransactionSupport.bindResource(TAG_UPDATES, updates);
AlfrescoTransactionSupport.bindListener(this);
}
// Add the details of the update to the map
Map<String, Boolean> nodeDetails = updates.get(nodeRef);
if (nodeDetails == null)
{
nodeDetails = new HashMap<String, Boolean>(10);
nodeDetails.put(tag, Boolean.valueOf(add));
updates.put(nodeRef, nodeDetails);
}
else
{
Boolean currentValue = nodeDetails.get(tag);
if (currentValue == null)
{
nodeDetails.put(tag, Boolean.valueOf(add));
updates.put(nodeRef, nodeDetails);
}
else if (currentValue.booleanValue() != add)
{
// If the boolean value is different then the tag had been added and removed or
// removed and then added in the same transaction. In both cases the net change is none.
// So remove the entry in the update map
updates.remove(tag);
}
// Otherwise do nothing because we have already noted the update
}
}
// ===== Transaction Listener Callback Methods ===== //
/**
* @see org.alfresco.repo.transaction.TransactionListener#afterCommit()
*/
public void afterCommit()
{
}
/**
* @see org.alfresco.repo.transaction.TransactionListener#afterRollback()
*/
public void afterRollback()
{
}
/**
* @see org.alfresco.repo.transaction.TransactionListener#beforeCommit(boolean)
*/
public void beforeCommit(boolean readOnly)
{
Map<NodeRef, Map<String, Boolean>> updates = (Map<NodeRef, Map<String, Boolean>>)AlfrescoTransactionSupport.getResource(TAG_UPDATES);
if (updates != null)
{
for (NodeRef nodeRef : updates.keySet())
{
Map<String, Boolean> tagUpdates = updates.get(nodeRef);
if (tagUpdates != null && tagUpdates.size() != 0)
{
updateTagScope(nodeRef, tagUpdates, true);
}
}
}
}
/**
* @see org.alfresco.repo.transaction.TransactionListener#beforeCompletion()
*/
public void beforeCompletion()
{
}
/**
* @see org.alfresco.repo.transaction.TransactionListener#flush()
*/
@SuppressWarnings("deprecation")
public void flush()
{
}
}
The table below shows all metrics for TaggingServiceImpl.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 100.00 | Number of blocks | |
| BLOCK_COMMENT | 24.00 | Number of block comment lines | |
| COMMENTS | 238.00 | Comment lines | |
| COMMENT_DENSITY | 0.78 | Comment density | |
| COMPARISONS | 48.00 | Number of comparison operators | |
| CYCLOMATIC | 88.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 52.00 | Comments in declarations | |
| DOC_COMMENT | 171.00 | Number of javadoc comment lines | |
| ELOC | 307.00 | Effective lines of code | |
| EXEC_COMMENTS | 39.00 | Comments in executable code | |
| EXITS | 74.00 | Procedure exits | |
| FUNCTIONS | 42.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 73.49 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 144.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 | 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 | 0.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 | 3.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 | 20.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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 9.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 1.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 1.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 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 1.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 7.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 | 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 | 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 | 838.00 | Number of lines in the source file | |
| LINE_COMMENT | 43.00 | Number of line comments | |
| LOC | 509.00 | Lines of code | |
| LOGICAL_LINES | 190.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1210.00 | Number of operands | |
| OPERATORS | 2062.00 | Number of operators | |
| PARAMS | 56.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3272.00 | Halstead program length | |
| PROGRAM_VOCAB | 397.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 88.00 | Number of return points from functions | |
| SIZE | 29856.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 354.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 43.00 | Number of unique operators | |
| WHITESPACE | 91.00 | Number of whitespace lines | |