diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java index 36a18965c7..5399479712 100644 --- a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java +++ b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java @@ -1128,11 +1128,10 @@ public class ItemExport } /** - * Get the file size of the export archive represented by the file name + * Get the file size of the export archive represented by the file name. * * @param fileName - * name of the file to get the size - * @return + * name of the file to get the size. * @throws Exception */ public static long getExportFileSize(String fileName) throws Exception diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java index e304c9ec1d..fbec94fee9 100644 --- a/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java +++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java @@ -375,46 +375,46 @@ public class MetadataUtilities { } /** - * rewrite of ItemImport's functionality - * but just the parsing of the file, not the processing of its elements - * - * - * @validate flag to verify matching files in tree - * @return + * rewrite of ItemImport's functionality + * but just the parsing of the file, not the processing of its elements. + * + * @param f file of item metadata. + * @validate flag to verify matching files in tree. + * @return parsed content of {@code f}. */ public static List readContentsFile(File f) throws FileNotFoundException, IOException, ParseException { List list = new ArrayList(); - + BufferedReader in = null; - + try { - in = new BufferedReader(new FileReader(f)); - String line = null; - - while ((line = in.readLine()) != null) - { - line = line.trim(); - if ("".equals(line)) - { - continue; - } - ItemUpdate.pr("Contents entry: " + line); - list.add(ContentsEntry.parse(line)); - } + in = new BufferedReader(new FileReader(f)); + String line = null; + + while ((line = in.readLine()) != null) + { + line = line.trim(); + if ("".equals(line)) + { + continue; + } + ItemUpdate.pr("Contents entry: " + line); + list.add(ContentsEntry.parse(line)); + } } finally { - try - { - in.close(); - } - catch(IOException e) - { - //skip - } + try + { + in.close(); + } + catch(IOException e) + { + //skip + } } return list; @@ -423,7 +423,6 @@ public class MetadataUtilities { /** * * @param f - * @return * @throws FileNotFoundException * @throws IOException */ @@ -441,7 +440,7 @@ public class MetadataUtilities { while ((line = in.readLine()) != null) { - line = line.trim(); + line = line.trim(); if ("".equals(line)) { continue; @@ -451,7 +450,7 @@ public class MetadataUtilities { try { n = Integer.parseInt(line); - list.add(n); + list.add(n); } catch(NumberFormatException e) { @@ -461,13 +460,13 @@ public class MetadataUtilities { } finally { - try + try { - in.close(); + in.close(); } catch(IOException e) { - //skip + //skip } } @@ -476,7 +475,7 @@ public class MetadataUtilities { /** * Get display of DCValue - * + * * @param dcv * @return string displaying elements of the DCValue */ @@ -486,47 +485,47 @@ public class MetadataUtilities { "; language: " + dcv.language + "; value: " + dcv.value; } - /** - * - * @return a String representation of the two- or three-part form of a metadata element - * e.g. dc.identifier.uri - */ - public static String getCompoundForm(String schema, String element, String qualifier) - { - StringBuilder sb = new StringBuilder(); - sb.append(schema).append(".").append(element); - - if (qualifier != null) - { - sb.append(".").append(qualifier); - } - return sb.toString(); - } + /** + * + * @return a String representation of the two- or three-part form of a metadata element + * e.g. dc.identifier.uri + */ + public static String getCompoundForm(String schema, String element, String qualifier) + { + StringBuilder sb = new StringBuilder(); + sb.append(schema).append(".").append(element); + + if (qualifier != null) + { + sb.append(".").append(qualifier); + } + return sb.toString(); + } - /** - * Parses metadata field given in the form .[.|.*] - * checks for correct number of elements (2 or 3) and for empty strings - * - * @return String Array - * @throws ParseException if validity checks fail - * - */ - public static String[] parseCompoundForm(String compoundForm) + /** + * Parses metadata field given in the form ".[.|.*]". + * Checks for correct number of elements (2 or 3) and for empty strings. + * + * @return String Array + * @throws ParseException if validity checks fail + * + */ + public static String[] parseCompoundForm(String compoundForm) throws ParseException - { - String[] ar = compoundForm.split("\\s*\\.\\s*"); //trim ends - - if ("".equals(ar[0])) - { - throw new ParseException("schema is empty string: " + compoundForm, 0); - } - - if ((ar.length < 2) || (ar.length > 3) || "".equals(ar[1])) - { - throw new ParseException("element is malformed or empty string: " + compoundForm, 0); - } - - return ar; - } - + { + String[] ar = compoundForm.split("\\s*\\.\\s*"); //trim ends + + if ("".equals(ar[0])) + { + throw new ParseException("schema is empty string: " + compoundForm, 0); + } + + if ((ar.length < 2) || (ar.length > 3) || "".equals(ar[1])) + { + throw new ParseException("element is malformed or empty string: " + compoundForm, 0); + } + + return ar; + } + } diff --git a/dspace-api/src/main/java/org/dspace/app/packager/Packager.java b/dspace-api/src/main/java/org/dspace/app/packager/Packager.java index 9995627245..1300654f1f 100644 --- a/dspace-api/src/main/java/org/dspace/app/packager/Packager.java +++ b/dspace-api/src/main/java/org/dspace/app/packager/Packager.java @@ -608,7 +608,6 @@ public class Packager * @param dso DSpace Object to disseminate as a package * @param pkgParams Parameters to pass to individual packager instances * @param outputFile File where final package should be saved - * @param identifier identifier of main DSpace object to disseminate * @throws IOException * @throws SQLException * @throws FileNotFoundException @@ -616,7 +615,9 @@ public class Packager * @throws CrosswalkException * @throws PackageException */ - protected void disseminate(Context context, PackageDisseminator dip, DSpaceObject dso, PackageParameters pkgParams, String outputFile) + protected void disseminate(Context context, PackageDisseminator dip, + DSpaceObject dso, PackageParameters pkgParams, + String outputFile) throws IOException, SQLException, FileNotFoundException, AuthorizeException, CrosswalkException, PackageException { // initialize output file diff --git a/dspace-api/src/main/java/org/dspace/app/sfx/SFXFileReader.java b/dspace-api/src/main/java/org/dspace/app/sfx/SFXFileReader.java index 5907ed22b5..1b37a09545 100644 --- a/dspace-api/src/main/java/org/dspace/app/sfx/SFXFileReader.java +++ b/dspace-api/src/main/java/org/dspace/app/sfx/SFXFileReader.java @@ -94,18 +94,18 @@ public class SFXFileReader { } /** - * Process the item + * Process the item. * * @param node * @param item - * @return + * @return processed fields. * @throws IOException */ public static String doNodes(Node node, Item item) throws IOException { if (node == null) { - log.error (" Empty Node "); + log.error (" Empty Node "); return null; } Node e = getElement(node); @@ -135,11 +135,11 @@ public class SFXFileReader { } /** - * Process the fields + * Process the fields. * * @param e * @param item - * @return + * @return assembled query. * @throws IOException */ private static String processFields(Node e, Item item) throws IOException @@ -315,10 +315,10 @@ public class SFXFileReader { short type = kid.getNodeType(); if (type == Node.TEXT_NODE) { - return kid.getNodeValue().trim(); + return kid.getNodeValue().trim(); } } // Didn't find a text node return null; } -} \ No newline at end of file +} diff --git a/dspace-api/src/main/java/org/dspace/app/statistics/LogAnalyser.java b/dspace-api/src/main/java/org/dspace/app/statistics/LogAnalyser.java index cd67549c9d..e8a3bd0df2 100644 --- a/dspace-api/src/main/java/org/dspace/app/statistics/LogAnalyser.java +++ b/dspace-api/src/main/java/org/dspace/app/statistics/LogAnalyser.java @@ -855,9 +855,7 @@ public class LogAnalyser } /** - * read in the given config file and populate the class globals - * - * @param configFile the config file to read in + * Read in the current config file and populate the class globals. */ public static void readConfig() throws IOException { @@ -865,7 +863,7 @@ public class LogAnalyser } /** - * read in the given config file and populate the class globals + * Read in the given config file and populate the class globals. * * @param configFile the config file to read in */ diff --git a/dspace-api/src/main/java/org/dspace/app/statistics/StatisticsLoader.java b/dspace-api/src/main/java/org/dspace/app/statistics/StatisticsLoader.java index 859ca1bfd8..fe2d36a52e 100644 --- a/dspace-api/src/main/java/org/dspace/app/statistics/StatisticsLoader.java +++ b/dspace-api/src/main/java/org/dspace/app/statistics/StatisticsLoader.java @@ -53,8 +53,7 @@ public class StatisticsLoader } /** - * Get an array of the dates of the report files - * @return + * Get an array of the dates of the report files. */ public static Date[] getMonthlyReportDates() { @@ -62,8 +61,7 @@ public class StatisticsLoader } /** - * Get an array of the dates of the analysis files - * @return + * Get an array of the dates of the analysis files. */ public static Date[] getMonthlyAnalysisDates() { @@ -71,9 +69,8 @@ public class StatisticsLoader } /** - * Convert the formatted dates that are the keys of the map into a date array + * Convert the formatted dates that are the keys of the map into a date array. * @param monthlyMap - * @return */ protected static Date[] getDatesFromMap(Map monthlyMap) { @@ -97,9 +94,9 @@ public class StatisticsLoader } /** - * Sort the date array in descending (reverse chronological) order + * Sort the date array in descending (reverse chronological) order. * @param dates - * @return + * @return sorted dates. */ protected static Date[] sortDatesDescending(Date[] dates) { @@ -134,9 +131,8 @@ public class StatisticsLoader } /** - * Get the analysis file for a given date + * Get the analysis file for a given date. * @param date - * @return */ public static File getAnalysisFor(String date) { @@ -146,9 +142,8 @@ public class StatisticsLoader } /** - * Get the report file for a given date + * Get the report file for a given date. * @param date - * @return */ public static File getReportFor(String date) { @@ -158,8 +153,7 @@ public class StatisticsLoader } /** - * Get the current general analysis file - * @return + * Get the current general analysis file. */ public static File getGeneralAnalysis() { @@ -168,8 +162,7 @@ public class StatisticsLoader } /** - * Get the current general report file - * @return + * Get the current general report file. */ public static File getGeneralReport() { @@ -295,13 +288,13 @@ public class StatisticsLoader } /** - * Generate a StatsFile entry for this file. The pattern and date formatters are used to - * identify the file as a particular type, and extract the relevant information. - * If the file is not identified by the formatter provided, then we return null + * Generate a StatsFile entry for this file. The pattern and date + * formatters are used to identify the file as a particular type, + * and extract the relevant information. If the file is not identified + * by the formatter provided, then we return null. * @param thisFile * @param thisPattern * @param sdf - * @return */ private static StatsFile makeStatsFile(File thisFile, Pattern thisPattern, SimpleDateFormat sdf) { @@ -329,8 +322,7 @@ public class StatisticsLoader } /** - * Get an array of all the analysis and report files - * @return + * Get an array of all the analysis and report files. */ private static File[] getAnalysisAndReportFileList() { @@ -344,7 +336,7 @@ public class StatisticsLoader } /** - * Simple class for holding information about an analysis/report file + * Simple class for holding information about an analysis/report file. */ private static class StatsFile { @@ -355,7 +347,8 @@ public class StatisticsLoader } /** - * Filter used to restrict files in the reports directory to just analysis or report types + * Filter used to restrict files in the reports directory to just + * analysis or report types. */ private static class AnalysisAndReportFilter implements FilenameFilter { diff --git a/dspace-api/src/main/java/org/dspace/app/statistics/package.html b/dspace-api/src/main/java/org/dspace/app/statistics/package.html index fac3e4a525..3d303ccf64 100644 --- a/dspace-api/src/main/java/org/dspace/app/statistics/package.html +++ b/dspace-api/src/main/java/org/dspace/app/statistics/package.html @@ -11,37 +11,6 @@ org.dspace.app.statistics package - @@ -67,11 +36,11 @@ class, defined in this package, to select an event processing implementation. Three "stock" implementations are provided.

-
{@link org.dspace.app.statistics.PassiveUsageEvent PassiveUsageEvent}
+
{@link org.dspace.usage.PassiveUsageEventListener PassiveUsageEventListener}
absorbs events without taking action, resulting in behavior identical to that of DSpace before this package was added. This is the default if no plugin is configured.
-
{@link org.dspace.app.statistics.UsageEventTabFileLogger UsageEventTabFileLogger}
+
{@link org.dspace.usage.TabFileUsageEventListener TabFileUsageEventListener}
writes event records to a file in Tab Separated Values format.
{@link org.dspace.app.statistics.UsageEventXMLLogger UsageEventXMLLogger}
writes event records to a file in an XML format. Suitable mainly for diff --git a/dspace-api/src/main/java/org/dspace/app/util/DCInput.java b/dspace-api/src/main/java/org/dspace/app/util/DCInput.java index 575222bd6e..49f312eedd 100644 --- a/dspace-api/src/main/java/org/dspace/app/util/DCInput.java +++ b/dspace-api/src/main/java/org/dspace/app/util/DCInput.java @@ -17,7 +17,6 @@ import org.dspace.content.MetadataSchema; * Class representing a line in an input form. * * @author Brian S. Hughes, based on work by Jenny Toves, OCLC - * @version */ public class DCInput { diff --git a/dspace-api/src/main/java/org/dspace/app/util/GoogleMetadata.java b/dspace-api/src/main/java/org/dspace/app/util/GoogleMetadata.java index 60d189b585..5559fd68bc 100644 --- a/dspace-api/src/main/java/org/dspace/app/util/GoogleMetadata.java +++ b/dspace-api/src/main/java/org/dspace/app/util/GoogleMetadata.java @@ -772,7 +772,6 @@ public class GoogleMetadata /** * Produce meta elements that can easily be put into the head. - * @return */ public List disseminateList() { diff --git a/dspace-api/src/main/java/org/dspace/authorize/AuthorizeConfiguration.java b/dspace-api/src/main/java/org/dspace/authorize/AuthorizeConfiguration.java index 30d44278bd..a879388236 100644 --- a/dspace-api/src/main/java/org/dspace/authorize/AuthorizeConfiguration.java +++ b/dspace-api/src/main/java/org/dspace/authorize/AuthorizeConfiguration.java @@ -174,8 +174,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to create new, not strictly community * related, group? - * - * @return */ public static boolean canCommunityAdminPerformGroupCreation() { @@ -184,8 +182,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to create collections or subcommunities? - * - * @return */ public static boolean canCommunityAdminPerformSubelementCreation() { @@ -194,8 +190,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to remove collections or subcommunities? - * - * @return */ public static boolean canCommunityAdminPerformSubelementDeletion() { @@ -205,8 +199,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to manage the community's and * subcommunities' policies? - * - * @return */ public static boolean canCommunityAdminManagePolicies() { @@ -216,8 +208,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to create/edit them community's and * subcommunities' admin groups? - * - * @return */ public static boolean canCommunityAdminManageAdminGroup() { @@ -227,8 +217,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to create/edit the community's and * subcommunities' admin group? - * - * @return */ public static boolean canCommunityAdminManageCollectionPolicies() { @@ -238,8 +226,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to manage the item template of them * collections? - * - * @return */ public static boolean canCommunityAdminManageCollectionTemplateItem() { @@ -249,8 +235,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to manage (create/edit/remove) the * submitters group of them collections? - * - * @return */ public static boolean canCommunityAdminManageCollectionSubmitters() { @@ -260,8 +244,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to manage (create/edit/remove) the workflows * group of them collections? - * - * @return */ public static boolean canCommunityAdminManageCollectionWorkflows() { @@ -271,8 +253,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to manage (create/edit/remove) the admin * group of them collections? - * - * @return */ public static boolean canCommunityAdminManageCollectionAdminGroup() { @@ -281,8 +261,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to remove an item from them collections? - * - * @return */ public static boolean canCommunityAdminPerformItemDeletion() { @@ -291,8 +269,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to withdrawn an item from them collections? - * - * @return */ public static boolean canCommunityAdminPerformItemWithdrawn() { @@ -302,8 +278,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to reinstate an item from them * collections? - * - * @return */ public static boolean canCommunityAdminPerformItemReinstatiate() { @@ -313,8 +287,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to manage the policies of an item owned by * one of them collections? - * - * @return */ public static boolean canCommunityAdminManageItemPolicies() { @@ -324,8 +296,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to add a bitstream to an item owned by one * of them collections? - * - * @return */ public static boolean canCommunityAdminPerformBitstreamCreation() { @@ -335,8 +305,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to remove a bitstream from an item owned by * one of them collections? - * - * @return */ public static boolean canCommunityAdminPerformBitstreamDeletion() { @@ -346,8 +314,6 @@ public class AuthorizeConfiguration /** * Are community admins allowed to perform CC License replace or addition to * an item owned by one of them collections? - * - * @return */ public static boolean canCommunityAdminManageCCLicense() { @@ -356,8 +322,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to manage the collection's policies? - * - * @return */ public static boolean canCollectionAdminManagePolicies() { @@ -367,8 +331,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to manage (create/edit/delete) the * collection's item template? - * - * @return */ public static boolean canCollectionAdminManageTemplateItem() { @@ -378,8 +340,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to manage (create/edit/delete) the * collection's submitters group? - * - * @return */ public static boolean canCollectionAdminManageSubmitters() { @@ -389,8 +349,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to manage (create/edit/delete) the * collection's workflows group? - * - * @return */ public static boolean canCollectionAdminManageWorkflows() { @@ -400,8 +358,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to manage (create/edit) the collection's * admins group? - * - * @return */ public static boolean canCollectionAdminManageAdminGroup() { @@ -410,8 +366,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to remove an item from the collection? - * - * @return */ public static boolean canCollectionAdminPerformItemDeletion() { @@ -420,8 +374,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to withdrawn an item from the collection? - * - * @return */ public static boolean canCollectionAdminPerformItemWithdrawn() { @@ -431,8 +383,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to reinstate an item from the * collection? - * - * @return */ public static boolean canCollectionAdminPerformItemReinstatiate() { @@ -442,8 +392,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to manage the policies of item owned by the * collection? - * - * @return */ public static boolean canCollectionAdminManageItemPolicies() { @@ -453,8 +401,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to add a bitstream to an item owned by the * collections? - * - * @return */ public static boolean canCollectionAdminPerformBitstreamCreation() { @@ -464,8 +410,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to remove a bitstream from an item owned by * the collections? - * - * @return */ public static boolean canCollectionAdminPerformBitstreamDeletion() { @@ -475,8 +419,6 @@ public class AuthorizeConfiguration /** * Are collection admins allowed to replace or adding a CC License to an * item owned by the collections? - * - * @return */ public static boolean canCollectionAdminManageCCLicense() { @@ -485,8 +427,6 @@ public class AuthorizeConfiguration /** * Are item admins allowed to manage the item's policies? - * - * @return */ public static boolean canItemAdminManagePolicies() { @@ -495,8 +435,6 @@ public class AuthorizeConfiguration /** * Are item admins allowed to add bitstreams to the item? - * - * @return */ public static boolean canItemAdminPerformBitstreamCreation() { @@ -505,8 +443,6 @@ public class AuthorizeConfiguration /** * Are item admins allowed to remove bitstreams from the item? - * - * @return */ public static boolean canItemAdminPerformBitstreamDeletion() { @@ -515,8 +451,6 @@ public class AuthorizeConfiguration /** * Are item admins allowed to replace or adding CC License to the item? - * - * @return */ public static boolean canItemAdminManageCCLicense() { diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseCreateDAO.java b/dspace-api/src/main/java/org/dspace/browse/BrowseCreateDAO.java index 62c01ccc39..564cca5643 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseCreateDAO.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseCreateDAO.java @@ -332,7 +332,7 @@ public interface BrowseCreateDAO * @param table the name of the distinct table which holds the target of the mapping * @param map the name of the mapping table itself * @param execute whether to execute the query or not - * @return + * @return the instructions (SQL) which effect the creation. * @throws BrowseException */ public String createDistinctMap(String table, String map, boolean execute) throws BrowseException; diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtils.java b/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtils.java index 7e4111355b..4ef557c19b 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtils.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtils.java @@ -8,8 +8,9 @@ package org.dspace.browse; /** - * Utility class for retrieving the size of the columns to be used in the browse tables, - * and applying truncation to the strings that will be inserted into the tables. + * Utility class for retrieving the size of the columns to be used in the + * browse tables, and applying truncation to the strings that will be inserted + * into the tables. * * Can be configured in dspace.cfg, with the following entries: * @@ -25,26 +26,23 @@ package org.dspace.browse; * - a string to append to truncated values that will be entered into * the value columns (ie. '...') * - * By default, the column sizes are '0' (unlimited), and no truncation is applied, - * EXCEPT for Oracle, where we have to truncate the columns for it to work! (in which - * case, both value and sort columns are by default limited to 2000 characters). - * + * By default, the column sizes are '0' (unlimited), and no truncation is + * applied, EXCEPT for Oracle, where we have to truncate the columns for it + * to work! (in which case, both value and sort columns are by default limited + * to 2000 characters). + * * @author Graham Triggs * @author Richard Jones */ public interface BrowseDAOUtils { - /** + /** * Get the size to use for the 'value' columns in characters - * - * @return */ public int getValueColumnMaxChars(); /** * Get the size to use for the sort columns in characters - * - * @return */ public int getSortColumnMaxChars(); @@ -52,7 +50,7 @@ public interface BrowseDAOUtils * Truncate strings that are to be used for the 'value' columns * * @param value - * @return + * @return the truncated value. */ public String truncateValue(String value); @@ -60,7 +58,7 @@ public interface BrowseDAOUtils * Truncate strings that are to be used for sorting * * @param value - * @return + * @return the truncated value. */ public String truncateSortValue(String value); @@ -72,7 +70,7 @@ public interface BrowseDAOUtils * * @param value * @param chars - * @return + * @return the truncated value. * @deprecated */ public String truncateValue(String value, int chars); @@ -85,7 +83,7 @@ public interface BrowseDAOUtils * * @param value * @param chars - * @return + * @return the truncated value. * @deprecated */ public String truncateSortValue(String value, int chars); diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtilsDefault.java b/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtilsDefault.java index 95997201c9..94a45706a4 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtilsDefault.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtilsDefault.java @@ -10,8 +10,9 @@ package org.dspace.browse; import org.dspace.core.ConfigurationManager; /** - * Utility class for retrieving the size of the columns to be used in the browse tables, - * and applying truncation to the strings that will be inserted into the tables. + * Utility class for retrieving the size of the columns to be used in the + * browse tables, and applying truncation to the strings that will be inserted + * into the tables. * * Can be configured in dspace.cfg, with the following entries: * @@ -27,16 +28,17 @@ import org.dspace.core.ConfigurationManager; * - a string to append to truncated values that will be entered into * the value columns (ie. '...') * - * By default, the column sizes are '0' (unlimited), and no truncation is applied, - * EXCEPT for Oracle, where we have to truncate the columns for it to work! (in which - * case, both value and sort columns are by default limited to 2000 characters). - * + * By default, the column sizes are '0' (unlimited), and no truncation is + * applied, EXCEPT for Oracle, where we have to truncate the columns for it + * to work! (in which case, both value and sort columns are by default limited + * to 2000 characters). + * * @author Graham Triggs * @author Richard Jones */ public class BrowseDAOUtilsDefault implements BrowseDAOUtils { - /** Maximum number of characters for value columns */ + /** Maximum number of characters for value columns */ public int valueColumnMaxChars; /** Maximum number of characters for sort columns */ @@ -81,8 +83,6 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils /** * Get the size to use for the 'value' columns in characters - * - * @return */ public int getValueColumnMaxChars() { @@ -91,8 +91,6 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils /** * Get the size to use for the sort columns in characters - * - * @return */ public int getSortColumnMaxChars() { @@ -103,7 +101,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils * Truncate strings that are to be used for the 'value' columns * * @param value - * @return + * @return the truncated value. */ public String truncateValue(String value) { @@ -114,7 +112,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils * Truncate strings that are to be used for sorting * * @param value - * @return + * @return the truncated value. */ public String truncateSortValue(String value) { @@ -129,7 +127,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils * * @param value * @param chars - * @return + * @return the truncated value. * @deprecated */ public String truncateValue(String value, int chars) @@ -145,7 +143,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils * * @param value * @param chars - * @return + * @return the truncated value. * @deprecated */ public String truncateSortValue(String value, int chars) @@ -159,7 +157,7 @@ public class BrowseDAOUtilsDefault implements BrowseDAOUtils * @param value * @param maxChars * @param omissionMark - * @return + * @return the truncated value. */ private String trunctateString(String value, int maxChars, String omissionMark) { diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java b/dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java index 2b55309e4a..2f98a5c964 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java @@ -27,7 +27,7 @@ import org.dspace.sort.SortException; */ public final class BrowseIndex { - /** the configuration number, as specified in the config */ + /** the configuration number, as specified in the config */ /** used for single metadata browse tables for generating the table name */ private int number; @@ -75,7 +75,7 @@ public final class BrowseIndex } /** - * Constructor for creating generic / internal index objects + * Constructor for creating generic / internal index objects. * @param baseName The base of the table name */ private BrowseIndex(String baseName) @@ -223,25 +223,25 @@ public final class BrowseIndex } /** - * @return Returns the datatype. - */ - public String getDataType() - { + * @return Returns the datatype. + */ + public String getDataType() + { if (sortOption != null) - { - return sortOption.getType(); - } + { + return sortOption.getType(); + } - return datatype; - } + return datatype; + } - /** - * @return Returns the displayType. - */ - public String getDisplayType() - { + /** + * @return Returns the displayType. + */ + public String getDisplayType() + { return displayType; - } + } /** * @return Returns the number of metadata fields for this index @@ -257,67 +257,67 @@ public final class BrowseIndex } /** - * @return Returns the mdBits. - */ - public String[] getMdBits(int idx) - { - if (isMetadataIndex()) - { - return mdBits[idx]; - } - - return null; - } + * @return Returns the mdBits. + */ + public String[] getMdBits(int idx) + { + if (isMetadataIndex()) + { + return mdBits[idx]; + } - /** - * @return Returns the metadata. - */ - public String getMetadata() - { + return null; + } + + /** + * @return Returns the metadata. + */ + public String getMetadata() + { return metadataAll; - } + } public String getMetadata(int idx) { return metadata[idx]; } - /** - * @return Returns the name. - */ - public String getName() - { - return name; - } + /** + * @return Returns the name. + */ + public String getName() + { + return name; + } - /** - * @param name The name to set. - */ + /** + * @param name The name to set. + */ // public void setName(String name) // { // this.name = name; // } - /** - * Get the SortOption associated with this index. - */ - public SortOption getSortOption() - { - return sortOption; - } - - public boolean isDisplayFrequencies() { - return displayFrequencies; - } + /** + * Get the SortOption associated with this index. + */ + public SortOption getSortOption() + { + return sortOption; + } - /** - * Populate the internal array containing the bits of metadata, for - * ease of use later - */ - public void generateMdBits() + public boolean isDisplayFrequencies() { + return displayFrequencies; + } + + /** + * Populate the internal array containing the bits of metadata, for + * ease of use later + */ + public void generateMdBits() { try - { + { if (isMetadataIndex()) { mdBits = new String[metadata.length][]; @@ -334,13 +334,13 @@ public final class BrowseIndex } } - /** - * Get the name of the sequence that will be used in the given circumstances - * - * @param isDistinct is a distinct table - * @param isMap is a map table - * @return the name of the sequence - */ + /** + * Get the name of the sequence that will be used in the given circumstances + * + * @param isDistinct is a distinct table + * @param isMap is a map table + * @return the name of the sequence + */ public String getSequenceName(boolean isDistinct, boolean isMap) { if (isDistinct || isMap) @@ -369,7 +369,6 @@ public final class BrowseIndex * @param baseName * @param isDistinct * @param isMap - * @return */ private static String getSequenceName(String baseName, boolean isDistinct, boolean isMap) { @@ -412,7 +411,7 @@ public final class BrowseIndex * @param isCollection * @param isDistinct * @param isMap - * @return + * @return the name of the table. */ private static String getTableName(String baseName, boolean isCommunity, boolean isCollection, boolean isDistinct, boolean isMap) { @@ -443,7 +442,7 @@ public final class BrowseIndex } /** - * Get the name of the table in the given circumstances + * Get the name of the table in the given circumstances. * * @param isCommunity whether this is a community constrained index (view) * @param isCollection whether this is a collection constrained index (view) @@ -486,7 +485,7 @@ public final class BrowseIndex * getTableName(false, false, false, false); * * - * @return + * @return the name of the table. */ public String getTableName() { @@ -505,7 +504,7 @@ public final class BrowseIndex * @param isDistinct is this a distinct table * @param isCommunity * @param isCollection - * @return + * @return the name of the table. * @deprecated 1.5 */ public String getTableName(boolean isDistinct, boolean isCommunity, boolean isCollection) @@ -520,7 +519,7 @@ public final class BrowseIndex * getTableName(false, false, false, true); * * - * @return + * @return the name of the table. */ public String getMapTableName() { @@ -534,7 +533,7 @@ public final class BrowseIndex * getTableName(false, false, true, false); * * - * @return + * @return the name of the table. */ public String getDistinctTableName() { @@ -629,8 +628,8 @@ public final class BrowseIndex } /** - * Get the field for sorting associated with this index - * @return + * Get the field for sorting associated with this index. + * @return the name of the field. * @throws BrowseException */ public String getSortField(boolean isSecondLevel) throws BrowseException @@ -656,8 +655,11 @@ public final class BrowseIndex } /** + * Get an array of the names of all the browse index tables in the current + * configuration. + * * @deprecated - * @return + * @return names of all the current browse index tables. * @throws BrowseException */ public static String[] tables() @@ -731,7 +733,7 @@ public final class BrowseIndex * Get the configured browse index that is defined to use this sort option * * @param so - * @return + * @return the associated BrowseIndex. * @throws BrowseException */ public static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException @@ -748,9 +750,7 @@ public final class BrowseIndex } /** - * Get the internally defined browse index for archived items - * - * @return + * Get the internally defined browse index for archived items. */ public static BrowseIndex getItemBrowseIndex() { @@ -758,8 +758,7 @@ public final class BrowseIndex } /** - * Get the internally defined browse index for withdrawn items - * @return + * Get the internally defined browse index for withdrawn items. */ public static BrowseIndex getWithdrawnBrowseIndex() { @@ -805,9 +804,7 @@ public final class BrowseIndex } /** - * Does this browse index represent one of the internal item indexes - * - * @return + * Does this browse index represent one of the internal item indexes? */ public boolean isInternalIndex() { @@ -815,9 +812,8 @@ public final class BrowseIndex } /** - * Generate a base table name + * Generate a base table name. * @param number - * @return */ private static String makeTableBaseName(int number) { diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseInfo.java b/dspace-api/src/main/java/org/dspace/browse/BrowseInfo.java index aa96845883..28245582b4 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseInfo.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseInfo.java @@ -496,7 +496,7 @@ public class BrowseInfo /** * @deprecated - * @return + * @return an empty array of Item. */ public Item[] getItemResults() { diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseItem.java b/dspace-api/src/main/java/org/dspace/browse/BrowseItem.java index f965054755..af381ad89b 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseItem.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseItem.java @@ -37,17 +37,17 @@ import java.util.List; */ public class BrowseItem extends DSpaceObject { - /** Logger */ + /** Logger */ private static Logger log = Logger.getLogger(BrowseItem.class); /** DSpace context */ - private Context context; + private Context context; - /** a List of all the metadata */ - private List metadata = new ArrayList(); + /** a List of all the metadata */ + private List metadata = new ArrayList(); - /** database id of the item */ - private int id = -1; + /** database id of the item */ + private int id = -1; /** is the item in the archive */ private boolean in_archive = true; @@ -56,37 +56,37 @@ public class BrowseItem extends DSpaceObject private boolean withdrawn = false; /** item handle */ - private String handle = null; + private String handle = null; /** - * Construct a new browse item with the given context and the database id - * - * @param context the DSpace context + * Construct a new browse item with the given context and the database id + * + * @param context the DSpace context * @param id the database id of the item * @param in_archive * @param withdrawn */ - public BrowseItem(Context context, int id, boolean in_archive, boolean withdrawn) - { - this.context = context; - this.id = id; + public BrowseItem(Context context, int id, boolean in_archive, boolean withdrawn) + { + this.context = context; + this.id = id; this.in_archive = in_archive; this.withdrawn = withdrawn; } - /** - * Get String array of metadata values matching the given parameters - * - * @param schema metadata schema - * @param element metadata element - * @param qualifier metadata qualifier - * @param lang metadata language - * @return array of matching values - * @throws SQLException - */ - public DCValue[] getMetadata(String schema, String element, String qualifier, String lang) - throws SQLException - { + /** + * Get String array of metadata values matching the given parameters + * + * @param schema metadata schema + * @param element metadata element + * @param qualifier metadata qualifier + * @param lang metadata language + * @return array of matching values + * @throws SQLException + */ + public DCValue[] getMetadata(String schema, String element, String qualifier, String lang) + throws SQLException + { try { BrowseItemDAO dao = BrowseDAOFactory.getItemInstance(context); @@ -146,55 +146,55 @@ public class BrowseItem extends DSpaceObject } } - /** - * Get the type of object. This object masquerades as an Item, so this - * returns the value of Constants.ITEM - * - *@return Constants.ITEM - */ - public int getType() - { + /** + * Get the type of object. This object masquerades as an Item, so this + * returns the value of Constants.ITEM + * + *@return Constants.ITEM + */ + public int getType() + { + return Constants.ITEM; + } + + /** + * @deprecated + * @param real + * @return real type, or Constants.ITEM. + */ + public int getType(boolean real) + { + if (!real) + { return Constants.ITEM; - } + } + else + { + return getType(); + } + } - /** - * @deprecated - * @param real - * @return - */ - public int getType(boolean real) - { - if (!real) - { - return Constants.ITEM; - } - else - { - return getType(); - } - } - - /** - * get the database id of the item - * - * @return database id of item - */ - public int getID() - { - return id; - } + /** + * get the database id of the item + * + * @return database id of item + */ + public int getID() + { + return id; + } - /** - * Set the database id of the item - * - * @param id the database id of the item - */ - public void setID(int id) - { - this.id = id; - } - - /** + /** + * Set the database id of the item + * + * @param id the database id of the item + */ + public void setID(int id) + { + this.id = id; + } + + /** * Utility method for pattern-matching metadata elements. This * method will return true if the given schema, * element, qualifier and language match the schema, element, @@ -273,37 +273,36 @@ public class BrowseItem extends DSpaceObject return true; } - /* (non-Javadoc) - * @see org.dspace.content.DSpaceObject#getHandle() - */ - public String getHandle() - { - // Get our Handle if any - if (this.handle == null) - { - try - { - this.handle = HandleManager.findHandle(context, this); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - } - } - return this.handle; - } - - /** - * Get a thumbnail object out of the item. - * - * Warning: using this method actually instantiates an Item, which has a - * corresponding performance hit on the database during browse listing - * rendering. That's your own fault for wanting to put images on your - * browse page! - * - * @return - * @throws SQLException - */ + /* (non-Javadoc) + * @see org.dspace.content.DSpaceObject#getHandle() + */ + public String getHandle() + { + // Get our Handle if any + if (this.handle == null) + { + try + { + this.handle = HandleManager.findHandle(context, this); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + } + } + return this.handle; + } + + /** + * Get a thumbnail object out of the item. + * + * Warning: using this method actually instantiates an Item, which has a + * corresponding performance hit on the database during browse listing + * rendering. That's your own fault for wanting to put images on your + * browse page! + * + * @throws SQLException + */ public Thumbnail getThumbnail() throws SQLException { @@ -370,19 +369,19 @@ public class BrowseItem extends DSpaceObject return null; } - public String getName() + public String getName() { // FIXME: there is an exception handling problem here - try - { - DCValue t[] = getMetadata("dc", "title", null, Item.ANY); - return (t.length >= 1) ? t[0].value : null; - } - catch (SQLException sqle) - { + try + { + DCValue t[] = getMetadata("dc", "title", null, Item.ANY); + return (t.length >= 1) ? t[0].value : null; + } + catch (SQLException sqle) + { log.error("caught exception: ", sqle); - return null; - } + return null; + } } @Override diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowseItemDAO.java b/dspace-api/src/main/java/org/dspace/browse/BrowseItemDAO.java index 8ed02aaa23..9914d31b0a 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowseItemDAO.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowseItemDAO.java @@ -37,7 +37,7 @@ public interface BrowseItemDAO * @param element * @param qualifier * @param lang - * @return + * @return matching metadata values. * @throws SQLException */ public DCValue[] queryMetadata(int itemId, String schema, String element, String qualifier, String lang) diff --git a/dspace-api/src/main/java/org/dspace/browse/CrossLinks.java b/dspace-api/src/main/java/org/dspace/browse/CrossLinks.java index 4dd1832b73..3adbedd730 100644 --- a/dspace-api/src/main/java/org/dspace/browse/CrossLinks.java +++ b/dspace-api/src/main/java/org/dspace/browse/CrossLinks.java @@ -22,56 +22,55 @@ import org.dspace.core.ConfigurationManager; */ public class CrossLinks { - /** a map of the desired links */ - private Map links = new HashMap(); + /** a map of the desired links */ + private Map links = new HashMap(); - /** - * Construct a new object which will obtain the configuration for itself - * - * @throws BrowseException - */ - public CrossLinks() - throws BrowseException - { - int i = 1; - while (true) - { - String field = "webui.browse.link." + i; - String config = ConfigurationManager.getProperty(field); - if (config == null) - { - break; - } - - String[] parts = config.split(":"); - if (parts.length != 2) - { - throw new BrowseException("Invalid configuration for " + field + ": " + config); - } - links.put(parts[1], parts[0]); - i++; - } - } + /** + * Construct a new object which will obtain the configuration for itself + * + * @throws BrowseException + */ + public CrossLinks() + throws BrowseException + { + int i = 1; + while (true) + { + String field = "webui.browse.link." + i; + String config = ConfigurationManager.getProperty(field); + if (config == null) + { + break; + } + + String[] parts = config.split(":"); + if (parts.length != 2) + { + throw new BrowseException("Invalid configuration for " + field + ": " + config); + } + links.put(parts[1], parts[0]); + i++; + } + } - /** - * Is there a link for the given canonical form of metadata (i.e. schema.element.qualifier) - * - * @param metadata the metadata to check for a link on - * @return - */ - public boolean hasLink(String metadata) - { - return links.containsKey(metadata); - } - - /** - * get the type of link that the bit of metadata has - * - * @param metadata the metadata to get the link type for - * @return - */ - public String getLinkType(String metadata) - { - return links.get(metadata); - } + /** + * Is there a link for the given canonical form of metadata (i.e. + * schema.element.qualifier)? + * + * @param metadata the metadata to check for a link on + */ + public boolean hasLink(String metadata) + { + return links.containsKey(metadata); + } + + /** + * get the type of link that the bit of metadata has. + * + * @param metadata the metadata to get the link type for + */ + public String getLinkType(String metadata) + { + return links.get(metadata); + } } diff --git a/dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java b/dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java index 8fecf998bb..01124216ac 100644 --- a/dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java +++ b/dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java @@ -594,27 +594,27 @@ public class IndexBrowse throw new BrowseException("Error in SortOptions", se); } } - - /** - * remove all the indices for the given item - * - * @param item the item to be removed - * @return - * @throws BrowseException - */ - public boolean itemRemoved(Item item) - throws BrowseException + + /** + * remove all the indices for the given item + * + * @param item the item to be removed + * @return true if removed. + * @throws BrowseException + */ + public boolean itemRemoved(Item item) + throws BrowseException { return itemRemoved(item.getID()); } public boolean itemRemoved(int itemID) throws BrowseException - { - // go over the indices and index the item - for (int i = 0; i < bis.length; i++) - { - if (bis[i].isMetadataIndex()) + { + // go over the indices and index the item + for (int i = 0; i < bis.length; i++) + { + if (bis[i].isMetadataIndex()) { log.debug("Removing indexing for removed item " + itemID + ", for index: " + bis[i].getTableName()); dao.deleteByItemID(bis[i].getMapTableName(), itemID); @@ -628,127 +628,127 @@ public class IndexBrowse dao.deleteCommunityMappings(itemID); return true; - } + } - /** - * Creates Browse indexes, destroying the old ones. - * - * @param argv - * Command-line arguments - */ - public static void main(String[] argv) - throws SQLException, BrowseException, ParseException - { + /** + * Creates Browse indexes, destroying the old ones. + * + * @param argv + * Command-line arguments + */ + public static void main(String[] argv) + throws SQLException, BrowseException, ParseException + { Date startTime = new Date(); try - { - Context context = new Context(); - context.turnOffAuthorisationSystem(); - IndexBrowse indexer = new IndexBrowse(context); + { + Context context = new Context(); + context.turnOffAuthorisationSystem(); + IndexBrowse indexer = new IndexBrowse(context); - // create an options object and populate it - CommandLineParser parser = new PosixParser(); - Options options = new Options(); + // create an options object and populate it + CommandLineParser parser = new PosixParser(); + Options options = new Options(); - // these are mutually exclusive, and represent the primary actions - options.addOption("t", "tables", false, "create the tables only, do not attempt to index. Mutually exclusive with -f and -i"); - options.addOption("i", "index", false, "actually do the indexing. Mutually exclusive with -t and -f"); - options.addOption("f", "full", false, "make the tables, and do the indexing. This forces -x. Mutually exclusive with -t and -i"); + // these are mutually exclusive, and represent the primary actions + options.addOption("t", "tables", false, "create the tables only, do not attempt to index. Mutually exclusive with -f and -i"); + options.addOption("i", "index", false, "actually do the indexing. Mutually exclusive with -t and -f"); + options.addOption("f", "full", false, "make the tables, and do the indexing. This forces -x. Mutually exclusive with -t and -i"); - // these options can be specified only with the -f option - options.addOption("r", "rebuild", false, "should we rebuild all the indices, which removes old index tables and creates new ones. For use with -f. Mutually exclusive with -d"); - options.addOption("d", "delete", false, "delete all the indices, but don't create new ones. For use with -f. This is mutually exclusive with -r"); + // these options can be specified only with the -f option + options.addOption("r", "rebuild", false, "should we rebuild all the indices, which removes old index tables and creates new ones. For use with -f. Mutually exclusive with -d"); + options.addOption("d", "delete", false, "delete all the indices, but don't create new ones. For use with -f. This is mutually exclusive with -r"); - // these options can be specified only with the -t and -f options - options.addOption("o", "out", true, "[-o ] write the remove and create SQL to the given file. For use with -t and -f"); // FIXME: not currently working - options.addOption("p", "print", false, "write the remove and create SQL to the stdout. For use with -t and -f"); - options.addOption("x", "execute", false, "execute all the remove and create SQL against the database. For use with -t and -f"); - options.addOption("s", "start", true, "[-s ] start from this index number and work upward (mostly only useful for debugging). For use with -t and -f"); + // these options can be specified only with the -t and -f options + options.addOption("o", "out", true, "[-o ] write the remove and create SQL to the given file. For use with -t and -f"); // FIXME: not currently working + options.addOption("p", "print", false, "write the remove and create SQL to the stdout. For use with -t and -f"); + options.addOption("x", "execute", false, "execute all the remove and create SQL against the database. For use with -t and -f"); + options.addOption("s", "start", true, "[-s ] start from this index number and work upward (mostly only useful for debugging). For use with -t and -f"); - // this option can be used with any argument - options.addOption("v", "verbose", false, "print extra information to the stdout. If used in conjunction with -p, you cannot use the stdout to generate your database structure"); + // this option can be used with any argument + options.addOption("v", "verbose", false, "print extra information to the stdout. If used in conjunction with -p, you cannot use the stdout to generate your database structure"); - // display the help. If this is spefified, it trumps all other arguments - options.addOption("h", "help", false, "show this help documentation. Overrides all other arguments"); + // display the help. If this is spefified, it trumps all other arguments + options.addOption("h", "help", false, "show this help documentation. Overrides all other arguments"); - CommandLine line = parser.parse(options, argv); + CommandLine line = parser.parse(options, argv); - // display the help - if (line.hasOption("h")) - { - indexer.usage(options); - return; - } + // display the help + if (line.hasOption("h")) + { + indexer.usage(options); + return; + } - if (line.hasOption("v")) - { - indexer.setVerbose(true); - } + if (line.hasOption("v")) + { + indexer.setVerbose(true); + } - if (line.hasOption("i")) - { - indexer.createIndex(); - return; - } + if (line.hasOption("i")) + { + indexer.createIndex(); + return; + } - if (line.hasOption("f")) - { - if (line.hasOption('r')) - { - indexer.setRebuild(true); - } - else if (line.hasOption("d")) - { - indexer.setDelete(true); - } - } + if (line.hasOption("f")) + { + if (line.hasOption('r')) + { + indexer.setRebuild(true); + } + else if (line.hasOption("d")) + { + indexer.setDelete(true); + } + } - if (line.hasOption("f") || line.hasOption("t")) - { - if (line.hasOption("s")) - { - indexer.setStart(Integer.parseInt(line.getOptionValue("s"))); - } - if (line.hasOption("x")) - { - indexer.setExecute(true); - } - if (line.hasOption("p")) - { - indexer.setStdOut(true); - } - if (line.hasOption("o")) - { - indexer.setFileOut(true); - indexer.setOutFile(line.getOptionValue("o")); - } - } + if (line.hasOption("f") || line.hasOption("t")) + { + if (line.hasOption("s")) + { + indexer.setStart(Integer.parseInt(line.getOptionValue("s"))); + } + if (line.hasOption("x")) + { + indexer.setExecute(true); + } + if (line.hasOption("p")) + { + indexer.setStdOut(true); + } + if (line.hasOption("o")) + { + indexer.setFileOut(true); + indexer.setOutFile(line.getOptionValue("o")); + } + } - if (line.hasOption("t")) - { - indexer.prepTables(); - return; - } + if (line.hasOption("t")) + { + indexer.prepTables(); + return; + } - if (line.hasOption("f")) - { - indexer.setExecute(true); - indexer.initBrowse(); - return; - } + if (line.hasOption("f")) + { + indexer.setExecute(true); + indexer.initBrowse(); + return; + } - indexer.usage(options); - context.complete(); - } + indexer.usage(options); + context.complete(); + } finally - { - Date endTime = new Date(); - System.out.println("Started: " + startTime.getTime()); - System.out.println("Ended: " + endTime.getTime()); - System.out.println("Elapsed time: " + ((endTime.getTime() - startTime.getTime()) / 1000) + " secs (" + (endTime.getTime() - startTime.getTime()) + " msecs)"); + { + Date endTime = new Date(); + System.out.println("Started: " + startTime.getTime()); + System.out.println("Ended: " + endTime.getTime()); + System.out.println("Elapsed time: " + ((endTime.getTime() - startTime.getTime()) / 1000) + " secs (" + (endTime.getTime() - startTime.getTime()) + " msecs)"); - } - } + } + } /** * output the usage information diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java index 49f141c07f..767cfb55d4 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java @@ -21,50 +21,50 @@ import org.dspace.content.DSpaceObject; */ public interface ItemCountDAO { - /** - * Set the DSpace Context to use during data access - * - * @param context - * @throws ItemCountException - */ - public void setContext(Context context) throws ItemCountException; + /** + * Set the DSpace Context to use during data access + * + * @param context + * @throws ItemCountException + */ + public void setContext(Context context) throws ItemCountException; - /** - * Set the given count as the number of items in the given community - * - * @param community - * @param count - * @throws ItemCountException - */ - public void communityCount(Community community, int count) throws ItemCountException; + /** + * Set the given count as the number of items in the given community + * + * @param community + * @param count + * @throws ItemCountException + */ + public void communityCount(Community community, int count) throws ItemCountException; - /** - * Set the given count as the number of items in the given collection - * - * @param collection - * @param count - * @throws ItemCountException - */ - public void collectionCount(Collection collection, int count) throws ItemCountException; + /** + * Set the given count as the number of items in the given collection + * + * @param collection + * @param count + * @throws ItemCountException + */ + public void collectionCount(Collection collection, int count) throws ItemCountException; - /** - * Get the number of items in the given DSpaceObject container. This method will - * only succeed if the DSpaceObject is an instance of either a Community or a - * Collection. Otherwise it will throw an exception - * - * @param dso - * @return - * @throws ItemCountException - */ - public int getCount(DSpaceObject dso) throws ItemCountException; + /** + * Get the number of items in the given DSpaceObject container. + * This method will only succeed if the DSpaceObject is an instance of + * either a Community or a Collection. Otherwise it will throw an + * exception. + * + * @param dso + * @throws ItemCountException + */ + public int getCount(DSpaceObject dso) throws ItemCountException; - /** - * Remove any cached data regarding the given DSpaceObject container. This method will - * only succeed if the DSpaceObject is an instance of either a Community or a - * Collection. Otherwise it will throw an exception - * - * @param dso - * @throws ItemCountException - */ - public void remove(DSpaceObject dso) throws ItemCountException; + /** + * Remove any cached data regarding the given DSpaceObject container. This method will + * only succeed if the DSpaceObject is an instance of either a Community or a + * Collection. Otherwise it will throw an exception + * + * @param dso + * @throws ItemCountException + */ + public void remove(DSpaceObject dso) throws ItemCountException; } diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOFactory.java b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOFactory.java index f47fd89914..ebc98333cd 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOFactory.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOFactory.java @@ -19,33 +19,32 @@ import org.dspace.core.ConfigurationManager; */ public class ItemCountDAOFactory { - /** - * Get an instance of ItemCountDAO which supports the correct database - * for the specific DSpace instance. - * - * @param context - * @return - * @throws ItemCountException - */ - public static ItemCountDAO getInstance(Context context) - throws ItemCountException - { - String db = ConfigurationManager.getProperty("db.name"); - ItemCountDAO dao; - if ("postgres".equals(db)) - { - dao = new ItemCountDAOPostgres(); - } - else if ("oracle".equals(db)) - { - dao = new ItemCountDAOOracle(); - } - else - { - throw new ItemCountException("Database type: " + db + " is not currently supported"); - } - - dao.setContext(context); - return dao; - } + /** + * Get an instance of ItemCountDAO which supports the correct database + * for the specific DSpace instance. + * + * @param context + * @throws ItemCountException + */ + public static ItemCountDAO getInstance(Context context) + throws ItemCountException + { + String db = ConfigurationManager.getProperty("db.name"); + ItemCountDAO dao; + if ("postgres".equals(db)) + { + dao = new ItemCountDAOPostgres(); + } + else if ("oracle".equals(db)) + { + dao = new ItemCountDAOOracle(); + } + else + { + throw new ItemCountException("Database type: " + db + " is not currently supported"); + } + + dao.setContext(context); + return dao; + } } diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java index e2451ba683..cc32c51438 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java @@ -28,305 +28,303 @@ import java.sql.SQLException; */ public class ItemCountDAOOracle implements ItemCountDAO { - /** Log4j logger */ - private static Logger log = Logger.getLogger(ItemCountDAOOracle.class); + /** Log4j logger */ + private static Logger log = Logger.getLogger(ItemCountDAOOracle.class); - /** DSpace context */ - private Context context; + /** DSpace context */ + private Context context; - /** SQL to select on a collection id */ - private String collectionSelect = "SELECT * FROM collection_item_count WHERE collection_id = ?"; + /** SQL to select on a collection id */ + private String collectionSelect = "SELECT * FROM collection_item_count WHERE collection_id = ?"; + + /** SQL to insert a new collection record */ + private String collectionInsert = "INSERT INTO collection_item_count (collection_id, count) VALUES (?, ?)"; - /** SQL to insert a new collection record */ - private String collectionInsert = "INSERT INTO collection_item_count (collection_id, count) VALUES (?, ?)"; + /** SQL to update an existing collection record */ + private String collectionUpdate = "UPDATE collection_item_count SET count = ? WHERE collection_id = ?"; - /** SQL to update an existing collection record */ - private String collectionUpdate = "UPDATE collection_item_count SET count = ? WHERE collection_id = ?"; + /** SQL to remove a collection record */ + private String collectionRemove = "DELETE FROM collection_item_count WHERE collection_id = ?"; - /** SQL to remove a collection record */ - private String collectionRemove = "DELETE FROM collection_item_count WHERE collection_id = ?"; + /** SQL to select on a community id */ + private String communitySelect = "SELECT * FROM community_item_count WHERE community_id = ?"; - /** SQL to select on a community id */ - private String communitySelect = "SELECT * FROM community_item_count WHERE community_id = ?"; + /** SQL to insert a new community record */ + private String communityInsert = "INSERT INTO community_item_count (community_id, count) VALUES (?, ?)"; - /** SQL to insert a new community record */ - private String communityInsert = "INSERT INTO community_item_count (community_id, count) VALUES (?, ?)"; + /** SQL to update an existing community record */ + private String communityUpdate = "UPDATE community_item_count SET count = ? WHERE community_id = ?"; - /** SQL to update an existing community record */ - private String communityUpdate = "UPDATE community_item_count SET count = ? WHERE community_id = ?"; + /** SQL to remove a community record */ + private String communityRemove = "DELETE FROM community_item_count WHERE community_id = ?"; - /** SQL to remove a community record */ - private String communityRemove = "DELETE FROM community_item_count WHERE community_id = ?"; - - /** - * Store the count of the given collection - * - * @param collection - * @param count - * @throws ItemCountException - */ - public void collectionCount(Collection collection, int count) - throws ItemCountException - { + /** + * Store the count of the given collection + * + * @param collection + * @param count + * @throws ItemCountException + */ + public void collectionCount(Collection collection, int count) + throws ItemCountException + { TableRowIterator tri = null; try - { - // first find out if we have a record - Object[] sparams = { Integer.valueOf(collection.getID()) }; - tri = DatabaseManager.query(context, collectionSelect, sparams); - - if (tri.hasNext()) - { - Object[] params = { Integer.valueOf(count), Integer.valueOf(collection.getID()) }; - DatabaseManager.updateQuery(context, collectionUpdate, params); - } - else - { - Object[] params = { Integer.valueOf(collection.getID()), Integer.valueOf(count) }; - DatabaseManager.updateQuery(context, collectionInsert, params); - } - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - finally - { - if (tri != null) - { - tri.close(); - } - } - } + { + // first find out if we have a record + Object[] sparams = { Integer.valueOf(collection.getID()) }; + tri = DatabaseManager.query(context, collectionSelect, sparams); - /** - * Store the count of the given community - * - * @param community - * @param count - * @throws ItemCountException - */ - public void communityCount(Community community, int count) - throws ItemCountException - { - TableRowIterator tri = null; - try - { - // first find out if we have a record - Object[] sparams = { Integer.valueOf(community.getID()) }; - tri = DatabaseManager.query(context, communitySelect, sparams); - - if (tri.hasNext()) - { - Object[] params = { Integer.valueOf(count), Integer.valueOf(community.getID()) }; - DatabaseManager.updateQuery(context, communityUpdate, params); - } - else - { - Object[] params = { Integer.valueOf(community.getID()), Integer.valueOf(count) }; - DatabaseManager.updateQuery(context, communityInsert, params); - } - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - finally - { - if (tri != null) - { - tri.close(); - } - } - } - - /** - * Set the dspace context to use - * - * @param context - * @throws ItemCountException - */ - public void setContext(Context context) - throws ItemCountException - { - this.context = context; - } - - /** - * get the count of the items in the given container - * - * @param dso - * @return - * @throws ItemCountException - */ - public int getCount(DSpaceObject dso) - throws ItemCountException - { - if (dso instanceof Collection) - { - return getCollectionCount((Collection) dso); - } - else if (dso instanceof Community) - { - return getCommunityCount((Community) dso); - } + if (tri.hasNext()) + { + Object[] params = { Integer.valueOf(count), Integer.valueOf(collection.getID()) }; + DatabaseManager.updateQuery(context, collectionUpdate, params); + } else - { - throw new ItemCountException("We can only count items in Communities or Collections"); - } - } + { + Object[] params = { Integer.valueOf(collection.getID()), Integer.valueOf(count) }; + DatabaseManager.updateQuery(context, collectionInsert, params); + } + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + finally + { + if (tri != null) + { + tri.close(); + } + } + } - /** - * remove the cache for the given container - * - * @param dso - * @throws ItemCountException - */ - public void remove(DSpaceObject dso) throws ItemCountException - { - if (dso instanceof Collection) - { - removeCollection((Collection) dso); - } - else if (dso instanceof Community) - { - removeCommunity((Community) dso); - } - else - { - throw new ItemCountException("We can only delete count of items from Communities or Collections"); - } - } - - /** - * remove the cache for the given collection - * - * @param collection - * @throws ItemCountException - */ - private void removeCollection(Collection collection) - throws ItemCountException - { - try - { - Object[] params = { Integer.valueOf(collection.getID()) }; - DatabaseManager.updateQuery(context, collectionRemove, params); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } - - /** - * Remove the cache for the given community - * - * @param community - * @throws ItemCountException - */ - private void removeCommunity(Community community) - throws ItemCountException - { - try - { - Object[] params = { Integer.valueOf(community.getID()) }; - DatabaseManager.updateQuery(context, communityRemove, params); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } - - /** - * Get the count for the given collection - * - * @param collection - * @return - * @throws ItemCountException - */ - private int getCollectionCount(Collection collection) - throws ItemCountException - { + /** + * Store the count of the given community + * + * @param community + * @param count + * @throws ItemCountException + */ + public void communityCount(Community community, int count) + throws ItemCountException + { TableRowIterator tri = null; try - { - Object[] params = { Integer.valueOf(collection.getID()) }; - tri = DatabaseManager.query(context, collectionSelect, params); - - if (!tri.hasNext()) - { - return 0; - } - - TableRow tr = tri.next(); - - if (tri.hasNext()) - { - throw new ItemCountException("More than one count row in the database"); - } + { + // first find out if we have a record + Object[] sparams = { Integer.valueOf(community.getID()) }; + tri = DatabaseManager.query(context, communitySelect, sparams); - return tr.getIntColumn("count"); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } + if (tri.hasNext()) + { + Object[] params = { Integer.valueOf(count), Integer.valueOf(community.getID()) }; + DatabaseManager.updateQuery(context, communityUpdate, params); + } + else + { + Object[] params = { Integer.valueOf(community.getID()), Integer.valueOf(count) }; + DatabaseManager.updateQuery(context, communityInsert, params); + } + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } finally - { - if (tri != null) - { - tri.close(); - } - } + { + if (tri != null) + { + tri.close(); + } + } + } + + /** + * Set the dspace context to use + * + * @param context + * @throws ItemCountException + */ + public void setContext(Context context) + throws ItemCountException + { + this.context = context; + } + + /** + * get the count of the items in the given container. + * + * @param dso + * @throws ItemCountException + */ + public int getCount(DSpaceObject dso) + throws ItemCountException + { + if (dso instanceof Collection) + { + return getCollectionCount((Collection) dso); + } + else if (dso instanceof Community) + { + return getCommunityCount((Community) dso); + } + else + { + throw new ItemCountException("We can only count items in Communities or Collections"); + } + } + + /** + * remove the cache for the given container + * + * @param dso + * @throws ItemCountException + */ + public void remove(DSpaceObject dso) throws ItemCountException + { + if (dso instanceof Collection) + { + removeCollection((Collection) dso); + } + else if (dso instanceof Community) + { + removeCommunity((Community) dso); + } + else + { + throw new ItemCountException("We can only delete count of items from Communities or Collections"); + } + } + + /** + * remove the cache for the given collection + * + * @param collection + * @throws ItemCountException + */ + private void removeCollection(Collection collection) + throws ItemCountException + { + try + { + Object[] params = { Integer.valueOf(collection.getID()) }; + DatabaseManager.updateQuery(context, collectionRemove, params); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } } - /** - * get the count for the given community - * - * @param community - * @return - * @throws ItemCountException - */ - private int getCommunityCount(Community community) - throws ItemCountException - { + /** + * Remove the cache for the given community + * + * @param community + * @throws ItemCountException + */ + private void removeCommunity(Community community) + throws ItemCountException + { + try + { + Object[] params = { Integer.valueOf(community.getID()) }; + DatabaseManager.updateQuery(context, communityRemove, params); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + } + + /** + * Get the count for the given collection + * + * @param collection + * @return + * @throws ItemCountException + */ + private int getCollectionCount(Collection collection) + throws ItemCountException + { TableRowIterator tri = null; try - { - Object[] params = { Integer.valueOf(community.getID()) }; - tri = DatabaseManager.query(context, communitySelect, params); - - if (!tri.hasNext()) - { - return 0; - } - - TableRow tr = tri.next(); - - if (tri.hasNext()) - { - throw new ItemCountException("More than one count row in the database"); - } + { + Object[] params = { Integer.valueOf(collection.getID()) }; + tri = DatabaseManager.query(context, collectionSelect, params); - return tr.getIntColumn("count"); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } + if (!tri.hasNext()) + { + return 0; + } + + TableRow tr = tri.next(); + + if (tri.hasNext()) + { + throw new ItemCountException("More than one count row in the database"); + } + + return tr.getIntColumn("count"); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } finally - { - if (tri != null) - { - tri.close(); - } - } + { + if (tri != null) + { + tri.close(); + } + } + } + + /** + * get the count for the given community + * + * @param community + * @throws ItemCountException + */ + private int getCommunityCount(Community community) + throws ItemCountException + { + TableRowIterator tri = null; + try + { + Object[] params = { Integer.valueOf(community.getID()) }; + tri = DatabaseManager.query(context, communitySelect, params); + + if (!tri.hasNext()) + { + return 0; + } + + TableRow tr = tri.next(); + + if (tri.hasNext()) + { + throw new ItemCountException("More than one count row in the database"); + } + + return tr.getIntColumn("count"); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + finally + { + if (tri != null) + { + tri.close(); + } + } } } diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java index 6aac4b2c3f..6c5b8d4f36 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java @@ -28,305 +28,302 @@ import java.sql.SQLException; */ public class ItemCountDAOPostgres implements ItemCountDAO { - /** Log4j logger */ - private static Logger log = Logger.getLogger(ItemCountDAOPostgres.class); + /** Log4j logger */ + private static Logger log = Logger.getLogger(ItemCountDAOPostgres.class); - /** DSpace context */ - private Context context; + /** DSpace context */ + private Context context; - /** SQL to select on a collection id */ - private String collectionSelect = "SELECT * FROM collection_item_count WHERE collection_id = ?"; + /** SQL to select on a collection id */ + private String collectionSelect = "SELECT * FROM collection_item_count WHERE collection_id = ?"; - /** SQL to insert a new collection record */ - private String collectionInsert = "INSERT INTO collection_item_count (collection_id, count) VALUES (?, ?)"; + /** SQL to insert a new collection record */ + private String collectionInsert = "INSERT INTO collection_item_count (collection_id, count) VALUES (?, ?)"; - /** SQL to update an existing collection record */ - private String collectionUpdate = "UPDATE collection_item_count SET count = ? WHERE collection_id = ?"; + /** SQL to update an existing collection record */ + private String collectionUpdate = "UPDATE collection_item_count SET count = ? WHERE collection_id = ?"; - /** SQL to remove a collection record */ - private String collectionRemove = "DELETE FROM collection_item_count WHERE collection_id = ?"; + /** SQL to remove a collection record */ + private String collectionRemove = "DELETE FROM collection_item_count WHERE collection_id = ?"; - /** SQL to select on a community id */ - private String communitySelect = "SELECT * FROM community_item_count WHERE community_id = ?"; + /** SQL to select on a community id */ + private String communitySelect = "SELECT * FROM community_item_count WHERE community_id = ?"; - /** SQL to insert a new community record */ - private String communityInsert = "INSERT INTO community_item_count (community_id, count) VALUES (?, ?)"; + /** SQL to insert a new community record */ + private String communityInsert = "INSERT INTO community_item_count (community_id, count) VALUES (?, ?)"; - /** SQL to update an existing community record */ - private String communityUpdate = "UPDATE community_item_count SET count = ? WHERE community_id = ?"; + /** SQL to update an existing community record */ + private String communityUpdate = "UPDATE community_item_count SET count = ? WHERE community_id = ?"; - /** SQL to remove a community record */ - private String communityRemove = "DELETE FROM community_item_count WHERE community_id = ?"; + /** SQL to remove a community record */ + private String communityRemove = "DELETE FROM community_item_count WHERE community_id = ?"; - /** - * Store the count of the given collection - * - * @param collection - * @param count - * @throws ItemCountException - */ - public void collectionCount(Collection collection, int count) - throws ItemCountException - { + /** + * Store the count of the given collection + * + * @param collection + * @param count + * @throws ItemCountException + */ + public void collectionCount(Collection collection, int count) + throws ItemCountException + { TableRowIterator tri = null; try - { - // first find out if we have a record - Object[] sparams = { Integer.valueOf(collection.getID()) }; - tri = DatabaseManager.query(context, collectionSelect, sparams); - - if (tri.hasNext()) - { - Object[] params = { Integer.valueOf(count), Integer.valueOf(collection.getID()) }; - DatabaseManager.updateQuery(context, collectionUpdate, params); - } - else - { - Object[] params = { Integer.valueOf(collection.getID()), Integer.valueOf(count) }; - DatabaseManager.updateQuery(context, collectionInsert, params); - } - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - finally - { - if (tri != null) - { - tri.close(); - } - } - } + { + // first find out if we have a record + Object[] sparams = { Integer.valueOf(collection.getID()) }; + tri = DatabaseManager.query(context, collectionSelect, sparams); - /** - * Store the count of the given community - * - * @param community - * @param count - * @throws ItemCountException - */ - public void communityCount(Community community, int count) - throws ItemCountException - { - TableRowIterator tri = null; - try - { - // first find out if we have a record - Object[] sparams = { Integer.valueOf(community.getID()) }; - tri = DatabaseManager.query(context, communitySelect, sparams); - - if (tri.hasNext()) - { - Object[] params = { Integer.valueOf(count), Integer.valueOf(community.getID()) }; - DatabaseManager.updateQuery(context, communityUpdate, params); - } - else - { - Object[] params = { Integer.valueOf(community.getID()), Integer.valueOf(count) }; - DatabaseManager.updateQuery(context, communityInsert, params); - } - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - finally - { - if (tri != null) - { - tri.close(); - } - } - } - - /** - * Set the dspace context to use - * - * @param context - * @throws ItemCountException - */ - public void setContext(Context context) - throws ItemCountException - { - this.context = context; - } - - /** - * get the count of the items in the given container - * - * @param dso - * @return - * @throws ItemCountException - */ - public int getCount(DSpaceObject dso) - throws ItemCountException - { - if (dso instanceof Collection) - { - return getCollectionCount((Collection) dso); - } - else if (dso instanceof Community) - { - return getCommunityCount((Community) dso); - } + if (tri.hasNext()) + { + Object[] params = { Integer.valueOf(count), Integer.valueOf(collection.getID()) }; + DatabaseManager.updateQuery(context, collectionUpdate, params); + } else - { - throw new ItemCountException("We can only count items in Communities or Collections"); - } - } + { + Object[] params = { Integer.valueOf(collection.getID()), Integer.valueOf(count) }; + DatabaseManager.updateQuery(context, collectionInsert, params); + } + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + finally + { + if (tri != null) + { + tri.close(); + } + } + } - /** - * remove the cache for the given container - * - * @param dso - * @throws ItemCountException - */ - public void remove(DSpaceObject dso) throws ItemCountException - { - if (dso instanceof Collection) - { - removeCollection((Collection) dso); - } - else if (dso instanceof Community) - { - removeCommunity((Community) dso); - } - else - { - throw new ItemCountException("We can only delete count of items from Communities or Collections"); - } - } - - /** - * remove the cache for the given collection - * - * @param collection - * @throws ItemCountException - */ - private void removeCollection(Collection collection) - throws ItemCountException - { - try - { - Object[] params = { Integer.valueOf(collection.getID()) }; - DatabaseManager.updateQuery(context, collectionRemove, params); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } - - /** - * Remove the cache for the given community - * - * @param community - * @throws ItemCountException - */ - private void removeCommunity(Community community) - throws ItemCountException - { - try - { - Object[] params = { Integer.valueOf(community.getID()) }; - DatabaseManager.updateQuery(context, communityRemove, params); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } - - /** - * Get the count for the given collection - * - * @param collection - * @return - * @throws ItemCountException - */ - private int getCollectionCount(Collection collection) - throws ItemCountException - { + /** + * Store the count of the given community + * + * @param community + * @param count + * @throws ItemCountException + */ + public void communityCount(Community community, int count) + throws ItemCountException + { TableRowIterator tri = null; try - { - Object[] params = { Integer.valueOf(collection.getID()) }; - tri = DatabaseManager.query(context, collectionSelect, params); - - if (!tri.hasNext()) - { - return 0; - } - - TableRow tr = tri.next(); - - if (tri.hasNext()) - { - throw new ItemCountException("More than one count row in the database"); - } + { + // first find out if we have a record + Object[] sparams = { Integer.valueOf(community.getID()) }; + tri = DatabaseManager.query(context, communitySelect, sparams); - return tr.getIntColumn("count"); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } + if (tri.hasNext()) + { + Object[] params = { Integer.valueOf(count), Integer.valueOf(community.getID()) }; + DatabaseManager.updateQuery(context, communityUpdate, params); + } + else + { + Object[] params = { Integer.valueOf(community.getID()), Integer.valueOf(count) }; + DatabaseManager.updateQuery(context, communityInsert, params); + } + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } finally - { - if (tri != null) - { - tri.close(); - } - } + { + if (tri != null) + { + tri.close(); + } + } + } + + /** + * Set the dspace context to use + * + * @param context + * @throws ItemCountException + */ + public void setContext(Context context) + throws ItemCountException + { + this.context = context; + } + + /** + * get the count of the items in the given container + * + * @param dso + * @throws ItemCountException + */ + public int getCount(DSpaceObject dso) + throws ItemCountException + { + if (dso instanceof Collection) + { + return getCollectionCount((Collection) dso); + } + else if (dso instanceof Community) + { + return getCommunityCount((Community) dso); + } + else + { + throw new ItemCountException("We can only count items in Communities or Collections"); + } + } + + /** + * remove the cache for the given container + * + * @param dso + * @throws ItemCountException + */ + public void remove(DSpaceObject dso) throws ItemCountException + { + if (dso instanceof Collection) + { + removeCollection((Collection) dso); + } + else if (dso instanceof Community) + { + removeCommunity((Community) dso); + } + else + { + throw new ItemCountException("We can only delete count of items from Communities or Collections"); + } + } + + /** + * remove the cache for the given collection + * + * @param collection + * @throws ItemCountException + */ + private void removeCollection(Collection collection) + throws ItemCountException + { + try + { + Object[] params = { Integer.valueOf(collection.getID()) }; + DatabaseManager.updateQuery(context, collectionRemove, params); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } } - /** - * get the count for the given community - * - * @param community - * @return - * @throws ItemCountException - */ - private int getCommunityCount(Community community) - throws ItemCountException - { + /** + * Remove the cache for the given community + * + * @param community + * @throws ItemCountException + */ + private void removeCommunity(Community community) + throws ItemCountException + { + try + { + Object[] params = { Integer.valueOf(community.getID()) }; + DatabaseManager.updateQuery(context, communityRemove, params); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + } + + /** + * Get the count for the given collection + * + * @param collection + * @throws ItemCountException + */ + private int getCollectionCount(Collection collection) + throws ItemCountException + { TableRowIterator tri = null; try - { - Object[] params = { Integer.valueOf(community.getID()) }; - tri = DatabaseManager.query(context, communitySelect, params); - - if (!tri.hasNext()) - { - return 0; - } - - TableRow tr = tri.next(); - - if (tri.hasNext()) - { - throw new ItemCountException("More than one count row in the database"); - } + { + Object[] params = { Integer.valueOf(collection.getID()) }; + tri = DatabaseManager.query(context, collectionSelect, params); - return tr.getIntColumn("count"); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } + if (!tri.hasNext()) + { + return 0; + } + + TableRow tr = tri.next(); + + if (tri.hasNext()) + { + throw new ItemCountException("More than one count row in the database"); + } + + return tr.getIntColumn("count"); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } finally - { - if (tri != null) - { - tri.close(); - } - } + { + if (tri != null) + { + tri.close(); + } + } + } + + /** + * get the count for the given community + * + * @param community + * @throws ItemCountException + */ + private int getCommunityCount(Community community) + throws ItemCountException + { + TableRowIterator tri = null; + try + { + Object[] params = { Integer.valueOf(community.getID()) }; + tri = DatabaseManager.query(context, communitySelect, params); + + if (!tri.hasNext()) + { + return 0; + } + + TableRow tr = tri.next(); + + if (tri.hasNext()) + { + throw new ItemCountException("More than one count row in the database"); + } + + return tr.getIntColumn("count"); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + finally + { + if (tri != null) + { + tri.close(); + } + } } } diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemCounter.java b/dspace-api/src/main/java/org/dspace/browse/ItemCounter.java index 8be90db506..e58dde5b29 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemCounter.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemCounter.java @@ -33,187 +33,185 @@ import java.sql.SQLException; */ public class ItemCounter { - /** Log4j logger */ - private static Logger log = Logger.getLogger(ItemCounter.class); + /** Log4j logger */ + private static Logger log = Logger.getLogger(ItemCounter.class); - /** DAO to use to store and retrieve data */ - private ItemCountDAO dao; + /** DAO to use to store and retrieve data */ + private ItemCountDAO dao; - /** DSpace Context */ - private Context context; + /** DSpace Context */ + private Context context; - /** - * method invoked by CLI which will result in the number of items - * in each community and collection being cached. These counts will - * not update themselves until this is run again. - * - * @param args - */ - public static void main(String[] args) - throws ItemCountException, SQLException - { + /** + * method invoked by CLI which will result in the number of items + * in each community and collection being cached. These counts will + * not update themselves until this is run again. + * + * @param args + */ + public static void main(String[] args) + throws ItemCountException, SQLException + { Context context = new Context(); ItemCounter ic = new ItemCounter(context); - ic.buildItemCounts(); + ic.buildItemCounts(); context.complete(); - } + } - /** - * Construct a new item counter which will use the give DSpace Context - * - * @param context - * @throws ItemCountException - */ - public ItemCounter(Context context) - throws ItemCountException - - { - this.context = context; - this.dao = ItemCountDAOFactory.getInstance(this.context); - } + /** + * Construct a new item counter which will use the give DSpace Context + * + * @param context + * @throws ItemCountException + */ + public ItemCounter(Context context) + throws ItemCountException + { + this.context = context; + this.dao = ItemCountDAOFactory.getInstance(this.context); + } - /** - * This method does the grunt work of drilling through and iterating - * over all of the communities and collections in the system and - * obtaining and caching the item counts for each one. - * - * @throws ItemCountException - */ - public void buildItemCounts() - throws ItemCountException - { - try - { - Community[] tlc = Community.findAllTop(context); - for (int i = 0; i < tlc.length; i++) - { - count(tlc[i]); - } - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } + /** + * This method does the grunt work of drilling through and iterating + * over all of the communities and collections in the system and + * obtaining and caching the item counts for each one. + * + * @throws ItemCountException + */ + public void buildItemCounts() + throws ItemCountException + { + try + { + Community[] tlc = Community.findAllTop(context); + for (int i = 0; i < tlc.length; i++) + { + count(tlc[i]); + } + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + } - /** - * Get the count of the items in the given container. If the configuration - * value webui.strengths.cache is equal to 'true' this will return the - * cached value if it exists. If it is equal to 'false' it will count - * the number of items in the container in real time - * - * @param dso - * @return - * @throws ItemCountException - * @throws SQLException - */ - public int getCount(DSpaceObject dso) - throws ItemCountException - { - boolean useCache = ConfigurationManager.getBooleanProperty("webui.strengths.cache"); - - if (useCache) - { - return dao.getCount(dso); + /** + * Get the count of the items in the given container. If the configuration + * value webui.strengths.cache is equal to 'true' this will return the + * cached value if it exists. If it is equal to 'false' it will count + * the number of items in the container in real time + * + * @param dso + * @throws ItemCountException + * @throws SQLException + */ + public int getCount(DSpaceObject dso) + throws ItemCountException + { + boolean useCache = ConfigurationManager.getBooleanProperty("webui.strengths.cache"); + + if (useCache) + { + return dao.getCount(dso); + } + + // if we make it this far, we need to manually count + if (dso instanceof Collection) + { + try { + return ((Collection) dso).countItems(); + } catch (SQLException e) { + log.error("caught exception: ", e); + throw new ItemCountException(e); } - - // if we make it this far, we need to manually count - if (dso instanceof Collection) - { - try { - return ((Collection) dso).countItems(); - } catch (SQLException e) { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } + } + + if (dso instanceof Community) + { + try { + return ((Community) dso).countItems(); + } catch (SQLException e) { + log.error("caught exception: ", e); + throw new ItemCountException(e); } - - if (dso instanceof Community) - { - try { - return ((Community) dso).countItems(); - } catch (SQLException e) { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } - - return 0; - } + } + + return 0; + } - /** - * Remove any cached data for the given container - * - * @param dso - * @throws ItemCountException - */ - public void remove(DSpaceObject dso) - throws ItemCountException - { - dao.remove(dso); - } + /** + * Remove any cached data for the given container + * + * @param dso + * @throws ItemCountException + */ + public void remove(DSpaceObject dso) + throws ItemCountException + { + dao.remove(dso); + } - /** - * count and cache the number of items in the community. This - * will include all sub-communities and collections in the - * community. It will also recurse into sub-communities and - * collections and call count() on them also. - * - * Therefore, the count the contents of the entire system, it is - * necessary just to call this method on each top level community - * - * @param community - * @throws ItemCountException - */ - private void count(Community community) - throws ItemCountException - { - try - { - // first count the community we are in - int count = community.countItems(); - dao.communityCount(community, count); - - // now get the sub-communities - Community[] scs = community.getSubcommunities(); - for (int i = 0; i < scs.length; i++) - { - count(scs[i]); - } - - // now get the collections - Collection[] cols = community.getCollections(); - for (int i = 0; i < cols.length; i++) - { - count(cols[i]); - } - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } + /** + * count and cache the number of items in the community. This + * will include all sub-communities and collections in the + * community. It will also recurse into sub-communities and + * collections and call count() on them also. + * + * Therefore, the count the contents of the entire system, it is + * necessary just to call this method on each top level community + * + * @param community + * @throws ItemCountException + */ + private void count(Community community) + throws ItemCountException + { + try + { + // first count the community we are in + int count = community.countItems(); + dao.communityCount(community, count); + + // now get the sub-communities + Community[] scs = community.getSubcommunities(); + for (int i = 0; i < scs.length; i++) + { + count(scs[i]); + } + + // now get the collections + Collection[] cols = community.getCollections(); + for (int i = 0; i < cols.length; i++) + { + count(cols[i]); + } + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + } - /** - * count and cache the number of items in the given collection - * - * @param collection - * @throws ItemCountException - */ - private void count(Collection collection) - throws ItemCountException - { - try - { - int ccount = collection.countItems(); - dao.collectionCount(collection, ccount); - } - catch (SQLException e) - { - log.error("caught exception: ", e); - throw new ItemCountException(e); - } - } + /** + * count and cache the number of items in the given collection + * + * @param collection + * @throws ItemCountException + */ + private void count(Collection collection) + throws ItemCountException + { + try + { + int ccount = collection.countItems(); + dao.collectionCount(collection, ccount); + } + catch (SQLException e) + { + log.error("caught exception: ", e); + throw new ItemCountException(e); + } + } } diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java b/dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java index baacb99687..415cc511d6 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java @@ -22,90 +22,89 @@ import org.dspace.core.ConfigurationManager; */ public class ItemListConfig { - /** a map of column number to metadata value */ - private Map metadata = new HashMap(); + /** a map of column number to metadata value */ + private Map metadata = new HashMap(); - /** a map of column number to data type */ - private Map types = new HashMap(); + /** a map of column number to data type */ + private Map types = new HashMap(); - /** constant for a DATE column */ - private static final int DATE = 1; + /** constant for a DATE column */ + private static final int DATE = 1; - /** constant for a TEXT column */ - private static final int TEXT = 2; + /** constant for a TEXT column */ + private static final int TEXT = 2; - /** - * Create a new instance of the Item list configuration. This loads - * all the required information from configuration - * - * @throws BrowseException - */ - public ItemListConfig() - throws BrowseException - { - try - { - String configLine = ConfigurationManager.getProperty("webui.itemlist.columns"); - - if (configLine == null || "".equals(configLine)) - { - throw new BrowseException("There is no configuration for webui.itemlist.columns"); - } - - // parse the config - StringTokenizer st = new StringTokenizer(configLine, ","); - int i = 1; - while (st.hasMoreTokens()) - { - Integer key = Integer.valueOf(i); - String token = st.nextToken(); - - // find out if the field is a date - if (token.indexOf("(date)") > 0) - { - token = token.replaceAll("\\(date\\)", ""); - types.put(key, Integer.valueOf(ItemListConfig.DATE)); - } - else - { - types.put(key, Integer.valueOf(ItemListConfig.TEXT)); - } - - String[] mdBits = interpretField(token.trim(), null); - metadata.put(key, mdBits); - - // don't forget to increment the key counter - i++; - } - } - catch (IOException e) - { - throw new BrowseException(e); - } - } + /** + * Create a new instance of the Item list configuration. This loads + * all the required information from configuration + * + * @throws BrowseException + */ + public ItemListConfig() + throws BrowseException + { + try + { + String configLine = ConfigurationManager.getProperty("webui.itemlist.columns"); - /** - * how many columns are there? - * - * @return the number of columns - */ - public int numCols() - { - return metadata.size(); - } + if (configLine == null || "".equals(configLine)) + { + throw new BrowseException("There is no configuration for webui.itemlist.columns"); + } + + // parse the config + StringTokenizer st = new StringTokenizer(configLine, ","); + int i = 1; + while (st.hasMoreTokens()) + { + Integer key = Integer.valueOf(i); + String token = st.nextToken(); + + // find out if the field is a date + if (token.indexOf("(date)") > 0) + { + token = token.replaceAll("\\(date\\)", ""); + types.put(key, Integer.valueOf(ItemListConfig.DATE)); + } + else + { + types.put(key, Integer.valueOf(ItemListConfig.TEXT)); + } + + String[] mdBits = interpretField(token.trim(), null); + metadata.put(key, mdBits); + + // don't forget to increment the key counter + i++; + } + } + catch (IOException e) + { + throw new BrowseException(e); + } + } + + /** + * how many columns are there? + * + * @return the number of columns + */ + public int numCols() + { + return metadata.size(); + } - /** - * what metadata is to go in the given column number - * - * @param col - * @return - */ - public String[] getMetadata(int col) - { - return metadata.get(Integer.valueOf(col)); - } - - /** + /** + * what metadata is to go in the given column number + * + * @param col + */ + public String[] getMetadata(int col) + { + return metadata.get(Integer.valueOf(col)); + } + + /** * Take a string representation of a metadata field, and return it as an array. * This is just a convenient utility method to basically break the metadata * representation up by its delimiter (.), and stick it in an array, inserting diff --git a/dspace-api/src/main/java/org/dspace/checker/ChecksumHistory.java b/dspace-api/src/main/java/org/dspace/checker/ChecksumHistory.java index 825d99eb89..66f026f431 100644 --- a/dspace-api/src/main/java/org/dspace/checker/ChecksumHistory.java +++ b/dspace-api/src/main/java/org/dspace/checker/ChecksumHistory.java @@ -176,8 +176,6 @@ public class ChecksumHistory /** * Return the processing result. - * - * @return */ public String getResult() { diff --git a/dspace-api/src/main/java/org/dspace/checker/ResultsPruner.java b/dspace-api/src/main/java/org/dspace/checker/ResultsPruner.java index 4c4e1d8d9f..af7f0df73a 100644 --- a/dspace-api/src/main/java/org/dspace/checker/ResultsPruner.java +++ b/dspace-api/src/main/java/org/dspace/checker/ResultsPruner.java @@ -110,7 +110,6 @@ public final class ResultsPruner * properties. * * @param props - * @return * @throws FileNotFoundException */ public static ResultsPruner getPruner(Properties props) diff --git a/dspace-api/src/main/java/org/dspace/content/Bitstream.java b/dspace-api/src/main/java/org/dspace/content/Bitstream.java index 46741c6903..d7465facf7 100644 --- a/dspace-api/src/main/java/org/dspace/content/Bitstream.java +++ b/dspace-api/src/main/java/org/dspace/content/Bitstream.java @@ -686,9 +686,11 @@ public class Bitstream extends DSpaceObject } /** - * Get the parent object of a bitstream. It can either be an item if this is a normal - * bitstream, otherwise it could be a collection or a community if it is a logo. - * @return + * Get the parent object of a bitstream. The parent can be an item if this + * is a normal bitstream, or it could be a collection or a community if the + * bitstream is a logo. + * + * @return this bitstream's parent. * @throws SQLException */ public DSpaceObject getParentObject() throws SQLException diff --git a/dspace-api/src/main/java/org/dspace/content/LicenseUtils.java b/dspace-api/src/main/java/org/dspace/content/LicenseUtils.java index 8a6c419e26..56c40822c4 100644 --- a/dspace-api/src/main/java/org/dspace/content/LicenseUtils.java +++ b/dspace-api/src/main/java/org/dspace/content/LicenseUtils.java @@ -32,8 +32,8 @@ public class LicenseUtils * Return the text of the license that the user has granted/must grant * before for submit the item. The license text is build using the template * defined for the collection if any or the wide site configuration. In the - * license text the following substitution can be used. {0} the eperson - * firstname
+ * license text the following substitutions can be used.
+ * {0} the eperson firstname
* {1} the eperson lastname
* {2} the eperson email
* {3} the current date
@@ -46,7 +46,7 @@ public class LicenseUtils * {x} any addition argument supplied wrapped in the * LicenseArgumentFormatter based on his type (map key) * - * @see LicenseArgumentFormatter + * @see license.LicenseArgumentFormatter * @param locale * @param collection * @param item @@ -90,15 +90,15 @@ public class LicenseUtils } /** - * Utility method if no additional arguments has need to be supplied to the - * license template. (i.e. call the full getLicenseText supplying - * null for the additionalInfo argument) - * + * Utility method if no additional arguments are to be supplied to the + * license template. (equivalent to calling the full getLicenseText + * supplying {@code null} for the additionalInfo argument) + * * @param locale * @param collection * @param item * @param eperson - * @return + * @return the license text, with no custom substitutions. */ public static String getLicenseText(Locale locale, Collection collection, Item item, EPerson eperson) diff --git a/dspace-api/src/main/java/org/dspace/content/MetadataField.java b/dspace-api/src/main/java/org/dspace/content/MetadataField.java index bada1ee5e3..d904f70e61 100644 --- a/dspace-api/src/main/java/org/dspace/content/MetadataField.java +++ b/dspace-api/src/main/java/org/dspace/content/MetadataField.java @@ -661,7 +661,7 @@ public class MetadataField * Return true if other is the same MetadataField * as this object, false otherwise * - * @param other + * @param obj * object to compare to * * @return true if object passed in represents the same diff --git a/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSDisseminator.java b/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSDisseminator.java index 15f5a16f24..c5ff7a1adc 100644 --- a/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSDisseminator.java +++ b/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSDisseminator.java @@ -213,11 +213,11 @@ public abstract class AbstractMETSDisseminator * a failure creating the package. * * @param context DSpace context. - * @param object DSpace object (item, collection, etc) + * @param dso DSpace object (item, collection, etc) * @param params Properties-style list of options specific to this packager * @param pkgFile File where export package should be written - * @throws PackageValidationException if package cannot be created or there is - * a fatal error in creating it. + * @throws PackageValidationException if package cannot be created or there + * is a fatal error in creating it. */ @Override public void disseminate(Context context, DSpaceObject dso, @@ -1219,7 +1219,7 @@ public abstract class AbstractMETSDisseminator * @param type - type attr value for the
* @param dso - object for which to create the div * @param params - * @return + * @return a new {@code Div} with {@code dso} as child. */ protected Div makeChildDiv(String type, DSpaceObject dso, PackageParameters params) { @@ -1394,7 +1394,7 @@ public abstract class AbstractMETSDisseminator * @param context current DSpace Context * @param params current Packager Parameters * @param dso current DSpace Object - * @param ref the rightsMD element + * @param mdRef the rightsMD element * @throws SQLException * @throws IOException * @throws AuthorizeException diff --git a/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSIngester.java b/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSIngester.java index 1ce1f63d41..1f6b637ea9 100644 --- a/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSIngester.java +++ b/dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSIngester.java @@ -1326,7 +1326,7 @@ public abstract class AbstractMETSIngester extends AbstractPackageIngester * DSpace Context * @param manifest * METS manifest - * @returns a DSpace Object which is the parent (or null, if not found) + * @return a DSpace Object which is the parent (or null, if not found) * @throws PackageValidationException * if parent reference cannot be found in manifest * @throws MetadataValidationException @@ -1377,7 +1377,7 @@ public abstract class AbstractMETSIngester extends AbstractPackageIngester * * @param manifest * METS manifest - * @returns handle as a string (or null, if not found) + * @return handle as a string (or null, if not found) * @throws PackageValidationException * if handle cannot be found in manifest */ @@ -1574,7 +1574,7 @@ public abstract class AbstractMETSIngester extends AbstractPackageIngester /** * Determines what type of DSpace object is represented in this METS doc. * - * @returns one of the object types in Constants. + * @return one of the object types in Constants. */ public abstract int getObjectType(METSManifest manifest) throws PackageValidationException; diff --git a/dspace-api/src/main/java/org/dspace/content/packager/AbstractPackageDisseminator.java b/dspace-api/src/main/java/org/dspace/content/packager/AbstractPackageDisseminator.java index 06997acdeb..e9689cce0b 100644 --- a/dspace-api/src/main/java/org/dspace/content/packager/AbstractPackageDisseminator.java +++ b/dspace-api/src/main/java/org/dspace/content/packager/AbstractPackageDisseminator.java @@ -163,7 +163,7 @@ public abstract class AbstractPackageDisseminator /** * Add File to list of successfully disseminated package files - * @param file File + * @param f added File. */ protected void addToPackageList(File f) { diff --git a/dspace-api/src/main/java/org/dspace/content/packager/PackageParameters.java b/dspace-api/src/main/java/org/dspace/content/packager/PackageParameters.java index 269df9a926..b062fefe64 100644 --- a/dspace-api/src/main/java/org/dspace/content/packager/PackageParameters.java +++ b/dspace-api/src/main/java/org/dspace/content/packager/PackageParameters.java @@ -168,7 +168,6 @@ public class PackageParameters extends Properties * Utility method to enable/disable workflow for Item ingestion. * * @param value boolean value (true = workflow enabled, false = workflow disabled) - * @return boolean result */ public void setWorkflowEnabled(boolean value) { @@ -212,7 +211,6 @@ public class PackageParameters extends Properties * either skip-over (keep) or replace existing objects. * * @param value boolean value (true = restore enabled, false = restore disabled) - * @return boolean result */ public void setRestoreModeEnabled(boolean value) { @@ -244,7 +242,6 @@ public class PackageParameters extends Properties * of "restore", where the current object is being restored to a previous state. * * @param value boolean value (true = replace enabled, false = replace disabled) - * @return boolean result */ public void setReplaceModeEnabled(boolean value) { @@ -276,7 +273,6 @@ public class PackageParameters extends Properties * essentially restores all missing objects, but keeps existing ones intact. * * @param value boolean value (true = replace enabled, false = replace disabled) - * @return boolean result */ public void setKeepExistingModeEnabled(boolean value) { @@ -303,7 +299,6 @@ public class PackageParameters extends Properties * Item Template * * @param value boolean value (true = template enabled, false = template disabled) - * @return boolean result */ public void setUseCollectionTemplate(boolean value) { @@ -336,7 +331,6 @@ public class PackageParameters extends Properties * recursively performs the same action on all related objects. * * @param value boolean value (true = recursion enabled, false = recursion disabled) - * @return boolean result */ public void setRecursiveModeEnabled(boolean value) { diff --git a/dspace-api/src/main/java/org/dspace/core/Context.java b/dspace-api/src/main/java/org/dspace/core/Context.java index 15023c3351..e0e530430f 100644 --- a/dspace-api/src/main/java/org/dspace/core/Context.java +++ b/dspace-api/src/main/java/org/dspace/core/Context.java @@ -561,10 +561,8 @@ public class Context } /** - * gets an array of all of the special groups that current user is a member - * of - * - * @return + * Get an array of all of the special groups that current user is a member + * of. * @throws SQLException */ public Group[] getSpecialGroups() throws SQLException diff --git a/dspace-api/src/main/java/org/dspace/core/I18nUtil.java b/dspace-api/src/main/java/org/dspace/core/I18nUtil.java index 73b38c9d84..931e900af4 100644 --- a/dspace-api/src/main/java/org/dspace/core/I18nUtil.java +++ b/dspace-api/src/main/java/org/dspace/core/I18nUtil.java @@ -95,7 +95,6 @@ public class I18nUtil * return the default Locale for the repository. * * @param ep - * @return */ public static Locale getEPersonLocale(EPerson ep) { diff --git a/dspace-api/src/main/java/org/dspace/core/PluginInstantiationException.java b/dspace-api/src/main/java/org/dspace/core/PluginInstantiationException.java index d34bdbf23c..42a301b170 100644 --- a/dspace-api/src/main/java/org/dspace/core/PluginInstantiationException.java +++ b/dspace-api/src/main/java/org/dspace/core/PluginInstantiationException.java @@ -34,7 +34,7 @@ public class PluginInstantiationException extends RuntimeException /** * @param msg Error message text. - * @cause cause other exception that this one is wrapping. + * @param cause other exception that this one is wrapping. */ public PluginInstantiationException(String msg, Throwable cause) { @@ -42,7 +42,7 @@ public class PluginInstantiationException extends RuntimeException } /** - * @cause cause other exception that this one is wrapping. + * @param cause other exception that this one is wrapping. */ public PluginInstantiationException(Throwable cause) { diff --git a/dspace-api/src/main/java/org/dspace/curate/Curator.java b/dspace-api/src/main/java/org/dspace/curate/Curator.java index ff1b11bad8..ab263ec984 100644 --- a/dspace-api/src/main/java/org/dspace/curate/Curator.java +++ b/dspace-api/src/main/java/org/dspace/curate/Curator.java @@ -133,7 +133,7 @@ public class Curator * Assigns invocation mode. * * @param mode one of INTERACTIVE, BATCH, ANY - * @return + * @return the Curator instance. */ public Curator setInvoked(Invoked mode) { diff --git a/dspace-api/src/main/java/org/dspace/discovery/SearchService.java b/dspace-api/src/main/java/org/dspace/discovery/SearchService.java index 67b70accfd..0b830f3d36 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SearchService.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SearchService.java @@ -31,13 +31,9 @@ public interface SearchService { * repository) * * @param context - * DSpace Context object - * @param dso - * a DSpace Object to use as scope of the search (only results - * within this object) + * DSpace Context object. * @param query - * the discovery query object - * @return + * the discovery query object. * @throws SearchServiceException */ DiscoverResult search(Context context, DiscoverQuery query) @@ -54,7 +50,6 @@ public interface SearchService { * within this object) * @param query * the discovery query object - * @return * @throws SearchServiceException */ DiscoverResult search(Context context, DSpaceObject dso, DiscoverQuery query) @@ -63,14 +58,12 @@ public interface SearchService { /** * * @param context - * DSpace Context object - * @param dso - * a DSpace Object to use as scope of the search (only results - * within this object) + * DSpace Context object. + * @param query + * the discovery query object. * @param includeWithdrawn * use true to include in the results also withdrawn - * items that match the query - * @return + * items that match the query. * @throws SearchServiceException */ DiscoverResult search(Context context, DiscoverQuery query, @@ -89,7 +82,6 @@ public interface SearchService { * use true to include in the results also withdrawn * items that match the query * - * @return * @throws SearchServiceException */ DiscoverResult search(Context context, DSpaceObject dso, DiscoverQuery query, boolean includeWithdrawn) throws SearchServiceException; diff --git a/dspace-api/src/main/java/org/dspace/eperson/Group.java b/dspace-api/src/main/java/org/dspace/eperson/Group.java index 9fab791d81..d510878c54 100644 --- a/dspace-api/src/main/java/org/dspace/eperson/Group.java +++ b/dspace-api/src/main/java/org/dspace/eperson/Group.java @@ -343,12 +343,11 @@ public class Group extends DSpaceObject } /** - * check to see if g is a direct group member. + * Check to see if g is a direct group member. * If g is a subgroup via another group will be returned false * * @param g * group to check - * @return */ public boolean isMember(Group g) { @@ -381,11 +380,10 @@ public class Group extends DSpaceObject } /** - * Get all of the groups that an eperson is a member of + * Get all of the groups that an eperson is a member of. * * @param c * @param e - * @return * @throws SQLException */ public static Group[] allMemberGroups(Context c, EPerson e) @@ -1052,9 +1050,7 @@ public class Group extends DSpaceObject } /** - * Return Group members of a Group - * - * @return + * Return Group members of a Group. */ public Group[] getMemberGroups() { diff --git a/dspace-api/src/main/java/org/dspace/eperson/PasswordHash.java b/dspace-api/src/main/java/org/dspace/eperson/PasswordHash.java index dc9255b817..329597fa4c 100644 --- a/dspace-api/src/main/java/org/dspace/eperson/PasswordHash.java +++ b/dspace-api/src/main/java/org/dspace/eperson/PasswordHash.java @@ -22,10 +22,10 @@ import org.slf4j.LoggerFactory; /** * For handling digested secrets (such as passwords). - * Use {@link PasswordHash(String, byte[], byte[])} to package and manipulate - * secrets that have already been hashed, and {@link PasswordHash(String)} for + * Use {@link #PasswordHash(String, byte[], byte[])} to package and manipulate + * secrets that have already been hashed, and {@link #PasswordHash(String)} for * plaintext secrets. Compare a plaintext candidate to a hashed secret with - * {@link matches(String)}. + * {@link #matches(String)}. * * @author mwood */ @@ -78,7 +78,7 @@ public class PasswordHash } /** - * Convenience: like {@link PasswordHash(String, byte[], byte[])} but with + * Convenience: like {@link #PasswordHash(String, byte[], byte[])} but with * hexadecimal-encoded {@code String}s. * @param algorithm the digest algorithm used in producing {@code hash}. * If empty, set to null. Other methods will treat this as unsalted MD5. diff --git a/dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java b/dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java index 02165f92ae..ae5aa1c7ed 100644 --- a/dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java +++ b/dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java @@ -27,48 +27,48 @@ import java.util.List; public class HarvestedCollection { - private Context context; - private TableRow harvestRow; + private Context context; + private TableRow harvestRow; - public static final int TYPE_NONE = 0; - public static final int TYPE_DMD = 1; - public static final int TYPE_DMDREF = 2; - public static final int TYPE_FULL = 3; + public static final int TYPE_NONE = 0; + public static final int TYPE_DMD = 1; + public static final int TYPE_DMDREF = 2; + public static final int TYPE_FULL = 3; - public static final int STATUS_READY = 0; - public static final int STATUS_BUSY = 1; - public static final int STATUS_QUEUED = 2; - public static final int STATUS_OAI_ERROR = 3; - public static final int STATUS_UNKNOWN_ERROR = -1; + public static final int STATUS_READY = 0; + public static final int STATUS_BUSY = 1; + public static final int STATUS_QUEUED = 2; + public static final int STATUS_OAI_ERROR = 3; + public static final int STATUS_UNKNOWN_ERROR = -1; - /* - * collection_id | integer | not null - harvest_type | integer | - oai_source | text | - oai_set_id | text | - harvest_message | text | - metadata_config_id | text | - harvest_status | integer | - harvest_start_time | timestamp with time zone | - */ + /* + * collection_id | integer | not null + * harvest_type | integer | + * oai_source | text | + * oai_set_id | text | + * harvest_message | text | + * metadata_config_id | text | + * harvest_status | integer | + * harvest_start_time | timestamp with time zone | + */ - // TODO: make sure this guy knows to lock people out if the status is not zero. - // i.e. someone editing a collection's setting from the admin menu should have - // to stop an ongoing harvest before they can edit the settings. - - - HarvestedCollection(Context c, TableRow row) + // TODO: make sure this guy knows to lock people out if the status is not zero. + // i.e. someone editing a collection's setting from the admin menu should have + // to stop an ongoing harvest before they can edit the settings. + + + HarvestedCollection(Context c, TableRow row) { context = c; harvestRow = row; } - - + + public static void exists(Context c) throws SQLException { DatabaseManager.queryTable(c, "harvested_collection", "SELECT COUNT(*) FROM harvested_collection"); } - - + + /** * Find the harvest settings corresponding to this collection * @return a HarvestInstance object corresponding to this collection's settings, null if not found. @@ -76,14 +76,14 @@ public class HarvestedCollection public static HarvestedCollection find(Context c, int collectionId) throws SQLException { TableRow row = DatabaseManager.findByUnique(c, "harvested_collection", "collection_id", collectionId); - + if (row == null) { - return null; + return null; } - + return new HarvestedCollection(c, row); } - + /** * Create a new harvest instance row for a specified collection. * @return a new HarvestInstance object @@ -93,10 +93,10 @@ public class HarvestedCollection row.setColumn("collection_id", collectionId); row.setColumn("harvest_type", 0); DatabaseManager.insert(c, row); - + return new HarvestedCollection(c, row); } - + /** Returns whether the specified collection is harvestable, i.e. whether its harvesting * options are set up correctly. This is distinct from "ready", since this collection may * be in process of being harvested. @@ -105,12 +105,12 @@ public class HarvestedCollection { HarvestedCollection hc = HarvestedCollection.find(c, collectionId); if (hc != null && hc.getHarvestType() > 0 && hc.getOaiSource() != null && hc.getOaiSetId() != null && - hc.getHarvestStatus() != HarvestedCollection.STATUS_UNKNOWN_ERROR) { - return true; + hc.getHarvestStatus() != HarvestedCollection.STATUS_UNKNOWN_ERROR) { + return true; } return false; } - + /** Returns whether this harvest instance is actually harvestable, i.e. whether its settings * options are set up correctly. This is distinct from "ready", since this collection may * be in process of being harvested. @@ -118,13 +118,13 @@ public class HarvestedCollection public boolean isHarvestable() throws SQLException { if (this.getHarvestType() > 0 && this.getOaiSource() != null && this.getOaiSetId() != null && - this.getHarvestStatus() != HarvestedCollection.STATUS_UNKNOWN_ERROR) { - return true; + this.getHarvestStatus() != HarvestedCollection.STATUS_UNKNOWN_ERROR) { + return true; } return false; } - + /** Returns whether the specified collection is ready for immediate harvest. */ public static boolean isReady(Context c, int collectionId) throws SQLException @@ -132,18 +132,18 @@ public class HarvestedCollection HarvestedCollection hc = HarvestedCollection.find(c, collectionId); return hc.isReady(); } - + public boolean isReady() throws SQLException { if (this.isHarvestable() && (this.getHarvestStatus() == HarvestedCollection.STATUS_READY || this.getHarvestStatus() == HarvestedCollection.STATUS_OAI_ERROR)) - { - return true; - } + { + return true; + } return false; } - - + + /** Find all collections that are set up for harvesting * * return: list of collection id's @@ -152,18 +152,18 @@ public class HarvestedCollection public static List findAll(Context c) throws SQLException { TableRowIterator tri = DatabaseManager.queryTable(c, "harvested_collection", - "SELECT * FROM harvested_collection"); - + "SELECT * FROM harvested_collection"); + List collectionIds = new ArrayList(); while (tri.hasNext()) - { + { TableRow row = tri.next(); collectionIds.add(row.getIntColumn("collection_id")); - } - + } + return collectionIds; } - + /** Find all collections that are ready for harvesting * * return: list of collection id's @@ -173,10 +173,10 @@ public class HarvestedCollection { int harvestInterval = ConfigurationManager.getIntProperty("oai", "harvester.harvestFrequency"); if (harvestInterval == 0) - { - harvestInterval = 720; - } - + { + harvestInterval = 720; + } + int expirationInterval = ConfigurationManager.getIntProperty("oai", "harvester.threadTimeout"); if (expirationInterval == 0) { @@ -185,69 +185,69 @@ public class HarvestedCollection Date startTime; Date expirationTime; - + Calendar calendar = Calendar.getInstance(); - calendar.setTime(new Date()); - calendar.add(Calendar.MINUTE, -1 * harvestInterval); - startTime = calendar.getTime(); - - calendar.setTime(startTime); - calendar.add(Calendar.HOUR, -2 * expirationInterval); - expirationTime = calendar.getTime(); - + calendar.setTime(new Date()); + calendar.add(Calendar.MINUTE, -1 * harvestInterval); + startTime = calendar.getTime(); + + calendar.setTime(startTime); + calendar.add(Calendar.HOUR, -2 * expirationInterval); + expirationTime = calendar.getTime(); + /* Select all collections whose last_harvest is before our start time, whose harvest_type *is not* 0 and whose status *is* 0 (available) or 3 (OAI Error). */ TableRowIterator tri = DatabaseManager.queryTable(c, "harvested_collection", "SELECT * FROM harvested_collection WHERE (last_harvested < ? or last_harvested is null) and harvest_type > ? and (harvest_status = ? or harvest_status = ? or (harvest_status=? and harvest_start_time < ?)) ORDER BY last_harvested", new java.sql.Timestamp(startTime.getTime()), 0, HarvestedCollection.STATUS_READY, HarvestedCollection.STATUS_OAI_ERROR, HarvestedCollection.STATUS_BUSY, new java.sql.Timestamp(expirationTime.getTime())); - + List collectionIds = new ArrayList(); while (tri.hasNext()) { - TableRow row = tri.next(); - collectionIds.add(row.getIntColumn("collection_id")); + TableRow row = tri.next(); + collectionIds.add(row.getIntColumn("collection_id")); } - + return collectionIds; } - + /** * Find all collections with the specified status flag * @param c * @param status see HarvestInstance.STATUS_... - * @return + * @return matching Collection IDs. * @throws SQLException */ public static List findByStatus(Context c, int status) throws SQLException { TableRowIterator tri = DatabaseManager.queryTable(c, "harvested_collection", "SELECT * FROM harvested_collection WHERE harvest_status = ?", status); - - List collectionIds = new ArrayList(); - while (tri.hasNext()) - { - TableRow row = tri.next(); - collectionIds.add(row.getIntColumn("collection_id")); - } - - return collectionIds; + + List collectionIds = new ArrayList(); + while (tri.hasNext()) + { + TableRow row = tri.next(); + collectionIds.add(row.getIntColumn("collection_id")); + } + + return collectionIds; } - - + + /** Find the collection that was harvested the longest time ago. * @throws SQLException */ public static Integer findOldestHarvest (Context c) throws SQLException { String query = "select collection_id from harvested_collection where harvest_type > ? and harvest_status = ? order by last_harvested asc limit 1"; - + if ("oracle".equals(ConfigurationManager.getProperty("db.name"))) - { + { query = "select collection_id from harvested_collection where harvest_type > ? and harvest_status = ? and rownum <= 1 order by last_harvested asc"; } - + TableRowIterator tri = DatabaseManager.queryTable(c, "harvested_collection", - query, 0, 0); + query, 0, 0); TableRow row = tri.next(); - + if (row != null) { return row.getIntColumn("collection_id"); @@ -257,7 +257,7 @@ public class HarvestedCollection return -1; } } - + /** Find the collection that was harvested most recently. * @throws SQLException */ diff --git a/dspace-api/src/main/java/org/dspace/identifier/IdentifierService.java b/dspace-api/src/main/java/org/dspace/identifier/IdentifierService.java index e9af1449f3..6b75e7ed8c 100644 --- a/dspace-api/src/main/java/org/dspace/identifier/IdentifierService.java +++ b/dspace-api/src/main/java/org/dspace/identifier/IdentifierService.java @@ -23,25 +23,28 @@ import java.sql.SQLException; public interface IdentifierService { /** + * Get an identifier for a given object which is assignment-compatible + * with a given Identifier type. * * @param context - * @param dso - * @param identifier - * @return + * @param dso the object to be identified. + * @param identifier instance of an Identifier of the required type. + * @return the matching identifier, or the site identifier if the object + * is a Site, or null if no matching identifier is found. */ String lookup(Context context, DSpaceObject dso, Class identifier); /** * - * This will resolve a DSpaceObject based on a provided Identifier. The Service will interrogate the providers in - * no particular order and return the first successful result discovered. If no resolution is successful, - * the method will return null if no object is found. + * This will resolve a DSpaceObject based on a provided Identifier. + * The Service will interrogate the providers in no particular order + * and return the first successful result discovered. If no resolution + * is successful, the method will return null if no object is found. * * TODO: Verify null is returned. * * @param context * @param identifier - * @return * @throws IdentifierNotFoundException * @throws IdentifierNotResolvableException */ @@ -78,7 +81,6 @@ public interface IdentifierService { * * @param context * @param dso - * @return * @throws org.dspace.authorize.AuthorizeException * @throws java.sql.SQLException * @throws IdentifierException @@ -87,14 +89,14 @@ public interface IdentifierService { /** * - * Used to Register a Specific Identifier (for example a Handle, hdl:1234.5/6) The provider is responsible for - * Detecting and Processing the appropriate identifier, all Providers are interrogated, multiple providers + * Used to Register a specific Identifier (for example a Handle, hdl:1234.5/6) + * The provider is responsible for detecting and processing the appropriate + * identifier. All Providers are interrogated. Multiple providers * can process the same identifier. * * @param context * @param dso * @param identifier - * @return * @throws org.dspace.authorize.AuthorizeException * @throws java.sql.SQLException * @throws IdentifierException diff --git a/dspace-api/src/main/java/org/dspace/license/CCLookup.java b/dspace-api/src/main/java/org/dspace/license/CCLookup.java index 07b670fb2e..d0fe7f1453 100644 --- a/dspace-api/src/main/java/org/dspace/license/CCLookup.java +++ b/dspace-api/src/main/java/org/dspace/license/CCLookup.java @@ -153,7 +153,6 @@ public class CCLookup { * @return A Collection of LicenseField objects. * * @see CCLicense - * @see LicenseField * */ public Collection getLicenseFields(String license) { diff --git a/dspace-api/src/main/java/org/dspace/license/LicenseCleanup.java b/dspace-api/src/main/java/org/dspace/license/LicenseCleanup.java index ea7e999f37..dd22011172 100644 --- a/dspace-api/src/main/java/org/dspace/license/LicenseCleanup.java +++ b/dspace-api/src/main/java/org/dspace/license/LicenseCleanup.java @@ -188,8 +188,8 @@ public class LicenseCleanup /** * Fast stream copy routine * - * @param b - * @return + * @param b the Bitstream to be copied. + * @return copy of the content of {@code b}. * @throws IOException * @throws SQLException * @throws AuthorizeException diff --git a/dspace-api/src/main/java/org/dspace/sort/SortOption.java b/dspace-api/src/main/java/org/dspace/sort/SortOption.java index ed1e82be1b..8a895ee09f 100644 --- a/dspace-api/src/main/java/org/dspace/sort/SortOption.java +++ b/dspace-api/src/main/java/org/dspace/sort/SortOption.java @@ -264,9 +264,7 @@ public class SortOption } /** - * Is this a date field - * - * @return + * Is this a date field? */ public boolean isDate() { @@ -279,9 +277,7 @@ public class SortOption } /** - * Is the default sort option - * - * @return + * Is the default sort option? */ public boolean isDefault() { @@ -293,8 +289,7 @@ public class SortOption } /** - * Return all the configured sort options - * @return + * Return all the configured sort options. * @throws SortException */ public static Set getSortOptions() throws SortException @@ -308,9 +303,8 @@ public class SortOption } /** - * Get the defined sort option by number (.1, .2, etc) + * Get the defined sort option by number (.1, .2, etc). * @param number - * @return * @throws SortException */ public static SortOption getSortOption(int number) throws SortException @@ -327,8 +321,7 @@ public class SortOption } /** - * Get the default sort option - initially, just the first one defined - * @return + * Get the default sort option - initially, just the first one defined. * @throws SortException */ public static SortOption getDefaultSortOption() throws SortException diff --git a/dspace-api/src/main/java/org/dspace/statistics/DataTermsFacet.java b/dspace-api/src/main/java/org/dspace/statistics/DataTermsFacet.java index 270062d2fb..fb43b5fd7b 100644 --- a/dspace-api/src/main/java/org/dspace/statistics/DataTermsFacet.java +++ b/dspace-api/src/main/java/org/dspace/statistics/DataTermsFacet.java @@ -31,7 +31,7 @@ public class DataTermsFacet { * * An example of the output could be of the format: * [{"term":"247166","count":10},{"term":"247168","count":6}] - * @return + * @return JSON-formatted data. */ public String toJson() { Gson gson = new Gson(); diff --git a/dspace-api/src/main/java/org/dspace/statistics/util/SpiderDetector.java b/dspace-api/src/main/java/org/dspace/statistics/util/SpiderDetector.java index 7ad23e7471..c6c921f7fa 100644 --- a/dspace-api/src/main/java/org/dspace/statistics/util/SpiderDetector.java +++ b/dspace-api/src/main/java/org/dspace/statistics/util/SpiderDetector.java @@ -77,9 +77,7 @@ public class SpiderDetector { } /** - * Get an immutable Set representing all the Spider Addresses here - * - * @return + * Get an immutable Set representing all the Spider Addresses here. */ public static Set getSpiderIpAddresses() { diff --git a/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageManager.java b/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageManager.java index 53fe086b17..4ac344dfd1 100644 --- a/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageManager.java +++ b/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageManager.java @@ -710,8 +710,8 @@ public class BitstreamStorageManager /** * * @param context - * @param id of the bitstream to clone - * @return + * @param id of the bitstream to clone. + * @return id of the clone bitstream. * @throws SQLException */ public static int clone(Context context, int id) throws SQLException diff --git a/dspace-api/src/main/java/org/dspace/submit/step/DescribeStep.java b/dspace-api/src/main/java/org/dspace/submit/step/DescribeStep.java index 7525d9fdfc..e0f84bac84 100644 --- a/dspace-api/src/main/java/org/dspace/submit/step/DescribeStep.java +++ b/dspace-api/src/main/java/org/dspace/submit/step/DescribeStep.java @@ -995,7 +995,6 @@ public class DescribeStep extends AbstractProcessingStep * Return the HTML / DRI field name for the given input. * * @param input - * @return */ public static String getFieldName(DCInput input) { diff --git a/dspace-api/src/main/java/org/dspace/submit/step/SkipInitialQuestionsStep.java b/dspace-api/src/main/java/org/dspace/submit/step/SkipInitialQuestionsStep.java index e094ad5515..d0c3fc5eaf 100644 --- a/dspace-api/src/main/java/org/dspace/submit/step/SkipInitialQuestionsStep.java +++ b/dspace-api/src/main/java/org/dspace/submit/step/SkipInitialQuestionsStep.java @@ -30,7 +30,7 @@ import org.dspace.submit.AbstractProcessingStep; *

* * @see org.dspace.submit.AbstractProcessingStep - * @see org.dspace.submit.step.InitialQuestionStep + * @see org.dspace.submit.step.InitialQuestionsStep * @see org.dspace.submit.step.DescribeStep * * @author Andrea Bollini