From 78ba4f6498b45eb8642c95166a4c4c1d67bfe06b Mon Sep 17 00:00:00 2001 From: Steven Glover Date: Fri, 16 Dec 2011 09:38:26 +0000 Subject: [PATCH] ALF-10826: tidy up, added to comments/javadocs git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@32804 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261 --- .../FilenameFilteringInterceptor.java | 4 -- .../repo/model/filefolder/HiddenAspect.java | 48 +++++++------------ .../model/filefolder/HiddenFileFilter.java | 6 +++ .../repo/model/filefolder/HiddenFileInfo.java | 11 +++-- 4 files changed, 28 insertions(+), 41 deletions(-) diff --git a/source/java/org/alfresco/repo/model/filefolder/FilenameFilteringInterceptor.java b/source/java/org/alfresco/repo/model/filefolder/FilenameFilteringInterceptor.java index caefc1d8be..0d1df19dde 100644 --- a/source/java/org/alfresco/repo/model/filefolder/FilenameFilteringInterceptor.java +++ b/source/java/org/alfresco/repo/model/filefolder/FilenameFilteringInterceptor.java @@ -216,7 +216,6 @@ public class FilenameFilteringInterceptor implements MethodInterceptor ret = invocation.proceed(); FileInfoImpl fileInfo = (FileInfoImpl)ret; -// NodeRef retNodeRef = fileInfo.getNodeRef(); if(isSystemPath(nodeRef, filename)) { @@ -237,7 +236,6 @@ public class FilenameFilteringInterceptor implements MethodInterceptor ret = invocation.proceed(); FileInfoImpl fileInfo = (FileInfoImpl)ret; - //NodeRef retNodeRef = fileInfo.getNodeRef(); checkTemporaryAspect(temporaryFiles.isFiltered(filename), fileInfo); hiddenAspect.checkHidden(fileInfo); @@ -251,7 +249,6 @@ public class FilenameFilteringInterceptor implements MethodInterceptor FileInfoImpl fileInfo = (FileInfoImpl) ret; String filename = fileInfo.getName(); -// NodeRef retNodeRef = fileInfo.getNodeRef(); if (logger.isDebugEnabled()) { @@ -261,7 +258,6 @@ public class FilenameFilteringInterceptor implements MethodInterceptor // check against all the regular expressions checkTemporaryAspect(temporaryFiles.isFiltered(filename), fileInfo); hiddenAspect.checkHidden(fileInfo); -// hiddenAspect.checkHidden(retNodeRef); } else { diff --git a/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java b/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java index 762aedb059..df44e26056 100644 --- a/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java +++ b/source/java/org/alfresco/repo/model/filefolder/HiddenAspect.java @@ -11,13 +11,11 @@ import java.util.Set; import java.util.regex.Pattern; import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.model.FileInfo; 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.Path.Element; import org.alfresco.service.namespace.QName; -import org.alfresco.util.FileFilterMode; import org.alfresco.util.FileFilterMode.Client; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -159,7 +157,7 @@ public class HiddenAspect return Visibility.getVisibility(mask); } - /** + /* * Determines whether the path matches any one of the hidden file patterns and, if so, * returns the matching pattern. * @@ -245,6 +243,12 @@ public class HiddenAspect addIndexControlAspect(nodeRef); } + /** + * Checks whether the file should be hidden and applies the hidden and not indexed aspects if so. + * + * @param fileInfo + * @return + */ public void checkHidden(FileInfoImpl fileInfo) { NodeRef nodeRef = fileInfo.getNodeRef(); @@ -254,7 +258,15 @@ public class HiddenAspect fileInfo.setHidden(true); } } - + + /** + * Hides the node by applying the hidden and not indexed aspects. The node will be hidden from clients + * according to the visibility mask. + * + * @param client + * @param fileInfo + * @return + */ public void hideNode(FileInfoImpl fileInfo, int visibilityMask) { hideNode(fileInfo.getNodeRef(), visibilityMask); @@ -264,7 +276,6 @@ public class HiddenAspect /** * Checks whether the file should be hidden and applies the hidden and not indexed aspects if so. * - * @param client * @param fileInfo * @return */ @@ -340,33 +351,6 @@ public class HiddenAspect return ret; } - /** - * Return the list of files with hidden files filtered out if required for the given client. - * - * @param client - * @param files - * @return - */ -// public List removeHiddenFiles(Client client, List files) -// { -// // TODO bulk load aspects and properties of nodes first? -// List ret = new ArrayList(files.size()); -// int numHiddenFiles = 0; -// -// for(FileInfo file : files) -// { -// if(getVisibility(client, file.getNodeRef()) == Visibility.NotVisible) -// { -// numHiddenFiles++; -// continue; -// } -// -// ret.add(file); -// } -// -// return ret; -// } - private class HiddenFileInfoImpl implements HiddenFileInfo { private Pattern filter; diff --git a/source/java/org/alfresco/repo/model/filefolder/HiddenFileFilter.java b/source/java/org/alfresco/repo/model/filefolder/HiddenFileFilter.java index 4f20f25043..dc53b41fb4 100644 --- a/source/java/org/alfresco/repo/model/filefolder/HiddenFileFilter.java +++ b/source/java/org/alfresco/repo/model/filefolder/HiddenFileFilter.java @@ -3,6 +3,12 @@ package org.alfresco.repo.model.filefolder; import org.alfresco.util.PropertyCheck; import org.springframework.beans.factory.InitializingBean; +/** + * Spring bean defining a hidden node filter. + * + * @since 4.0 + * + */ public class HiddenFileFilter implements InitializingBean { private String filter; diff --git a/source/java/org/alfresco/repo/model/filefolder/HiddenFileInfo.java b/source/java/org/alfresco/repo/model/filefolder/HiddenFileInfo.java index 11a422794b..5d6ec3de13 100644 --- a/source/java/org/alfresco/repo/model/filefolder/HiddenFileInfo.java +++ b/source/java/org/alfresco/repo/model/filefolder/HiddenFileInfo.java @@ -1,12 +1,13 @@ package org.alfresco.repo.model.filefolder; -import java.util.Set; - -import org.alfresco.util.FileFilterMode.Client; - +/** + * Represents hidden file information, including the filter (regular expression) and the visibility mask. + * + * @since 4.0 + * + */ public interface HiddenFileInfo { - public Set getVisibility(); public int getVisibilityMask(); public String getFilter(); }