hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #125 from mwoodiupui/javadoc

Browse Source 
Javadoc cleanup (get rid of scads of WARNINGs)
This commit is contained in:
Mark H. Wood
2012-11-28 12:48:10 -08:00
parent 407507ce31 b53314d62f
commit 32cc6002d2
113 changed files with 365 additions and 693 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java
View File

@@ -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

7
dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
View File

@@ -375,12 +375,10 @@ public class MetadataUtilities {
}
/**
* rewrite of ItemImport's functionality
* but just the parsing of the file, not the processing of its elements
*
* 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
*/
public static List<ContentsEntry> readContentsFile(File f)
throws FileNotFoundException, IOException, ParseException
@@ -423,7 +421,6 @@ public class MetadataUtilities {
/**
*
* @param f
* @return
* @throws FileNotFoundException
* @throws IOException
*/

5
dspace-api/src/main/java/org/dspace/app/packager/Packager.java
View File

@@ -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

14
dspace-api/src/main/java/org/dspace/app/sfx/SFXFileReader.java
View File

@@ -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;
}
}
}

6
dspace-api/src/main/java/org/dspace/app/statistics/LogAnalyser.java
View File

@@ -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
*/

41
dspace-api/src/main/java/org/dspace/app/statistics/StatisticsLoader.java
View File

@@ -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<String, StatsFile> 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
{

35
dspace-api/src/main/java/org/dspace/app/statistics/package.html
View File

@@ -11,37 +11,6 @@
<html>
<head>
<title>org.dspace.app.statistics package</title>
<!--
* Copyright (c) 2002-2009, The DSpace Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the DSpace Foundation nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
-->
</head>
<body>
@@ -67,11 +36,11 @@ class, defined in this package, to select an event processing implementation.
Three "stock" implementations are provided.
</p>
<dl>
<dt>{@link org.dspace.app.statistics.PassiveUsageEvent PassiveUsageEvent}</dt>
<dt>{@link org.dspace.usage.PassiveUsageEventListener PassiveUsageEventListener}</dt>
<dd>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.</dd>
<dt>{@link org.dspace.app.statistics.UsageEventTabFileLogger UsageEventTabFileLogger}</dt>
<dt>{@link org.dspace.usage.TabFileUsageEventListener TabFileUsageEventListener}</dt>
<dd>writes event records to a file in Tab Separated Values format.</dd>
<dt>{@link org.dspace.app.statistics.UsageEventXMLLogger UsageEventXMLLogger}</dt>
<dd>writes event records to a file in an XML format. Suitable mainly for

1
dspace-api/src/main/java/org/dspace/app/util/DCInput.java
View File

@@ -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
{

1
dspace-api/src/main/java/org/dspace/app/util/GoogleMetadata.java
View File

@@ -772,7 +772,6 @@ public class GoogleMetadata
/**
* Produce meta elements that can easily be put into the head.
* @return
*/
public List<Element> disseminateList()
{

66
dspace-api/src/main/java/org/dspace/authorize/AuthorizeConfiguration.java
View File

@@ -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()
{

2
dspace-api/src/main/java/org/dspace/browse/BrowseCreateDAO.java
View File

@@ -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;

28
dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtils.java
View File

@@ -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);

30
dspace-api/src/main/java/org/dspace/browse/BrowseDAOUtilsDefault.java
View File

@@ -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)
{

30
dspace-api/src/main/java/org/dspace/browse/BrowseIndex.java
View File

@@ -485,8 +485,6 @@ public final class BrowseIndex
* <code>
* getTableName(false, false, false, false);
* </code>
*
* @return
*/
public String getTableName()
{
@@ -494,7 +492,7 @@ public final class BrowseIndex
}
/**
* Get the table name for the given set of circumstances
* Get the table name for the given set of circumstances.
*
* This is the same as calling:
*
@@ -505,7 +503,6 @@ public final class BrowseIndex
* @param isDistinct is this a distinct table
* @param isCommunity
* @param isCollection
* @return
* @deprecated 1.5
*/
public String getTableName(boolean isDistinct, boolean isCommunity, boolean isCollection)
@@ -519,8 +516,6 @@ public final class BrowseIndex
* <code>
* getTableName(false, false, false, true);
* </code>
*
* @return
*/
public String getMapTableName()
{
@@ -533,8 +528,6 @@ public final class BrowseIndex
* <code>
* getTableName(false, false, true, false);
* </code>
*
* @return
*/
public String getDistinctTableName()
{
@@ -629,8 +622,7 @@ public final class BrowseIndex
}
/**
* Get the field for sorting associated with this index
* @return
* Get the field for sorting associated with this index.
* @throws BrowseException
*/
public String getSortField(boolean isSecondLevel) throws BrowseException
@@ -657,7 +649,6 @@ public final class BrowseIndex
/**
* @deprecated
* @return
* @throws BrowseException
*/
public static String[] tables()
@@ -728,10 +719,9 @@ public final class BrowseIndex
}
/**
* Get the configured browse index that is defined to use this sort option
* Get the configured browse index that is defined to use this sort option.
*
* @param so
* @return
* @throws BrowseException
*/
public static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException
@@ -748,9 +738,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 +746,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 +792,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 +800,8 @@ public final class BrowseIndex
}
/**
* Generate a base table name
* Generate a base table name.
* @param number
* @return
*/
private static String makeTableBaseName(int number)
{

2
dspace-api/src/main/java/org/dspace/browse/BrowseInfo.java
View File

@@ -496,7 +496,7 @@ public class BrowseInfo
/**
* @deprecated
* @return
* @return an empty array of Item.
*/
public Item[] getItemResults()
{

2
dspace-api/src/main/java/org/dspace/browse/BrowseItem.java
View File

@@ -160,7 +160,6 @@ public class BrowseItem extends DSpaceObject
/**
* @deprecated
* @param real
* @return
*/
public int getType(boolean real)
{
@@ -301,7 +300,6 @@ public class BrowseItem extends DSpaceObject
* rendering. That's your own fault for wanting to put images on your
* browse page!
*
* @return
* @throws SQLException
*/
public Thumbnail getThumbnail()

2
dspace-api/src/main/java/org/dspace/browse/BrowseItemDAO.java
View File

@@ -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)

8
dspace-api/src/main/java/org/dspace/browse/CrossLinks.java
View File

@@ -26,7 +26,7 @@ public class CrossLinks
private Map<String, String> links = new HashMap<String, String>();
/**
* Construct a new object which will obtain the configuration for itself
* Construct a new object which will obtain the configuration for itself.
*
* @throws BrowseException
*/
@@ -54,10 +54,9 @@ public class CrossLinks
}
/**
* Is there a link for the given canonical form of metadata (i.e. schema.element.qualifier)
* 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)
{
@@ -65,10 +64,9 @@ public class CrossLinks
}
/**
* get the type of link that the bit of metadata has
* 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)
{

1
dspace-api/src/main/java/org/dspace/browse/IndexBrowse.java
View File

@@ -599,7 +599,6 @@ public class IndexBrowse
* remove all the indices for the given item
*
* @param item the item to be removed
* @return
* @throws BrowseException
*/
public boolean itemRemoved(Item item)

3
dspace-api/src/main/java/org/dspace/browse/ItemCountDAO.java
View File

@@ -50,10 +50,9 @@ public interface ItemCountDAO
/**
* 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
* Collection. Otherwise it will throw an exception.
*
* @param dso
* @return
* @throws ItemCountException
*/
public int getCount(DSpaceObject dso) throws ItemCountException;

1
dspace-api/src/main/java/org/dspace/browse/ItemCountDAOFactory.java
View File

@@ -24,7 +24,6 @@ public class ItemCountDAOFactory
* for the specific DSpace instance.
*
* @param context
* @return
* @throws ItemCountException
*/
public static ItemCountDAO getInstance(Context context)

3
dspace-api/src/main/java/org/dspace/browse/ItemCountDAOOracle.java
View File

@@ -155,10 +155,9 @@ public class ItemCountDAOOracle implements ItemCountDAO
}
/**
* get the count of the items in the given container
* Get the count of the items in the given container.
*
* @param dso
* @return
* @throws ItemCountException
*/
public int getCount(DSpaceObject dso)

3
dspace-api/src/main/java/org/dspace/browse/ItemCountDAOPostgres.java
View File

@@ -155,10 +155,9 @@ public class ItemCountDAOPostgres implements ItemCountDAO
}
/**
* get the count of the items in the given container
* Get the count of the items in the given container.
*
* @param dso
* @return
* @throws ItemCountException
*/
public int getCount(DSpaceObject dso)

3
dspace-api/src/main/java/org/dspace/browse/ItemCounter.java
View File

@@ -101,10 +101,9 @@ public class ItemCounter
* 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
* the number of items in the container in real time.
*
* @param dso
* @return
* @throws ItemCountException
* @throws SQLException
*/

3
dspace-api/src/main/java/org/dspace/browse/ItemListConfig.java
View File

@@ -95,10 +95,9 @@ public class ItemListConfig
}
/**
* what metadata is to go in the given column number
* What metadata is to go in the given column number?
*
* @param col
* @return
*/
public String[] getMetadata(int col)
{

2
dspace-api/src/main/java/org/dspace/checker/ChecksumHistory.java
View File

@@ -176,8 +176,6 @@ public class ChecksumHistory
/**
* Return the processing result.
*
* @return
*/
public String getResult()
{

1
dspace-api/src/main/java/org/dspace/checker/ResultsPruner.java
View File

@@ -110,7 +110,6 @@ public final class ResultsPruner
* properties.
*
* @param props
* @return
* @throws FileNotFoundException
*/
public static ResultsPruner getPruner(Properties props)

8
dspace-api/src/main/java/org/dspace/content/Bitstream.java
View File

@@ -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

16
dspace-api/src/main/java/org/dspace/content/LicenseUtils.java
View File

@@ -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<br>
* license text the following substitutions can be used.<br>
* {0} the eperson firstname<br>
* {1} the eperson lastname<br>
* {2} the eperson email<br>
* {3} the current date<br>
@@ -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
* <code>null</code> 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)

2
dspace-api/src/main/java/org/dspace/content/MetadataField.java
View File

@@ -661,7 +661,7 @@ public class MetadataField
* Return <code>true</code> if <code>other</code> is the same MetadataField
* as this object, <code>false</code> otherwise
*
* @param other
* @param obj
* object to compare to
*
* @return <code>true</code> if object passed in represents the same

10
dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSDisseminator.java
View File

@@ -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 <div>
* @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 <mdRef> element
* @param mdRef the rightsMD <mdRef> element
* @throws SQLException
* @throws IOException
* @throws AuthorizeException

6
dspace-api/src/main/java/org/dspace/content/packager/AbstractMETSIngester.java
View File

@@ -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;

2
dspace-api/src/main/java/org/dspace/content/packager/AbstractPackageDisseminator.java
View File

@@ -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)
{

6
dspace-api/src/main/java/org/dspace/content/packager/PackageParameters.java
View File

@@ -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)
{

6
dspace-api/src/main/java/org/dspace/core/Context.java
View File

@@ -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

1
dspace-api/src/main/java/org/dspace/core/I18nUtil.java
View File

@@ -95,7 +95,6 @@ public class I18nUtil
* return the default Locale for the repository.
*
* @param ep
* @return
*/
public static Locale getEPersonLocale(EPerson ep)
{

4
dspace-api/src/main/java/org/dspace/core/PluginInstantiationException.java
View File

@@ -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)
{

2
dspace-api/src/main/java/org/dspace/curate/Curator.java
View File

@@ -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)
{

20
dspace-api/src/main/java/org/dspace/discovery/SearchService.java
View File

@@ -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 <code>true</code> 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 <code>true</code> 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;

10
dspace-api/src/main/java/org/dspace/eperson/Group.java
View File

@@ -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 <code>false</code>
*
* @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()
{

8
dspace-api/src/main/java/org/dspace/eperson/PasswordHash.java
View File

@@ -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.

3
dspace-api/src/main/java/org/dspace/harvest/HarvestedCollection.java
View File

@@ -212,10 +212,9 @@ public class HarvestedCollection
}
/**
* Find all collections with the specified status flag
* Find all collections with the specified status flag.
* @param c
* @param status see HarvestInstance.STATUS_...
* @return
* @throws SQLException
*/
public static List<Integer> findByStatus(Context c, int status) throws SQLException {

24
dspace-api/src/main/java/org/dspace/identifier/IdentifierService.java
View File

@@ -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<? extends Identifier> 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

1
dspace-api/src/main/java/org/dspace/license/CCLookup.java
View File

@@ -153,7 +153,6 @@ public class CCLookup {
* @return A Collection of LicenseField objects.
*
* @see CCLicense
* @see LicenseField
*
*/
public Collection<CCLicenseField> getLicenseFields(String license) {

4
dspace-api/src/main/java/org/dspace/license/LicenseCleanup.java
View File

@@ -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

17
dspace-api/src/main/java/org/dspace/sort/SortOption.java
View File

@@ -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<SortOption> 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

2
dspace-api/src/main/java/org/dspace/statistics/DataTermsFacet.java
View File

@@ -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();

4
dspace-api/src/main/java/org/dspace/statistics/util/SpiderDetector.java
View File

@@ -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<String> getSpiderIpAddresses() {

4
dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageManager.java
View File

@@ -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

1
dspace-api/src/main/java/org/dspace/submit/step/DescribeStep.java
View File

@@ -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)
{

2
dspace-api/src/main/java/org/dspace/submit/step/SkipInitialQuestionsStep.java
View File

@@ -30,7 +30,7 @@ import org.dspace.submit.AbstractProcessingStep;
* </p>
*
* @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

7
dspace-jspui/src/main/java/org/dspace/app/webui/discovery/DiscoverUtility.java
View File

@@ -40,11 +40,10 @@ public class DiscoverUtility
private static Logger log = Logger.getLogger(DiscoverUtility.class);
/**
* Get the scope of the search using the parameter found in the request
* Get the scope of the search using the parameter found in the request.
*
* @param context
* @param request
* @return
* @throws IllegalStateException
* @throws SQLException
*/
@@ -74,7 +73,7 @@ public class DiscoverUtility
* Build a DiscoverQuery object using the parameter in the request
*
* @param request
* @return
* @return the query.
* @throws SearchServiceException
*/
public static DiscoverQuery getDiscoverQuery(Context context,
@@ -107,7 +106,7 @@ public class DiscoverUtility
* @param context
* @param request
* @param scope
* @return
* @return the query.
*/
public static DiscoverQuery getDiscoverAutocomplete(Context context,
HttpServletRequest request, DSpaceObject scope)

2
dspace-jspui/src/main/java/org/dspace/app/webui/discovery/DiscoverySearchRequestProcessor.java
View File

@@ -465,7 +465,7 @@ public class DiscoverySearchRequestProcessor implements SearchRequestProcessor
/**
* Method for constructing the discovery advanced search form
*
* @author Andrea Bollini
* author: Andrea Bollini
*/
@Override
public void doAdvancedSearch(Context context, HttpServletRequest request,

6
dspace-jspui/src/main/java/org/dspace/app/webui/search/LuceneSearchRequestProcessor.java
View File

@@ -82,7 +82,7 @@ public class LuceneSearchRequestProcessor implements SearchRequestProcessor
* location), a the ID of a community (e.g. "123"), or a community ID, then
* a slash, then a collection ID, e.g. "123/456".
*
* @author Robert Tansley
* author: Robert Tansley
*/
@Override
public void doSimpleSearch(Context context, HttpServletRequest request,
@@ -465,7 +465,7 @@ public class LuceneSearchRequestProcessor implements SearchRequestProcessor
/**
* Method for constructing the advanced search form
*
* @author gam
* author: gam
*/
@Override
public void doAdvancedSearch(Context context, HttpServletRequest request,
@@ -496,7 +496,7 @@ public class LuceneSearchRequestProcessor implements SearchRequestProcessor
* parameters exactly match those of the SearchServlet.
* </p>
*
* @author Richard Rodgers
* author: Richard Rodgers
*/
@Override
public void doOpenSearch(Context context, HttpServletRequest request,

1
dspace-jspui/src/main/java/org/dspace/app/webui/util/StyleSelection.java
View File

@@ -32,7 +32,6 @@ public interface StyleSelection
* The configuration has the following syntax: <code>schema.element[.qualifier|.*][(display-option)]</code>
*
* @param style
* @return
*/
public String getConfigurationForStyle(String style);
}

4
dspace-oai/src/main/java/org/dspace/xoai/filter/DSpaceFilter.java
View File

@@ -21,7 +21,7 @@ import com.lyncode.xoai.dataprovider.filter.AbstractFilter;
*/
public abstract class DSpaceFilter extends AbstractFilter
{
private static Logger log = LogManager.getLogger(DSpaceFilter.class);
private static Logger log = LogManager.getLogger(DSpaceFilter.class);
private Context _ctx = null;
public void initialize(Context ctx)
@@ -38,8 +38,6 @@ public abstract class DSpaceFilter extends AbstractFilter
* Returns null if no where given. Or non empty if some where is given.
*
* @param context
* @param item
* @return
*/
public abstract DatabaseFilterResult getWhere(Context context);

5
dspace-sword/src/main/java/org/dspace/sword/ATOMCollectionGenerator.java
View File

@@ -22,7 +22,7 @@ public abstract class ATOMCollectionGenerator
protected SWORDService swordService;
/**
* Create a new ATOM collection generator using the given sword service
* Create a new ATOM collection generator using the given sword service.
*
* @param service
*/
@@ -32,10 +32,9 @@ public abstract class ATOMCollectionGenerator
}
/**
* Build the ATOM Collection which represents the given DSpace Object
* Build the ATOM Collection which represents the given DSpace Object.
*
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public abstract Collection buildCollection(DSpaceObject dso) throws DSpaceSWORDException;

3
dspace-sword/src/main/java/org/dspace/sword/CollectionCollectionGenerator.java
View File

@@ -37,9 +37,8 @@ public class CollectionCollectionGenerator extends ATOMCollectionGenerator
/**
* Build the collection for the given DSpaceObject. In this implementation,
* if the object is not a DSpace COllection, it will throw an exception
* if the object is not a DSpace Collection, it will throw an exception.
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public Collection buildCollection(DSpaceObject dso) throws DSpaceSWORDException

3
dspace-sword/src/main/java/org/dspace/sword/CollectionDepositor.java
View File

@@ -69,10 +69,9 @@ public class CollectionDepositor extends Depositor
}
/**
* Perform a deposit, using the supplied SWORD Deposit object
* Perform a deposit, using the supplied SWORD Deposit object.
*
* @param deposit
* @return
* @throws SWORDErrorException
* @throws DSpaceSWORDException
*/

8
dspace-sword/src/main/java/org/dspace/sword/DSpaceATOMEntry.java
View File

@@ -71,12 +71,12 @@ public abstract class DSpaceATOMEntry
}
/**
* get the sword entry for the given dspace object. In this case, we should be
* responding to requests for the media link, so this method will throw an error
* unless the dspace object is an instance of the Bitstream
* Get the SWORD entry for the given DSpace object. In this case,
* we should be responding to requests for the media link, so this
* method will throw an error unless the DSpace object is an instance
* of the Bitstream.
*
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public SWORDEntry getSWORDEntry(DSpaceObject dso)

3
dspace-sword/src/main/java/org/dspace/sword/Depositor.java
View File

@@ -37,10 +37,9 @@ public abstract class Depositor
}
/**
* Execute the deposit process with the given sword deposit
* Execute the deposit process with the given sword deposit.
*
* @param deposit
* @return
* @throws SWORDErrorException
* @throws DSpaceSWORDException
*/

8
dspace-sword/src/main/java/org/dspace/sword/ItemCollectionGenerator.java
View File

@@ -26,11 +26,11 @@ public class ItemCollectionGenerator extends ATOMCollectionGenerator
}
/**
* Build the collection around the give DSpaceObject. If the object is not an
* instance of a DSpace Item this method will throw an exception
*
* Build the collection around the give DSpaceObject. If the object
* is not an instance of a DSpace Item this method will throw an
* exception.
*
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public Collection buildCollection(DSpaceObject dso) throws DSpaceSWORDException

7
dspace-sword/src/main/java/org/dspace/sword/MediaEntryManager.java
View File

@@ -30,12 +30,11 @@ public class MediaEntryManager
}
/**
* Get the media entry for the given URL request. If the url is unavailable
* this method will throw the appropriate sword errors, with DSpace custom
* URLs
* Get the media entry for the given URL request. If the URL is
* unavailable this method will throw the appropriate SWORD errors,
* with DSpace custom URLs.
*
* @param url
* @return
* @throws DSpaceSWORDException
* @throws SWORDErrorException
*/

22
dspace-sword/src/main/java/org/dspace/sword/SWORDAuthenticator.java
View File

@@ -83,12 +83,11 @@ public class SWORDAuthenticator
}
/**
* Authenticate the given service document request. This extracts the appropriate
* information from the request and forwards to the appropriate authentication
* method
* Authenticate the given service document request. This extracts
* the appropriate information from the request and forwards to the
* appropriate authentication method.
*
* @param request
* @return
* @throws SWORDException
* @throws SWORDErrorException
* @throws SWORDAuthenticationException
@@ -138,11 +137,11 @@ public class SWORDAuthenticator
}
/**
* Authenticate the given atom document request. This extracts the appropriate information
* from the request, and forwards to the appropriate authentication method
* Authenticate the given ATOM document request. This extracts the
* appropriate information from the request, and forwards to the
* appropriate authentication method.
*
* @param request
* @return
* @throws SWORDException
* @throws SWORDErrorException
* @throws SWORDAuthenticationException
@@ -227,7 +226,6 @@ public class SWORDAuthenticator
* Authenticate the deposit request.
*
* @param deposit
* @return
* @throws SWORDException
* @throws SWORDErrorException
* @throws SWORDAuthenticationException
@@ -512,7 +510,6 @@ public class SWORDAuthenticator
* or one of its sub groups?
*
* @param group
* @return
*/
public boolean isUserInGroup(SWORDContext swordContext, Group group)
{
@@ -526,10 +523,9 @@ public class SWORDAuthenticator
/**
* Is the onBehalfOf user a member of the given group or
* one of its sub groups
* one of its sub groups?
*
* @param group
* @return
*/
public boolean isOnBehalfOfInGroup(SWORDContext swordContext, Group group)
{
@@ -948,7 +944,7 @@ public class SWORDAuthenticator
/**
* Can the current SWORD Context permit deposit into the given
* collection in the given DSpace Context
* collection in the given DSpace Context?
*
* IF: the authenticated user is an administrator
* AND:
@@ -963,7 +959,6 @@ public class SWORDAuthenticator
*
* @param swordContext
* @param collection
* @return
* @throws DSpaceSWORDException
*/
public boolean canSubmitTo(SWORDContext swordContext, org.dspace.content.Collection collection)
@@ -1121,7 +1116,6 @@ public class SWORDAuthenticator
*
* @param context
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public boolean canSubmitTo(SWORDContext context, DSpaceObject dso)

46
dspace-sword/src/main/java/org/dspace/sword/SWORDConfiguration.java
View File

@@ -119,9 +119,8 @@ public class SWORDConfiguration
}
/**
* Get the bundle name that sword will store its original deposit packages in, when
* storing them inside an item
* @return
* Get the bundle name that SWORD will store its original deposit
* packages in, when storing them inside an item.
*/
public String getSwordBundle()
{
@@ -129,8 +128,8 @@ public class SWORDConfiguration
}
/**
* Set the bundle name that sword will store its original deposit packages in, when
* storing them inside an item
* Set the bundle name that sword will store its original deposit
* packages in, when storing them inside an item.
* @param swordBundle
*/
public void setSwordBundle(String swordBundle)
@@ -139,8 +138,7 @@ public class SWORDConfiguration
}
/**
* is this a no-op deposit
* @return
* Is this a no-op deposit?
*/
public boolean isNoOp()
{
@@ -148,7 +146,7 @@ public class SWORDConfiguration
}
/**
* set whether this is a no-op deposit
* Set whether this is a no-op deposit.
*
* @param noOp
*/
@@ -158,8 +156,7 @@ public class SWORDConfiguration
}
/**
* is this a verbose deposit
* @return
* Is this a verbose deposit?
*/
public boolean isVerbose()
{
@@ -167,7 +164,7 @@ public class SWORDConfiguration
}
/**
* set whether this is a verbose deposit
* Set whether this is a verbose deposit.
* @param verbose
*/
public void setVerbose(boolean verbose)
@@ -176,8 +173,7 @@ public class SWORDConfiguration
}
/**
* what is the max upload size (in bytes) for the sword interface
* @return
* What is the max upload size (in bytes) for the sword interface?
*/
public int getMaxUploadSize()
{
@@ -194,8 +190,7 @@ public class SWORDConfiguration
}
/**
* does the server support mediated deposit (aka on-behalf-of)
* @return
* Does the server support mediated deposit (aka on-behalf-of)?
*/
public boolean isMediated()
{
@@ -203,7 +198,7 @@ public class SWORDConfiguration
}
/**
* set whether the server supports mediated deposit (aka on-behalf-of)
* Set whether the server supports mediated deposit (aka on-behalf-of).
* @param mediated
*/
public void setMediated(boolean mediated)
@@ -212,8 +207,7 @@ public class SWORDConfiguration
}
/**
* should the repository keep the original package
* @return
* Should the repository keep the original package?
*/
public boolean isKeepOriginal()
{
@@ -221,7 +215,7 @@ public class SWORDConfiguration
}
/**
* set whether the repository should keep copies of the original package
* Set whether the repository should keep copies of the original package.
* @param keepOriginal
*/
public void setKeepOriginal(boolean keepOriginal)
@@ -268,11 +262,10 @@ public class SWORDConfiguration
/**
* Get the list of mime types that the given dspace object will
* accept as packages
* accept as packages.
*
* @param context
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public List<String> getAccepts(Context context, DSpaceObject dso)
@@ -334,7 +327,6 @@ public class SWORDConfiguration
* how much the server "likes" this packaging type
*
* @param col
* @return
*/
public Map<String, Float> getAcceptPackaging(Collection col)
{
@@ -408,11 +400,11 @@ public class SWORDConfiguration
}
/**
* is the given packaging/media type supported by the given dspace object
* Is the given packaging/media type supported by the given DSpace
* object?
*
* @param mediaType
* @param dso
* @return
* @throws DSpaceSWORDException
* @throws SWORDErrorException
*/
@@ -444,11 +436,10 @@ public class SWORDConfiguration
}
/**
* is the given content mimetype acceptable to the given dspace object
* Is the given content MIME type acceptable to the given DSpace object?
* @param context
* @param type
* @param dso
* @return
* @throws DSpaceSWORDException
*/
public boolean isAcceptableContentType(Context context, String type, DSpaceObject dso)
@@ -459,9 +450,8 @@ public class SWORDConfiguration
}
/**
* Get the temp directory for storing files during deposit
* Get the temp directory for storing files during deposit.
*
* @return
* @throws DSpaceSWORDException
*/
public String getTempDir()

8
dspace-sword/src/main/java/org/dspace/sword/SWORDContext.java
View File

@@ -84,9 +84,7 @@ public class SWORDContext
/**
* Returns the most appropriate context for operations on the
* database. This is the on-behalf-of user's context if the
* user exists, or the authenticated user's context otherwise
*
* @return
* user exists, or the authenticated user's context otherwise.
*/
public Context getContext()
{
@@ -106,8 +104,6 @@ public class SWORDContext
* getContext()
*
* on this class instead.
*
* @return
*/
public Context getAuthenticatorContext()
{
@@ -127,8 +123,6 @@ public class SWORDContext
*
* on this class instead. If there is no on-behalf-of user, this
* method will return null.
*
* @return
*/
public Context getOnBehalfOfContext()
{

1
dspace-sword/src/main/java/org/dspace/sword/SWORDIngesterFactory.java
View File

@@ -38,7 +38,6 @@ public class SWORDIngesterFactory
*
* @param context
* @param deposit
* @return
* @throws DSpaceSWORDException
*/
public static SWORDIngester getInstance(Context context, Deposit deposit, DSpaceObject dso)

7
dspace-sword/src/main/java/org/dspace/sword/SWORDService.java
View File

@@ -140,12 +140,11 @@ public class SWORDService
}
/**
* Construct the most appropriate filename for the incoming deposit
* Construct the most appropriate filename for the incoming deposit.
*
* @param context
* @param deposit
* @param original
* @return
* @throws DSpaceSWORDException
*/
public String getFilename(Context context, Deposit deposit, boolean original)
@@ -184,9 +183,7 @@ public class SWORDService
}
/**
* Get the name of the temp files that should be used
*
* @return
* Get the name of the temp files that should be used.
*/
public String getTempFilename()
{

45
dspace-sword/src/main/java/org/dspace/sword/SWORDUrlManager.java
View File

@@ -43,10 +43,8 @@ public class SWORDUrlManager
}
/**
* Get the generator url for atom entry documents. This can be
* overridden from the default in configuration
*
* @return
* Get the generator URL for ATOM entry documents. This can be
* overridden from the default in configuration.
*/
public String getGeneratorUrl()
{
@@ -198,11 +196,11 @@ public class SWORDUrlManager
}
/**
* Construct the service document url for the given object, which will
* be supplied in the sword:service element of other service document entries
* Construct the service document URL for the given object, which will
* be supplied in the sword:service element of other service document
* entries.
*
* @param community
* @return
* @throws DSpaceSWORDException
*/
public String constructSubServiceUrl(Community community)
@@ -214,11 +212,11 @@ public class SWORDUrlManager
}
/**
* Construct the service document url for the given object, which will
* be supplied in the sword:service element of other service document entries
* Construct the service document URL for the given object, which will
* be supplied in the sword:service element of other service document
* entries.
*
* @param collection
* @return
* @throws DSpaceSWORDException
*/
public String constructSubServiceUrl(Collection collection)
@@ -230,11 +228,10 @@ public class SWORDUrlManager
}
/**
* Extract a DSpaceObject from the given url. If this method is unable to
* locate a meaningful and appropriate dspace object it will throw the
* appropriate sword error
* Extract a DSpaceObject from the given URL. If this method is unable to
* locate a meaningful and appropriate DSpace object it will throw the
* appropriate SWORD error.
* @param url
* @return
* @throws DSpaceSWORDException
* @throws SWORDErrorException
*/
@@ -303,9 +300,8 @@ public class SWORDUrlManager
}
/**
* get the base url for service document requests
* Get the base URL for service document requests.
*
* @return
* @throws DSpaceSWORDException
*/
public String getBaseServiceDocumentUrl()
@@ -383,10 +379,9 @@ public class SWORDUrlManager
}
/**
* is the given url the base service document url
* Is the given URL the base service document URL?
*
* @param url
* @return
* @throws DSpaceSWORDException
*/
public boolean isBaseServiceDocumentUrl(String url)
@@ -396,10 +391,9 @@ public class SWORDUrlManager
}
/**
* is the given url the base media link url
* Is the given URL the base media link URL?
*
* @param url
* @return
* @throws DSpaceSWORDException
*/
public boolean isBaseMediaLinkUrl(String url)
@@ -409,11 +403,10 @@ public class SWORDUrlManager
}
/**
* Central location for constructing usable urls for dspace bitstreams. There
* is no place in the main DSpace code base for doing this.
* Central location for constructing usable URLs for DSpace bitstreams.
* There is no place in the main DSpace code base for doing this.
*
* @param bitstream
* @return
* @throws DSpaceSWORDException
*/
public String getBitstreamUrl(Bitstream bitstream)
@@ -464,9 +457,8 @@ public class SWORDUrlManager
}
/**
* get the base media link url
* Get the base media link url.
*
* @return
* @throws DSpaceSWORDException
*/
public String getBaseMediaLinkUrl()
@@ -518,10 +510,9 @@ public class SWORDUrlManager
}
/**
* get the media link url for the given bitstream
* Get the media link URL for the given bitstream.
*
* @param bitstream
* @return
* @throws DSpaceSWORDException
*/
public String getMediaLink(Bitstream bitstream)

19
dspace-sword/src/main/java/org/dspace/sword/SimpleFileIngester.java
View File

@@ -32,16 +32,15 @@ public class SimpleFileIngester implements SWORDIngester
{
/**
* perform the ingest using the given deposit object onto the specified
* target dspace object, using the sword service implementation
*
* @param service
* @param deposit
* @param target
* @return
* @throws DSpaceSWORDException
* @throws SWORDErrorException
*/
* Perform the ingest using the given deposit object onto the specified
* target DSpace object, using the SWORD service implementation.
*
* @param service
* @param deposit
* @param target
* @throws DSpaceSWORDException
* @throws SWORDErrorException
*/
public DepositResult ingest(SWORDService service, Deposit deposit, DSpaceObject target)
throws DSpaceSWORDException, SWORDErrorException
{

1
dspace-sword/src/main/java/org/purl/sword/atom/Content.java
View File

@@ -245,7 +245,6 @@ public class Content extends XmlElement implements SwordElementInterface
*
* @param elements
* @param attributes
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> elements,
List<SwordValidationInfo> attributes,

2
dspace-sword/src/main/java/org/purl/sword/atom/Entry.java
View File

@@ -567,7 +567,6 @@ public class Entry extends XmlElement implements SwordElementInterface
/**
*
* @return
*/
public SwordValidationInfo validate(Properties validationContext)
{
@@ -578,7 +577,6 @@ public class Entry extends XmlElement implements SwordElementInterface
*
* @param info
* @param validationContext
* @return
*/
protected SwordValidationInfo validate(SwordValidationInfo info,
Properties validationContext)

4
dspace-sword/src/main/java/org/purl/sword/atom/Generator.java
View File

@@ -214,7 +214,6 @@ public class Generator extends XmlElement implements SwordElementInterface
/**
*
* @return
*/
public SwordValidationInfo validate(Properties validationContext)
{
@@ -225,7 +224,6 @@ public class Generator extends XmlElement implements SwordElementInterface
*
* @param existing
* @param attributeItems
* @return
*/
public SwordValidationInfo validate(List<SwordValidationInfo> existing,
List<SwordValidationInfo> attributeItems,
@@ -347,4 +345,4 @@ public class Generator extends XmlElement implements SwordElementInterface
" uri: " + getUri();
}
}
}

1
dspace-sword/src/main/java/org/purl/sword/atom/Source.java
View File

@@ -96,7 +96,6 @@ public class Source extends XmlElement implements SwordElementInterface
*
* @param source
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public SwordValidationInfo unmarshall(Element source, Properties validationProperties)

2
dspace-sword/src/main/java/org/purl/sword/atom/TextConstruct.java
View File

@@ -149,7 +149,6 @@ implements SwordElementInterface
*
* @param text
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public SwordValidationInfo unmarshall(Element text, Properties validationProperties)
@@ -250,7 +249,6 @@ implements SwordElementInterface
*
* @param existing
* @param attributeItems
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
List<SwordValidationInfo> attributeItems,

1
dspace-sword/src/main/java/org/purl/sword/base/BasicContentElement.java
View File

@@ -142,7 +142,6 @@ implements SwordElementInterface
*
* @param existing
* @param attributeItems
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
List<SwordValidationInfo> attributeItems,

3
dspace-sword/src/main/java/org/purl/sword/base/Collection.java
View File

@@ -165,7 +165,6 @@ public class Collection extends XmlElement implements SwordElementInterface
/**
*
* @return
*/
public List<Accept> getAcceptList()
{
@@ -670,7 +669,6 @@ public class Collection extends XmlElement implements SwordElementInterface
/**
*
* @return
*/
@Override
public SwordValidationInfo validate(Properties validationContext)
@@ -681,7 +679,6 @@ public class Collection extends XmlElement implements SwordElementInterface
/**
*
* @param existing
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
List<SwordValidationInfo> attributes,

3
dspace-sword/src/main/java/org/purl/sword/base/SWORDEntry.java
View File

@@ -399,7 +399,6 @@ public class SWORDEntry extends Entry
/**
*
* @param elementName
* @return
*/
protected boolean isElementChecked(XmlName elementName)
{
@@ -519,4 +518,4 @@ public class SWORDEntry extends Entry
{
unmarshall(entry, null);
}
}
}

8
dspace-sword/src/main/java/org/purl/sword/base/SWORDErrorDocument.java
View File

@@ -58,8 +58,6 @@ public class SWORDErrorDocument extends SWORDEntry
/**
* Get the element name.
*
* @return
*/
public static XmlName elementName()
{
@@ -102,7 +100,6 @@ public class SWORDErrorDocument extends SWORDEntry
*
* @param entry
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public SwordValidationInfo unmarshall(Element entry, Properties validationProperties)
@@ -156,7 +153,7 @@ public class SWORDErrorDocument extends SWORDEntry
/**
*
* @return
* @param validationContext
*/
public SwordValidationInfo validate(Properties validationContext)
{
@@ -167,7 +164,6 @@ public class SWORDErrorDocument extends SWORDEntry
*
* @param info
* @param validationContext
* @return
*/
protected SwordValidationInfo validate(SwordValidationInfo info,
Properties validationContext)
@@ -252,4 +248,4 @@ public class SWORDErrorDocument extends SWORDEntry
System.out.println(sed.marshall().toXML());
}
*/
}
}

4
dspace-sword/src/main/java/org/purl/sword/base/Service.java
View File

@@ -372,7 +372,6 @@ public class Service extends XmlElement implements SwordElementInterface
*
* @param service
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public final SwordValidationInfo unmarshall( Element service, Properties validationProperties)
@@ -526,7 +525,6 @@ public class Service extends XmlElement implements SwordElementInterface
/**
*
* @param existing
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
Properties validationContext)
@@ -599,4 +597,4 @@ public class Service extends XmlElement implements SwordElementInterface
result.addUnmarshallValidationInfo(existing, null);
return result;
}
}
}

2
dspace-sword/src/main/java/org/purl/sword/base/ServiceDocument.java
View File

@@ -132,7 +132,6 @@ public class ServiceDocument {
*
* @param xml
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public SwordValidationInfo unmarshall(String xml, Properties validationProperties)
@@ -170,7 +169,6 @@ public class ServiceDocument {
*
* @param element
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public SwordValidationInfo unmarshall(Element element, Properties validationProperties)

1
dspace-sword/src/main/java/org/purl/sword/base/SwordAcceptPackaging.java
View File

@@ -214,7 +214,6 @@ implements SwordElementInterface
*
* @param existing
* @param attributeItems
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
List<SwordValidationInfo> attributeItems,

1
dspace-sword/src/main/java/org/purl/sword/base/SwordContentPackageTypes.java
View File

@@ -69,7 +69,6 @@ public class SwordContentPackageTypes {
/**
*
* @return
*/
public Enumeration elements()
{

3
dspace-sword/src/main/java/org/purl/sword/base/SwordValidationInfo.java
View File

@@ -312,7 +312,6 @@ public class SwordValidationInfo {
/**
*
* @return
*/
public Iterator<SwordValidationInfo> getValidationAttributeInfoIterator()
{
@@ -321,7 +320,6 @@ public class SwordValidationInfo {
/**
*
* @return
*/
public Iterator<SwordValidationInfo> getUnmarshallElementInfoIterator()
{
@@ -330,7 +328,6 @@ public class SwordValidationInfo {
/**
*
* @return
*/
public Iterator<SwordValidationInfo> getUnmarshallAttributeInfoIterator()
{

2
dspace-sword/src/main/java/org/purl/sword/base/Workspace.java
View File

@@ -188,7 +188,6 @@ public class Workspace extends XmlElement implements SwordElementInterface
*
* @param workspace
* @param validationProperties
* @return
* @throws org.purl.sword.base.UnmarshallException
*/
public SwordValidationInfo unmarshall( Element workspace, Properties validationProperties )
@@ -273,7 +272,6 @@ public class Workspace extends XmlElement implements SwordElementInterface
/**
*
* @param existing
* @return
*/
protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
Properties validationContext)

3
dspace-sword/src/main/java/org/purl/sword/base/XmlElement.java
View File

@@ -246,7 +246,6 @@ public abstract class XmlElement
*
* @param element
* @param xmlName
* @return
*/
protected boolean isInstanceOf(Element element, XmlName xmlName)
{
@@ -374,4 +373,4 @@ public abstract class XmlElement
}
}
}

1
dspace-sword/src/main/java/org/purl/sword/client/Client.java
View File

@@ -304,7 +304,6 @@ public class Client implements SWORDClient {
/**
*
* @return
*/
public SwordValidationInfo getLastUnmarshallInfo()
{

14
dspace-sword/src/main/java/org/purl/sword/client/CmdClient.java
View File

@@ -303,14 +303,14 @@ public class CmdClient implements ClientType
}
/**
* Process the post response. The message contains the list of arguments
* for the post. The method will then print out the details of the
* response.
* Process the post response. The message contains the list of arguments
* for the post. The method will then print out the details of the
* response.
*
* @param message The post options.
*
* @parma message The post options.
*
* @exception SWORDClientException if there is an error accessing the
* post response.
* @exception SWORDClientException if there is an error accessing the
* post response.
*/
protected void processPost(PostMessage message)
throws SWORDClientException

4
dspace-sword/src/main/java/org/purl/sword/client/PostMessage.java
View File

@@ -280,7 +280,7 @@ public class PostMessage
/**
* Set the packaging format.
*
* @param formatNamespace The packaging format.
* @param packaging The packaging format.
*/
public void setFormatNamespace(String packaging)
{
@@ -320,7 +320,7 @@ public class PostMessage
/**
* Set the state of the corrupt request flag.
*
* @param checksumError True if the item should corrupt the POST header.
* @param corruptRequest True if the item should corrupt the POST header.
*/
public void setCorruptRequest(boolean corruptRequest)
{

2
dspace-sword/src/main/java/org/purl/sword/client/PropertiesDialog.java
View File

@@ -217,7 +217,7 @@ public class PropertiesDialog
* @param row The cell row.
* @param col The cell column.
*
* @param True if the cell can be edited. Otherwise, false.
* @return True if the cell can be edited. Otherwise, false.
*/
public boolean isCellEditable(int row, int col)
{

5
dspace-swordv2/src/main/java/org/dspace/sword2/AbstractSwordContentIngester.java
View File

@@ -124,16 +124,15 @@ public abstract class AbstractSwordContentIngester implements SwordContentIngest
}
/**
* utility method to turn given metadata fields of the form
* Utility method to turn given metadata fields of the form
* schema.element.qualifier into DCValue objects which can be
* used to access metadata in items.
*
* The def parameter should be null, * or "" depending on how
* you intend to use the DCValue object
* you intend to use the DCValue object.
*
* @param config
* @param def
* @return
*/
protected DCValue configToDC(String config, String def)
{

3
dspace-swordv2/src/main/java/org/dspace/sword2/AtomCollectionGenerator.java
View File

@@ -20,10 +20,9 @@ import org.swordapp.server.SwordCollection;
public interface AtomCollectionGenerator
{
/**
* Build the ATOM Collection which represents the given DSpace Object
* Build the ATOM Collection which represents the given DSpace Object.
*
* @param dso
* @return
* @throws DSpaceSwordException
*/
public SwordCollection buildCollection(Context context, DSpaceObject dso, SwordConfigurationDSpace config) throws DSpaceSwordException;

6
dspace-swordv2/src/main/java/org/dspace/sword2/CollectionCollectionGenerator.java
View File

@@ -28,10 +28,10 @@ public class CollectionCollectionGenerator implements AtomCollectionGenerator
private static Logger log = Logger.getLogger(CommunityCollectionGenerator.class);
/**
* Build the collection for the given DSpaceObject. In this implementation,
* if the object is not a DSpace COllection, it will throw an exception
* Build the collection for the given DSpaceObject. In this
* implementation, if the object is not a DSpace Collection, it will
* throw an exception.
* @param dso
* @return
* @throws DSpaceSwordException
*/
public SwordCollection buildCollection(Context context, DSpaceObject dso, SwordConfigurationDSpace swordConfig)

3
dspace-swordv2/src/main/java/org/dspace/sword2/DSpaceSwordAPI.java
View File

@@ -369,12 +369,11 @@ public class DSpaceSwordAPI
}
/**
* Construct the most appropriate filename for the incoming deposit
* Construct the most appropriate filename for the incoming deposit.
*
* @param context
* @param deposit
* @param original
* @return
* @throws DSpaceSwordException
*/
public String createFilename(Context context, Deposit deposit, boolean original)

21
dspace-swordv2/src/main/java/org/dspace/sword2/SwordAuthenticator.java
View File

@@ -86,12 +86,11 @@ public class SwordAuthenticator
}
/**
* Authenticate the given service document request. This extracts the appropriate
* information from the request and forwards to the appropriate authentication
* method
* Authenticate the given service document request. This extracts the
* appropriate information from the request and forwards to the
* appropriate authentication method.
*
* @param auth
* @return
* @throws DSpaceSwordException
* @throws SwordError
* @throws SwordAuthException
@@ -470,7 +469,6 @@ public class SwordAuthenticator
* or one of its sub groups?
*
* @param group
* @return
*/
public boolean isUserInGroup(SwordContext swordContext, Group group)
{
@@ -484,10 +482,9 @@ public class SwordAuthenticator
/**
* Is the onBehalfOf user a member of the given group or
* one of its sub groups
* one of its sub groups?
*
* @param group
* @return
*/
public boolean isOnBehalfOfInGroup(SwordContext swordContext, Group group)
{
@@ -920,7 +917,7 @@ public class SwordAuthenticator
/**
* Can the current SWORD Context permit deposit into the given
* collection in the given DSpace Context
* collection in the given DSpace Context?
*
* IF: the authenticated user is an administrator
* AND:
@@ -935,7 +932,6 @@ public class SwordAuthenticator
*
* @param swordContext
* @param collection
* @return
* @throws DSpaceSwordException
*/
public boolean canSubmitTo(SwordContext swordContext, org.dspace.content.Collection collection)
@@ -1100,14 +1096,13 @@ public class SwordAuthenticator
}
/**
* Can the given context submit to the specified dspace object.
* Can the given context submit to the specified DSpace object?
*
* This forwards to the individual methods for different object types; see
* their documentation for details of the conditions.
* This forwards to the individual methods for different object types;
* see their documentation for details of the conditions.
*
* @param context
* @param dso
* @return
* @throws DSpaceSwordException
*/
public boolean canSubmitTo(SwordContext context, DSpaceObject dso)

38
dspace-swordv2/src/main/java/org/dspace/sword2/SwordConfigurationDSpace.java
View File

@@ -253,9 +253,8 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* Get the bundle name that sword will store its original deposit packages in, when
* storing them inside an item
* @return
* Get the bundle name that SWORD will store its original deposit
* packages in, when storing them inside an item.
*/
public String getSwordBundle()
{
@@ -273,8 +272,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* is this a verbose deposit
* @return
* Is this a verbose deposit?
*/
public boolean isVerbose()
{
@@ -282,7 +280,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* set whether this is a verbose deposit
* Set whether this is a verbose deposit.
* @param verbose
*/
public void setVerbose(boolean verbose)
@@ -291,8 +289,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* what is the max upload size (in bytes) for the sword interface
* @return
* What is the max upload size (in bytes) for the SWORD interface?
*/
public int getMaxUploadSize()
{
@@ -300,7 +297,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* set the max uplaod size (in bytes) for the sword interface
* Set the max uplaod size (in bytes) for the SWORD interface.
* @param maxUploadSize
*/
public void setMaxUploadSize(int maxUploadSize)
@@ -309,8 +306,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* does the server support mediated deposit (aka on-behalf-of)
* @return
* Does the server support mediated deposit (aka on-behalf-of)?
*/
public boolean isMediated()
{
@@ -318,7 +314,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* set whether the server supports mediated deposit (aka on-behalf-of)
* Set whether the server supports mediated deposit (aka on-behalf-of).
* @param mediated
*/
public void setMediated(boolean mediated)
@@ -327,8 +323,7 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* should the repository keep the original package
* @return
* Should the repository keep the original package?
*/
public boolean isKeepOriginal()
{
@@ -382,12 +377,11 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* Get the list of mime types that the given dspace object will
* accept as packages
* Get the list of MIME types that the given DSpace object will
* accept as packages.
*
* @param context
* @param dso
* @return
* @throws DSpaceSwordException
*/
public List<String> getAccepts(Context context, DSpaceObject dso)
@@ -455,10 +449,9 @@ public class SwordConfigurationDSpace implements SwordConfiguration
* http://purl.org/net/sword-types/METSDSpaceSIP
*
* and the Q value is a floating point between 0 and 1 which defines
* how much the server "likes" this packaging type
* how much the server "likes" this packaging type.
*
* @param col
* @return
*/
public List<String> getAcceptPackaging(Collection col)
{
@@ -548,11 +541,11 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* is the given packaging/media type supported by the given dspace object
* Is the given packaging/media type supported by the given DSpace
* object?
*
* @param packageFormat
* @param dso
* @return
* @throws DSpaceSwordException
* @throws SwordError
*/
@@ -591,11 +584,10 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* is the given content mimetype acceptable to the given dspace object
* Is the given content MIME type acceptable to the given DSpace object.
* @param context
* @param type
* @param dso
* @return
* @throws DSpaceSwordException
*/
public boolean isAcceptableContentType(Context context, String type, DSpaceObject dso)

8
dspace-swordv2/src/main/java/org/dspace/sword2/SwordContext.java
View File

@@ -84,9 +84,7 @@ public class SwordContext
/**
* Returns the most appropriate context for operations on the
* database. This is the on-behalf-of user's context if the
* user exists, or the authenticated user's context otherwise
*
* @return
* user exists, or the authenticated user's context otherwise.
*/
public Context getContext()
{
@@ -106,8 +104,6 @@ public class SwordContext
* getContext()
*
* on this class instead.
*
* @return
*/
public Context getAuthenticatorContext()
{
@@ -127,8 +123,6 @@ public class SwordContext
*
* on this class instead. If there is no on-behalf-of user, this
* method will return null.
*
* @return
*/
public Context getOnBehalfOfContext()
{

3
dspace-swordv2/src/main/java/org/dspace/sword2/SwordIngesterFactory.java
View File

@@ -32,12 +32,11 @@ public class SwordIngesterFactory
* of the interface to return.
*
* To configure how this method will respond, configure the package ingester
* for the appropriate media types and defaults. See the sword configuration
* for the appropriate media types and defaults. See the SWORD configuration
* documentation for more details.
*
* @param context
* @param deposit
* @return
* @throws DSpaceSwordException
*/
public static SwordContentIngester getContentInstance(Context context, Deposit deposit, DSpaceObject dso)

35
dspace-swordv2/src/main/java/org/dspace/sword2/SwordUrlManager.java
View File

@@ -218,11 +218,11 @@ public class SwordUrlManager
}
/**
* Construct the service document url for the given object, which will
* be supplied in the sword:service element of other service document entries
* Construct the service document URL for the given object, which will
* be supplied in the sword:service element of other service document
* entries.
*
* @param community
* @return
* @throws DSpaceSwordException
*/
public String constructSubServiceUrl(Community community)
@@ -234,11 +234,11 @@ public class SwordUrlManager
}
/**
* Construct the service document url for the given object, which will
* be supplied in the sword:service element of other service document entries
* Construct the service document URL for the given object, which will
* be supplied in the sword:service element of other service document
* entries.
*
* @param collection
* @return
* @throws DSpaceSwordException
*/
public String constructSubServiceUrl(Collection collection)
@@ -250,11 +250,10 @@ public class SwordUrlManager
}
/**
* Extract a DSpaceObject from the given url. If this method is unable to
* locate a meaningful and appropriate dspace object it will throw the
* appropriate sword error
* Extract a DSpaceObject from the given URL. If this method is unable to
* locate a meaningful and appropriate DSpace object it will throw the
* appropriate SWORD error.
* @param url
* @return
* @throws DSpaceSwordException
* @throws SwordError
*/
@@ -305,9 +304,8 @@ public class SwordUrlManager
}
/**
* get the base url for service document requests
* Get the base URL for service document requests.
*
* @return
* @throws DSpaceSwordException
*/
public String getBaseServiceDocumentUrl()
@@ -383,10 +381,9 @@ public class SwordUrlManager
}
/**
* is the given url the base service document url
* Is the given URL the base service document URL?
*
* @param url
* @return
* @throws DSpaceSwordException
*/
public boolean isBaseServiceDocumentUrl(String url)
@@ -396,11 +393,10 @@ public class SwordUrlManager
}
/**
* Central location for constructing usable urls for dspace bitstreams. There
* is no place in the main DSpace code base for doing this.
* Central location for constructing usable URLs for DSpace bitstreams.
* There is no place in the main DSpace code base for doing this.
*
* @param bitstream
* @return
* @throws DSpaceSwordException
*/
public String getBitstreamUrl(Bitstream bitstream)
@@ -491,10 +487,9 @@ public class SwordUrlManager
}
/**
* get the media link url for the given bitstream
*
* Get the media link URL for the given bitstream.
*
* @param bitstream
* @return
* @throws DSpaceSwordException
*/
public String getMediaLink(Bitstream bitstream)

18
dspace-swordv2/src/main/java/org/dspace/sword2/WorkflowTools.java
View File

@@ -27,14 +27,13 @@ import java.sql.SQLException;
public class WorkflowTools
{
/**
* Is the given item in the DSpace workflow
* Is the given item in the DSpace workflow?
*
* This method queries the database directly to determine if this is the
* case rather than using the DSpace API (which is very slow)
* case rather than using the DSpace API (which is very slow).
*
* @param context
* @param item
* @return
* @throws DSpaceSwordException
*/
public boolean isItemInWorkflow(Context context, Item item)
@@ -58,11 +57,10 @@ public class WorkflowTools
* Is the given item in a DSpace workspace?
*
* This method queries the database directly to determine if this is the
* case rather than using the DSpace API (which is very slow)
* case rather than using the DSpace API (which is very slow).
*
* @param context
* @param item
* @return
* @throws DSpaceSwordException
*/
public boolean isItemInWorkspace(Context context, Item item)
@@ -79,14 +77,13 @@ public class WorkflowTools
}
/**
* Obtain the WorkflowItem object which wraps the given Item
* Obtain the WorkflowItem object which wraps the given Item.
*
* This method queries the database directly to determine if this is the
* case rather than using the DSpace API (which is very slow)
* case rather than using the DSpace API (which is very slow).
*
* @param context
* @param item
* @return
* @throws DSpaceSwordException
*/
public InProgressSubmission getWorkflowItem(Context context, Item item)
@@ -107,14 +104,13 @@ public class WorkflowTools
}
/**
* Obtain the WorkspaceItem object which wraps the given Item
* Obtain the WorkspaceItem object which wraps the given Item.
*
* This method queries the database directly to determine if this is the
* case rather than using the DSpace API (which is very slow)
* case rather than using the DSpace API (which is very slow).
*
* @param context
* @param item
* @return
* @throws DSpaceSwordException
*/
public WorkspaceItem getWorkspaceItem(Context context, Item item)

Some files were not shown because too many files have changed in this diff Show More