[TL-249] Javadoc and other small fixes

Including stripping $Revision$ from filter javadoc.

dspace-api/src/main/java/org/dspace/content/InstallItemServiceImpl.java

@@ -67,8 +67,8 @@ public class InstallItemServiceImpl implements InstallItemService {
         AuthorizeException {
         Item item = is.getItem();
         Collection collection = is.getCollection();
-        // Get map of filters to use for identifier types
+        // Get map of filters to use for identifier types.
-        Map<Class<? extends Identifier>, Filter> filters = FilterUtils.getIdentifierFilters("install");
+        Map<Class<? extends Identifier>, Filter> filters = FilterUtils.getIdentifierFilters(false);
         try {
             if (suppliedHandle == null) {
                 // Register with the filters we've set up

dspace-api/src/main/java/org/dspace/content/WorkspaceItemServiceImpl.java

@@ -177,8 +177,8 @@ public class WorkspaceItemServiceImpl implements WorkspaceItemService {
         if (DSpaceServicesFactory.getInstance().getConfigurationService()
                 .getBooleanProperty("identifiers.submission.register", false)) {
             try {
-                // Get map of filters to use for identifier types
+                // Get map of filters to use for identifier types, while the item is in progress
-                Map<Class<? extends Identifier>, Filter> filters = FilterUtils.getIdentifierFilters("workspace");
+                Map<Class<? extends Identifier>, Filter> filters = FilterUtils.getIdentifierFilters(true);
                 IdentifierServiceFactory.getInstance().getIdentifierService().register(context, item, filters);
                 // Look for a DOI and move it to PENDING
                 DOI doi = doiService.findDOIByDSpaceObject(context, item);

dspace-api/src/main/java/org/dspace/content/logic/DefaultFilter.java

@@ -18,7 +18,6 @@ import org.dspace.core.Context;
  * statement as a property (unlike an operator) and takes no parameters (unlike a condition)
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class DefaultFilter implements Filter {
     private LogicalStatement statement;

dspace-api/src/main/java/org/dspace/content/logic/FilterUtils.java

@@ -61,18 +61,19 @@ public class FilterUtils {
      * Get a map of identifier types and filters to use when creating workspace or archived items
      * This is used by services installing new archived or workspace items to filter by identifier type
      * as some filters should apply to DOI creation but not Handle creation, and so on.
-     *
+     * The in progress or archived status will be used to load the appropriate filter from configuration
-     * Status
+     * <p>
-     * @param status is a suffix used when finding the appropriate filter from configuration
+     * @param inProgress
      * @return
      */
-    public static Map<Class<? extends Identifier>, Filter> getIdentifierFilters(String status) {
+    public static Map<Class<? extends Identifier>, Filter> getIdentifierFilters(boolean inProgress) {
-        if (status == null) {
+        String configurationSuffix = "install";
-            status = "install";
+        if (inProgress) {
+            configurationSuffix = "workspace";
         }
         Map<Class<? extends Identifier>, Filter> filters = new HashMap<>();
         // Put DOI 'can we create DOI on install / workspace?' filter
-        Filter filter = FilterUtils.getFilterFromConfiguration("identifiers.submission.filter." + status);
+        Filter filter = FilterUtils.getFilterFromConfiguration("identifiers.submission.filter." + configurationSuffix);
         // A null filter should be handled safely by the identifier provier (default, or "always true")
         filters.put(DOI.class, filter);
         // This won't have an affect until handle providers implement filtering, but is an example of

dspace-api/src/main/java/org/dspace/content/logic/LogicalStatement.java

@@ -17,7 +17,6 @@ import org.dspace.core.Context;
  * used as sub-statements in other Filters and Operators.
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public interface LogicalStatement {
     /**

dspace-api/src/main/java/org/dspace/content/logic/LogicalStatementException.java

@@ -12,7 +12,6 @@ package org.dspace.content.logic;
  * defined as spring beans.
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class LogicalStatementException extends RuntimeException {
 

dspace-api/src/main/java/org/dspace/content/logic/TestLogicRunner.java

@@ -33,7 +33,6 @@ import org.dspace.services.factory.DSpaceServicesFactory;
  * A command-line runner used for testing a logical filter against an item, or all items
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class TestLogicRunner {
 

dspace-api/src/main/java/org/dspace/content/logic/condition/AbstractCondition.java

@@ -23,7 +23,6 @@ import org.springframework.beans.factory.annotation.Autowired;
  * Abstract class for conditions, to implement the basic getter and setter parameters
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public abstract class AbstractCondition implements Condition {
 

dspace-api/src/main/java/org/dspace/content/logic/condition/BitstreamCountCondition.java

@@ -18,7 +18,6 @@ import org.dspace.core.Context;
  * A condition to evaluate an item based on how many bitstreams it has in a particular bundle
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class BitstreamCountCondition extends AbstractCondition {
     /**

dspace-api/src/main/java/org/dspace/content/logic/condition/Condition.java

@@ -22,7 +22,6 @@ import org.dspace.core.Context;
  * operator is not a condition but also a logical statement.
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public interface Condition extends LogicalStatement {
 

dspace-api/src/main/java/org/dspace/content/logic/condition/InCollectionCondition.java

@@ -23,7 +23,6 @@ import org.dspace.core.Context;
  * if the item belongs to any of them.
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class InCollectionCondition extends AbstractCondition {
     private static Logger log = LogManager.getLogger(InCollectionCondition.class);

dspace-api/src/main/java/org/dspace/content/logic/condition/InCommunityCondition.java

@@ -24,7 +24,6 @@ import org.dspace.core.Context;
  * if the item belongs to any of them.
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class InCommunityCondition extends AbstractCondition {
     private final static Logger log = LogManager.getLogger();

dspace-api/src/main/java/org/dspace/content/logic/condition/IsArchivedCondition.java

@@ -17,7 +17,6 @@ import org.dspace.core.Context;
  * A condition that returns true if the item is archived
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class IsArchivedCondition extends AbstractCondition {
     private final static Logger log = LogManager.getLogger();

dspace-api/src/main/java/org/dspace/content/logic/condition/IsWithdrawnCondition.java

@@ -17,7 +17,6 @@ import org.dspace.core.Context;
  * A condition that returns true if the item is withdrawn
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class IsWithdrawnCondition extends AbstractCondition {
     private final static Logger log = LogManager.getLogger();

dspace-api/src/main/java/org/dspace/content/logic/condition/MetadataValueMatchCondition.java

@@ -23,7 +23,6 @@ import org.dspace.core.Context;
  * in a given metadata field
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class MetadataValueMatchCondition extends AbstractCondition {
 

dspace-api/src/main/java/org/dspace/content/logic/condition/MetadataValuesMatchCondition.java

@@ -23,7 +23,6 @@ import org.dspace.core.Context;
  * in a given metadata field
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class MetadataValuesMatchCondition extends AbstractCondition {
 

dspace-api/src/main/java/org/dspace/content/logic/condition/ReadableByGroupCondition.java

@@ -25,7 +25,6 @@ import org.dspace.core.Context;
  * can perform the action on a given item
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class ReadableByGroupCondition extends AbstractCondition {
     private final static Logger log = LogManager.getLogger();

dspace-api/src/main/java/org/dspace/content/logic/operator/AbstractOperator.java

@@ -22,7 +22,6 @@ import org.dspace.core.Context;
  * as a logical result
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public abstract class AbstractOperator implements LogicalStatement {
 

dspace-api/src/main/java/org/dspace/content/logic/operator/And.java

@@ -19,7 +19,6 @@ import org.dspace.core.Context;
  * true if all sub-statements return true
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class And extends AbstractOperator {
 

dspace-api/src/main/java/org/dspace/content/logic/operator/Nand.java

@@ -18,7 +18,6 @@ import org.dspace.core.Context;
  * An operator that implements NAND by negating an AND operation
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class Nand extends AbstractOperator {
 

dspace-api/src/main/java/org/dspace/content/logic/operator/Not.java

@@ -19,7 +19,6 @@ import org.dspace.core.Context;
  * Not can have one sub-statement only, while and, or, nor, ... can have multiple sub-statements.
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class Not implements LogicalStatement {
 

dspace-api/src/main/java/org/dspace/content/logic/operator/Or.java

@@ -19,7 +19,6 @@ import org.dspace.core.Context;
  * true if one or more sub-statements return true
  *
  * @author Kim Shepherd
- * @version $Revision$
  */
 public class Or extends AbstractOperator {
 

dspace-api/src/main/java/org/dspace/identifier/service/IdentifierService.java

@@ -106,6 +106,10 @@ public interface IdentifierService {
     void register(Context context, DSpaceObject dso) throws AuthorizeException, SQLException, IdentifierException;
 
     /**
+     *
+     * Register identifiers for a DSO, with a map of logical filters for each Identifier class to apply
+     * at the time of local registration.
+     *
      * @param context The relevant DSpace Context.
      * @param dso     DSpace object to be registered
      * @param typeFilters   If a service supports a given Identifier implementation, apply the associated filter
@@ -117,6 +121,10 @@ public interface IdentifierService {
         throws AuthorizeException, SQLException, IdentifierException;
 
     /**
+     *
+     * Register identifier(s) for the given DSO just with providers that support that Identifier class, and
+     * apply the given filter if that provider extends FilteredIdentifierProvider
+     *
      * @param context The relevant DSpace Context.
      * @param dso     DSpace object to be registered
      * @param type    Type of identifier to register
@@ -129,6 +137,10 @@ public interface IdentifierService {
             throws AuthorizeException, SQLException, IdentifierException;
 
     /**
+     *
+     * Register identifier(s) for the given DSO just with providers that support that Identifier class, and
+     * apply the given filter if that provider extends FilteredIdentifierProvider
+     *
      * @param context The relevant DSpace Context.
      * @param dso     DSpace object to be registered
      * @param type    Type of identifier to register