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

DS-3154 fix javadoc

Browse Source
This commit is contained in:
Ivan Masár
2016-08-04 10:36:39 +02:00
parent 3c7d44caa1
commit 9b94002426
50 changed files with 169 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportServiceImpl.java
View File

@@ -1721,7 +1721,7 @@ public class ItemImportServiceImpl implements ItemImportService, InitializingBea
/**
* Generate a random filename based on current time
* @param hidden: add . as a prefix to make the file hidden
* @param hidden set to add . as a prefix to make the file hidden
* @return the filename
*/
protected String generateRandomFilename(boolean hidden)

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

@@ -33,7 +33,7 @@ class, defined in this package, to select an event processing implementation.
</p>
<p>
Three "stock" implementations are provided.
Several "stock" implementations are provided.
</p>
<dl>
<dt>{@link org.dspace.usage.PassiveUsageEventListener PassiveUsageEventListener}</dt>
@@ -42,9 +42,12 @@ Three "stock" implementations are provided.
if no plugin is configured.</dd>
<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
testing.</dd>
<dt>{@link org.dspace.usage.LoggerUsageEventListener LoggerUsageEventListener}</dt>
<dd>writes event records to the Java logger.</dd>
<dt>{@link org.dspace.statistics.SolrLoggerUsageEventListener SolrLoggerUsageEventListener}</dt>
<dd>writes event records to Solr.</dd>
<dt>{@link org.dspace.google.GoogleRecorderEventListener GoogleRecorderEventListener}<.dt>
<dd>writes event records to Google Analytics.</dd>
</dl>
</body>
</html>

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

@@ -229,7 +229,7 @@ public class GoogleMetadata
* first-encountered instance of the field for this Item.
*
* @param fieldName
* @return
* @return successful?
*/
protected boolean addSingleField(String fieldName)
{
@@ -445,7 +445,7 @@ public class GoogleMetadata
* configuration.
*
* @param configFilter
* @return
* @return array of parsed options or null
*/
protected ArrayList<ArrayList<String>> parseOptions(String configFilter)
{
@@ -1046,7 +1046,7 @@ public class GoogleMetadata
* </ul>
* Additionally, this bitstream must be publicly viewable.
* @param item
* @return
* @return a linkable bitstream or null if none found
* @throws SQLException if database error
*/
protected Bitstream findLinkableFulltext(Item item) throws SQLException {
@@ -1201,7 +1201,7 @@ public class GoogleMetadata
* metadata practice.
*
* @param dConfig
* @return
* @return item matches configuration
*/
protected boolean identifyItemType(String dConfig)
{

6
dspace-api/src/main/java/org/dspace/authority/AuthorityValue.java
View File

@@ -242,9 +242,9 @@ public class AuthorityValue {
}
/**
* Provides a string that will be allow a this AuthorityType to be recognized and provides information to create a new instance to be created using public AuthorityValue newInstance(String info).
* See the implementation of com.atmire.org.dspace.authority.AuthorityValueGenerator#generateRaw(java.lang.String, java.lang.String) for more precisions.
* @return
* Provides a string that will allow this AuthorityType to be recognized and provides information to create a new instance to be created using public AuthorityValue newInstance(String info).
* See the implementation of {@link com.atmire.org.dspace.authority.AuthorityValueGenerator#generateRaw(java.lang.String, java.lang.String) AuthorityValueGenerator#generateRaw(java.lang.String, java.lang.String)} for more details.
* @return see {@link org.dspace.authority.service.AuthorityValueService#GENERATE AuthorityValueService.GENERATE}
*/
public String generateString() {
return AuthorityValueServiceImpl.GENERATE;

8
dspace-api/src/main/java/org/dspace/authorize/ResourcePolicy.java
View File

@@ -42,9 +42,15 @@ public class ResourcePolicy implements ReloadableEntity<Integer> {
@JoinColumn(name = "dspace_object")
private DSpaceObject dSpaceObject;
/*
* {@see org.dspace.core.Constants#Constants Constants}
*/
@Column(name = "resource_type_id")
private int resourceTypeId;
/*
* {@see org.dspace.core.Constants#Constants Constants}
*/
@Column(name="action_id")
private int actionId;
@@ -293,4 +299,4 @@ public class ResourcePolicy implements ReloadableEntity<Integer> {
public void setRpDescription(String description){
this.rpdescription = description;
}
}
}

30
dspace-api/src/main/java/org/dspace/authorize/service/AuthorizeService.java
View File

@@ -107,7 +107,7 @@ public interface AuthorizeService {
* @param o DSpaceObject
* @param a action being attempted, from
* <code>org.dspace.core.Constants</code>
* @return <code>true</code> if the current user in the context is
* @return {@code true} if the current user in the context is
* authorized to perform the given action on the given object
* @throws SQLException if database error
*/
@@ -124,7 +124,7 @@ public interface AuthorizeService {
* @param useInheritance
* flag to say if ADMIN action on the current object or parent
* object can be used
* @return <code>true</code> if the current user in the context is
* @return {@code true} if the current user in the context is
* authorized to perform the given action on the given object
* @throws SQLException if database error
*/
@@ -142,7 +142,7 @@ public interface AuthorizeService {
* @param useInheritance
* flag to say if ADMIN action on the current object or parent
* object can be used
* @return <code>true</code> if the requested user is
* @return {@code true} if the requested user is
* authorized to perform the given action on the given object
* @throws SQLException if database error
*/
@@ -154,14 +154,14 @@ public interface AuthorizeService {
/**
* Check to see if the current user is an Administrator of a given object
* within DSpace. Always return <code>true</code> if the user is a System
* within DSpace. Always return {@code true} if the user is a System
* Admin
*
* @param c current context
* @param o current DSpace Object, if <code>null</code> the call will be
* equivalent to a call to the <code>isAdmin(Context c)</code>
* method
* @return <code>true</code> if user has administrative privileges on the
* @return {@code true} if user has administrative privileges on the
* given DSpace object
* @throws SQLException if database error
*/
@@ -170,11 +170,11 @@ public interface AuthorizeService {
/**
* Check to see if the current user is a System Admin. Always return
* <code>true</code> if c.ignoreAuthorization is set. Anonymous users
* {@code true} if c.ignoreAuthorization is set. Anonymous users
* can't be Admins (EPerson set to NULL)
*
* @param c current context
* @return <code>true</code> if user is an admin or ignore authorization
* @return {@code true} if user is an admin or ignore authorization
* flag set
* @throws SQLException if database error
*/
@@ -240,7 +240,7 @@ public interface AuthorizeService {
*
* @param c current context
* @param o object to retrieve policies for
* @return List of <code>ResourcePolicy</code> objects
* @return List of {@code ResourcePolicy} objects
* @throws SQLException if database error
*/
public List<ResourcePolicy> getPolicies(Context c, DSpaceObject o) throws SQLException;
@@ -251,7 +251,7 @@ public interface AuthorizeService {
* @param c current context
* @param o object to retrieve policies for
* @param type type
* @return List of <code>ResourcePolicy</code> objects
* @return List of {@code ResourcePolicy} objects
* @throws SQLException if database error
*/
public List<ResourcePolicy> findPoliciesByDSOAndType(Context c, DSpaceObject o, String type) throws SQLException;
@@ -261,8 +261,8 @@ public interface AuthorizeService {
*
* @param c current context
* @param g group to retrieve policies for
* @return List of <code>ResourcePolicy</code> objects
* @@throws SQLException if database error
* @return List of {@code ResourcePolicy} objects
* @throws SQLException if database error
*/
public List<ResourcePolicy> getPoliciesForGroup(Context c, Group g) throws SQLException;
@@ -338,7 +338,7 @@ public interface AuthorizeService {
* @param context current context
* @param dso object to remove policies from
* @param actionID ID of action to match from
* <code>org.dspace.core.Constants</code>, or -1=all
* {@link org.dspace.core.Constants#Constants Constants}, or -1=all
* @throws SQLException if there's a database problem
* @throws AuthorizeException if authorization error
*/
@@ -384,8 +384,8 @@ public interface AuthorizeService {
*
* @param c current context
* @param o object
* @param actionID ID of action from <code>org.dspace.core.Constants</code>
* @return array of <code>Group</code>s that can perform the specified
* @param actionID ID of action from {@link org.dspace.core.Constants#Constants Constants}
* @return array of {@link org.dspace.eperson.Group#Group Groups} that can perform the specified
* action on the specified object
* @throws SQLException if there's a database problem
*/
@@ -400,7 +400,7 @@ public interface AuthorizeService {
* @param c current context
* @param o object
* @param group group
* @param actionID ID of action from <code>org.dspace.core.Constants</code>
* @param actionID ID of action from {@link org.dspace.core.Constants#Constants Constants}
* @param policyID ID of an existing policy. If -1 is specified, this parameter will be ignored
* @return true if such a policy exists, false otherwise
* @throws SQLException if there's a database problem

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

@@ -37,7 +37,7 @@
<p>Dispatchers that generate bitstream ordering: -
<ul>
<li>{@link org.dspace.checker.ListDispatcher}</li>
<li>{@link org.dspace.checker.IteratorDispatcher}</li>
<li>{@link org.dspace.checker.SimpleDispatcher}</li>
</ul>
</p>

12
dspace-api/src/main/java/org/dspace/content/DSpaceObjectServiceImpl.java
View File

@@ -363,11 +363,17 @@ public abstract class DSpaceObjectServiceImpl<T extends DSpaceObject> implements
/**
* Retrieve first metadata field value
* @param dso
* @param language
* @param element
* The DSpaceObject which we ask for metadata.
* @param schema
* the schema for the metadata field. <em>Must</em> match
* the <code>name</code> of an existing metadata schema.
* @param element
* the element to match, or <code>Item.ANY</code>
* @param qualifier
* @return
* the qualifier to match, or <code>Item.ANY</code>
* @param language
* the language to match, or <code>Item.ANY</code>
* @return the first metadata field value
*/
@Override
public String getMetadataFirstValue(T dso, String schema, String element, String qualifier, String language){

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

@@ -225,7 +225,7 @@ public class ItemComparator implements Comparator, Serializable
/**
* Normalize the title of a Metadatum.
* @param value
* @return
* @return normalized title
*/
protected String normalizeTitle(MetadataValue value)
{

4
dspace-api/src/main/java/org/dspace/content/packager/METSManifest.java
View File

@@ -1194,9 +1194,9 @@ public class METSManifest
}
/**
* Get an aray of all AMDID values for this object
* Get an array of all AMDID values for this object
*
* @return
* @return array of all AMDID values for this object
* @throws MetadataValidationException if metadata validation error
*/
protected String[] getAmdIDs()

4
dspace-api/src/main/java/org/dspace/content/service/ItemService.java
View File

@@ -95,11 +95,11 @@ public interface ItemService extends DSpaceObjectService<Item>, DSpaceObjectLega
throws SQLException;
/**
* Retrieve the list of Items submitted by eperson, ordered by recently submitted, optionally limitable
* Retrieve the list of items submitted by eperson, ordered by recently submitted, optionally limitable
* @param context context
* @param eperson eperson
* @param limit a positive integer to limit, -1 or null for unlimited
* @return
* @return an iterator over the items submitted by eperson
* @throws SQLException if database error
*/
public Iterator<Item> findBySubmitterDateSorted(Context context, EPerson eperson, Integer limit) throws SQLException;

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

@@ -91,7 +91,7 @@ public interface MetadataValueService {
*
* @param context
* @param metadataFieldId unique identifier of the interesting field.
* @return
* @return the minimum value of the metadata field
* @throws SQLException if database error
*/
public MetadataValue getMinimum(Context context, int metadataFieldId)

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

@@ -143,7 +143,7 @@ public interface WorkspaceItemService extends InProgressSubmissionService<Worksp
/**
* The map entry returned contains stage reached as the key and count of items in that stage as a value
* @param context
* @return
* @return the map
* @throws SQLException if database error
*/
List<Map.Entry<Integer, Long>> getStageReachedCounts(Context context) throws SQLException;

8
dspace-api/src/main/java/org/dspace/core/AbstractHibernateDAO.java
View File

@@ -94,8 +94,8 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
* Execute a JPA Criteria query and return a collection of results.
*
* @param context
* @param query
* @return
* @param query JPQL query string
* @return list of DAOs specified by the query string
* @throws SQLException if database error
*/
public List<T> findMany(Context context, Query query) throws SQLException {
@@ -135,7 +135,7 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
* retrieved an exception will be thrown,
* so only use when the criteria state uniqueness in the database.
* @param criteria
* @return
* @return a DAO specified by the criteria
*/
public T uniqueResult(Criteria criteria)
{
@@ -148,7 +148,7 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
* Retrieve a single result from the query. Best used if you expect a
* single result, but this isn't enforced on the database.
* @param criteria
* @return
* @return a DAO specified by the criteria
*/
public T singleResult(Criteria criteria)
{

10
dspace-api/src/main/java/org/dspace/core/GenericDAO.java
View File

@@ -34,7 +34,7 @@ public interface GenericDAO<T>
*
* @param context
* @param clazz the desired type.
* @return
* @return list of DAOs of the same type as clazz
* @throws SQLException if database error
*/
public List<T> findAll(Context context, Class<T> clazz) throws SQLException;
@@ -43,8 +43,8 @@ public interface GenericDAO<T>
* Execute a JPQL query returning a unique result.
*
* @param context
* @param query
* @return
* @param query JPQL query string
* @return a DAO specified by the query string
* @throws SQLException if database error
*/
public T findUnique(Context context, String query) throws SQLException;
@@ -57,8 +57,8 @@ public interface GenericDAO<T>
* Execute a JPQL query and return a collection of results.
*
* @param context
* @param query
* @return
* @param query JPQL query string
* @return list of DAOs specified by the query string
* @throws SQLException if database error
*/
public List<T> findMany(Context context, String query) throws SQLException;

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

@@ -58,7 +58,7 @@ import org.dspace.services.factory.DSpaceServicesFactory;
* {@code My descriptor $td=ruby|rubytask.rb|LinkChecker.new}
*
* For portability, the {@code <relFilePath>} component may be omitted in this context.
* Thus, {@code$td=ruby||LinkChecker.new} will be expanded to a descriptor
* Thus, {@code $td=ruby||LinkChecker.new} will be expanded to a descriptor
* with the name of the embedding file.
*
* @author richardrodgers

9
dspace-api/src/main/java/org/dspace/handle/Handle.java
View File

@@ -37,6 +37,9 @@ public class Handle implements ReloadableEntity<Integer> {
@JoinColumn(name = "resource_id")
private DSpaceObject dso;
/*
* {@see org.dspace.core.Constants#Constants Constants}
*/
@Column(name = "resource_type_id")
private Integer resourceTypeId;
@@ -74,10 +77,16 @@ public class Handle implements ReloadableEntity<Integer> {
return dso;
}
/*
* @param resourceTypeId the integer constant of the DSO, see {@link org.dspace.core.Constants#Constants Constants}
*/
public void setResourceTypeId(Integer resourceTypeId) {
this.resourceTypeId = resourceTypeId;
}
/*
* @return the integer constant of the DSO, see {@link org.dspace.core.Constants#Constants Constants}
*/
public Integer getResourceTypeId() {
return resourceTypeId;
}

2
dspace-api/src/main/java/org/dspace/identifier/DOI.java
View File

@@ -88,7 +88,7 @@ public class DOI
* returns the resource type of the DSpaceObject the DOI is or was assigned
* to. The resource type is set automatically when a DOI is assigned to a
* DSpaceObject, using {@link #setDSpaceObject(org.dspace.content.DSpaceObject) }.
* @return
* @return the integer constant of the DSO, see {@link org.dspace.core.Constants#Constants Constants}
*/
public Integer getResourceTypeId() {
return this.resourceTypeId;

10
dspace-api/src/main/java/org/dspace/identifier/DOIIdentifierProvider.java
View File

@@ -144,7 +144,7 @@ public class DOIIdentifierProvider
* This identifier provider supports identifiers of type
* {@link org.dspace.identifier.DOI}.
* @param identifier to check if it will be supported by this provider.
* @return
* @return boolean
*/
@Override
public boolean supports(Class<? extends Identifier> identifier)
@@ -160,7 +160,7 @@ public class DOIIdentifierProvider
* <li>http://dx.doi.org/10.123/456</li>
* </ul>
* @param identifier to check if it is in a supported format.
* @return
* @return boolean
*/
@Override
public boolean supports(String identifier)
@@ -231,7 +231,7 @@ public class DOIIdentifierProvider
* @param dso DSpaceObject the DOI should be reserved for. Some metadata of
* this object will be send to the registration agency.
* @param identifier DOI to register in a format that
* {@link FormatIdentifier(String)} accepts.
* {@link org.dspace.identifier.service.DOIService#formatIdentifier(String)} accepts.
* @throws IdentifierException If the format of {@code identifier} was
* unrecognized or if it was impossible to
* reserve the DOI (registration agency denied
@@ -239,7 +239,7 @@ public class DOIIdentifierProvider
* @throws IllegalArgumentException If {@code identifier} is a DOI already
* registered for another DSpaceObject then
* {@code dso}.
* @see IdentifierProvider.reserve(Context, DSpaceObject, String)
* @see org.dspace.identifier.IdentifierProvider#reserve(Context, DSpaceObject, String)
*/
@Override
public void reserve(Context context, DSpaceObject dso, String identifier)
@@ -696,7 +696,7 @@ public class DOIIdentifierProvider
* Returns a DSpaceObject depending on its DOI.
* @param context the context
* @param identifier The DOI in a format that is accepted by
* {@link formatIdentifier(String)}.
* {@link org.dspace.identifier.service.DOIService#formatIdentifier(String)}.
* @return Null if the DOI couldn't be found or the associated DSpaceObject.
* @throws SQLException if database error
* @throws IdentifierException If {@code identifier} is null or an empty string.

4
dspace-api/src/main/java/org/dspace/identifier/DataCiteXMLCreator.java
View File

@@ -54,8 +54,8 @@ public class DataCiteXMLCreator
/**
* DisseminationCrosswalk to map local metadata into DataCite metadata. The
* name of the crosswalk is set by {@link setDisseminationCrosswalk(String)
* setDisseminationCrosswalk} which instantiates the crosswalk.
* name of the crosswalk is set by {@link #setDisseminationCrosswalkName(String)
* setDisseminationCrosswalkName} which instantiates the crosswalk.
*/
protected ParameterizedDisseminationCrosswalk xwalk;

14
dspace-api/src/main/java/org/dspace/identifier/doi/DOIConnector.java
View File

@@ -17,9 +17,10 @@ import org.dspace.core.Context;
* A DOIConnector should care about rules of the registration agency. For
* example, if the registration agency wants us to reserve a DOI before we can
* register it, the DOIConnector should check if a DOI is reserved. Use a
* {@link DOIIdenfierException} and set its error code in case of any errors.
* {@link org.dspace.identifier.doi.DOIIdentifierException#DOIIdentifierException DOIIdentifierException}.
* and set its error code in case of any errors.
* For the given example you should use
* {@code DOIIdentifierException.RESERVER_FIRST} as error code.
* {@code DOIIdentifierException.RESERVE_FIRST} as error code.
*
* @author Pascal-Nicolas Becker
*/
@@ -49,7 +50,8 @@ public interface DOIConnector {
* Sends a request to the DOI registry to reserve a DOI.
*
* The DOIConnector should check weather this DOI is reserved for another
* object already. In this case it should throw an {@link
* object already. In this case it should throw an
* {@link org.dspace.identifier.doi.DOIIdentifierException#DOIIdentifierException DOIIdentifierException}.
* DOIIdentifierException} and set the error code to {@code
* DOIIdentifierException.DOI_ALREADY_EXISTS}.
*
@@ -66,8 +68,10 @@ public interface DOIConnector {
* The DOIConnector ensures compliance with the workflow of the registration
* agency. For example, if a DOI has to be reserved before it can be
* registered the DOIConnector has to check if it is reserved. In this case
* you can throw an DOIIdentifierExcpetion and set the error code to
* {@link DOIIdentifierException.RESERVE_FIRST}.
* you can throw an
* {@link org.dspace.identifier.doi.DOIIdentifierException#DOIIdentifierException DOIIdentifierException}.
* and set the error code to
* {@code DOIIdentifierException.RESERVE_FIRST}.
*
* @param context
* @param dso

18
dspace-api/src/main/java/org/dspace/identifier/doi/DataCiteConnector.java
View File

@@ -103,7 +103,7 @@ implements DOIConnector
/**
* DisseminationCrosswalk to map local metadata into DataCite metadata.
* The name of the crosswalk is set by spring dependency injection using
* {@link setDisseminationCrosswalk(String) setDisseminationCrosswalk} which
* {@link #setDisseminationCrosswalkName(String) setDisseminationCrosswalkName} which
* instantiates the crosswalk.
*/
protected ParameterizedDisseminationCrosswalk xwalk;
@@ -545,7 +545,7 @@ implements DOIConnector
// 412 Precondition failed: DOI was not reserved before registration!
case (412) :
{
log.error("We tried to register a DOI {} that was not reserved "
log.error("We tried to register a DOI {} that has not been reserved "
+ "before! The registration agency told us: {}.", doi,
resp.getContent());
throw new DOIIdentifierException("There was an error in handling "
@@ -571,8 +571,8 @@ implements DOIConnector
public void updateMetadata(Context context, DSpaceObject dso, String doi)
throws DOIIdentifierException
{
// We can use reserveDOI to update metadata. Datacite API uses the same
// request for reservartion as for updating metadata.
// We can use reserveDOI to update metadata. DataCite API uses the same
// request for reservation as for updating metadata.
this.reserveDOI(context, dso, doi);
}
@@ -612,7 +612,7 @@ implements DOIConnector
}
finally
{
// release ressources
// release resources
try
{
EntityUtils.consume(reqEntity);
@@ -731,7 +731,7 @@ implements DOIConnector
}
finally
{
// release ressources
// release resources
try
{
EntityUtils.consume(reqEntity);
@@ -748,7 +748,7 @@ implements DOIConnector
*
* @param req
* @param doi
* @return
* @return response from DataCite
* @throws DOIIdentifierException if DOI error
*/
protected DataCiteResponse sendHttpRequest(HttpUriRequest req, String doi)
@@ -774,7 +774,7 @@ implements DOIConnector
content = EntityUtils.toString(entity, "UTF-8");
}
/* While debugging it can be useful to see whitch requests are send:
/* While debugging it can be useful to see which requests are sent:
*
* log.debug("Going to send HTTP request of type " + req.getMethod() + ".");
* log.debug("Will be send to " + req.getURI().toString() + ".");
@@ -861,7 +861,7 @@ implements DOIConnector
{
try
{
// Release any ressources used by HTTP-Request.
// Release any resources used by HTTP-Request.
if (null != entity)
{
EntityUtils.consume(entity);

10
dspace-api/src/main/java/org/dspace/identifier/ezid/EZIDRequest.java
View File

@@ -159,10 +159,10 @@ public class EZIDRequest
/**
* Create an identifier with a given name. The name is the end of the
* request path. Note: to "reserve" a given identifier, include "_status =
* reserved" in {@link metadata}.
* reserved" in {@code metadata}.
*
* @param metadata ANVL-encoded key/value pairs.
* @return
* @return Decoded response data evoked by a request made to EZID.
*/
public EZIDResponse create(String name, Map<String, String> metadata)
throws IOException, IdentifierException, URISyntaxException
@@ -182,10 +182,10 @@ public class EZIDRequest
/**
* Ask EZID to create a unique identifier and return its name. NOTE: to
* "reserve" a unique identifier, include "_status = reserved" in {@link metadata}.
* "reserve" a unique identifier, include "_status = reserved" in {@code metadata}.
*
* @param metadata ANVL-encoded key/value pairs.
* @return
* @return Decoded response data evoked by a request made to EZID.
*/
public EZIDResponse mint(Map<String, String> metadata)
throws IOException, IdentifierException, URISyntaxException
@@ -209,7 +209,7 @@ public class EZIDRequest
*
* @param metadata fields to be altered. Leave the value of a field's empty
* to delete the field.
* @return
* @return Decoded response data evoked by a request made to EZID.
*/
public EZIDResponse modify(String name, Map<String, String> metadata)
throws IOException, IdentifierException, URISyntaxException

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

@@ -48,7 +48,7 @@ public interface IdentifierService {
* @return the matching identifiers, or the site identifier if the object
* is a Site, or an empty array if no matching identifier is found.
*/
List<String> lookup(Context contex, DSpaceObject dso);
List<String> lookup(Context context, DSpaceObject dso);
/**
*

10
dspace-api/src/main/java/org/dspace/rdf/RDFizer.java
View File

@@ -118,7 +118,7 @@ public class RDFizer {
/**
* Returns whether all converted data is printed to stdout. Turtle will be
* used as serialization.
* @return
* @return {@code true} if print all generated data is to be printed to stdout
*/
public boolean isStdout() {
return stdout;
@@ -137,7 +137,7 @@ public class RDFizer {
/**
* Returns whether verbose information is printed to System.err. Probably
* this is helpful for CLI only.
* @return
* @return {@code true} if verbose mode is on
*/
public boolean isVerbose() {
return verbose;
@@ -154,7 +154,7 @@ public class RDFizer {
/**
* Returns whether this is a dry run. Probably this is helpful for CLI only.
* @return
* @return {@code true} if dry-run mode is on
*/
public boolean isDryrun() {
return dryrun;
@@ -214,7 +214,7 @@ public class RDFizer {
System.err.println("Cannot determine RDF URI for "
+ contentServiceFactory.getDSpaceObjectService(dso).getTypeText(dso) + " " + dso.getID() + "(handle "
+ dso.getHandle() + ")" + ", skipping. Please "
+ "delete it specifing the RDF URI.");
+ "delete it specifying the RDF URI.");
log.error("Cannot detgermine RDF URI for "
+ contentServiceFactory.getDSpaceObjectService(dso).getTypeText(dso) + " " + dso.getID() + "(handle "
+ dso.getHandle() + ")" + ", skipping deletion.");
@@ -417,7 +417,7 @@ public class RDFizer {
}
}
// Currently Bundles and Bitsreams aren't supported as independent entities.
// Currently Bundles and Bitstreams aren't supported as independent entities.
// They should be converted as part of an item. So we do not need to make
// the recursive call for them. An item itself will be converted as part
// of the callback call below.

2
dspace-api/src/main/java/org/dspace/rdf/conversion/DMRM.java
View File

@@ -16,7 +16,7 @@ import com.hp.hpl.jena.rdf.model.Resource;
/**
* Schema for DSpace Metadata RDF Mappings.
* @author Pascal-Nicolas Becker (dspace -at- pascal -hyphen- becker -dot- de)
* @see http://digital-repositories.org/ontologies/dspace-metadata-mapping/0.2.0
* @see <a href="http://digital-repositories.org/ontologies/dspace-metadata-mapping/0.2.0">http://digital-repositories.org/ontologies/dspace-metadata-mapping/0.2.0</a>
*/
public class DMRM {
/** <p>The RDF model that holds the vocabulary terms</p> */

1
dspace-api/src/main/java/org/dspace/rdf/negotiation/Negotiator.java
View File

@@ -170,7 +170,6 @@ public class Negotiator {
* equals! Caution should be exercised when using it to order a sorted set
* or a sorted map. Take a look at the java.util.Comparator for further
* information.</p>
* @param mediaRangeRegex
* @return A comparator that imposes orderings that are inconsistent with equals!
*/
public static Comparator<MediaRange> getMediaRangeComparator() {

14
dspace-api/src/main/java/org/dspace/rdf/storage/RDFStorage.java
View File

@@ -18,21 +18,21 @@ import java.util.List;
public interface RDFStorage {
/**
* Don't use this method directly, use
* {@link org.dspace.rdf.RDFizer#convert(org.dspace.core.Context,
* org.dspace.content.DSpaceObject) RDFizer.convert(...)} to convert and store DSpaceObjets.
* {@link org.dspace.rdf.RDFUtil#convert(org.dspace.core.Context, org.dspace.content.DSpaceObject) RDFizer.convert(...)}
* to convert and store DSpaceObjets.
* @param uri Identifier for this DSO
* ({@link org.dspace.rdf.RDFizer#generateIdentifier(org.dspace.core.Context,
* org.dspace.content.DSpaceObject) RDFizer.generateIdentifier(...)}). You can load this model by using this URI.
* ({@link org.dspace.rdf.RDFUtil#generateIdentifier(org.dspace.core.Context, org.dspace.content.DSpaceObject) RDFizer.generateIdentifier(...)}).
* You can load this model by using this URI.
* @param model The model to store.
* @see org.dspace.rdf.RDFizer;
* @see org.dspace.rdf.RDFizer#RDFizer
*/
public void store(String uri, Model model);
/**
* Don't use this method directly, use
* {@link org.dspace.rdf.RDFizer#loadModel(String) RDFizer.loadModel(...)} instead.
* {@link org.dspace.rdf.RDFUtil#loadModel(String) RDFizer.loadModel(...)} instead.
* @param uri
* @return
* @return the model
*/
public Model load(String uri);

14
dspace-api/src/main/java/org/dspace/rdf/storage/URIGenerator.java
View File

@@ -23,12 +23,12 @@ import org.dspace.core.Context;
* type SITE, COMMUNITY, COLLECTION or ITEM only. Currently dspace-rdf
* doesn't support Bundles or Bitstreams as independent entity.
*
* @class{org.dspace.rdf.RDFizer} uses a URIGenerator to generate URIs to
* {@link org.dspace.rdf.RDFizer#RDFizer} uses a URIGenerator to generate URIs to
* Identify DSpaceObjects in RDF. You can configure which URIGenerator should be
* used. See DSpace documentation on how to configure RDFizer.
* @author Pascal-Nicolas Becker (dspace -at- pascal -hyphen- becker -dot- de)
* @see org.dspace.rdf.RDFizer
* @see org.dspace.rdf.RDFUtil
* @see org.dspace.rdf.RDFizer#RDFizer
* @see org.dspace.rdf.RDFUtil#RDFUtil
*/
public interface URIGenerator {
@@ -39,7 +39,10 @@ public interface URIGenerator {
* doesn't support Bundles or Bitstreams as independent entity. This method
* should work even if the DSpaceObject does not exist anymore.
* @param context
* @param dso
* @param type
* @param id
* @param handle
* @param identifiers
* @return May return null, if no URI could be generated.
* @see org.dspace.rdf.RDFUtil#generateIdentifier(Context, DSpaceObject)
*/
@@ -47,8 +50,7 @@ public interface URIGenerator {
throws SQLException;
/**
* Shortcut for {@code generateIdentifier(context, dso.getType(),
* dso.getID(), dso.getHandle())}.
* Shortcut for {@code generateIdentifier(context, dso.getType(), dso.getID(), dso.getHandle())}.
*
* @param context
* @param dso

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

@@ -90,7 +90,7 @@ public class SpiderDetector {
/**
* Get an immutable Set representing all the Spider Addresses here
*
* @return
* @return a set of IP addresses as strings
*/
public static Set<String> getSpiderIpAddresses() {

10
dspace-api/src/main/java/org/dspace/storage/bitstore/BitStoreService.java
View File

@@ -21,20 +21,20 @@ import java.util.Map;
public interface BitStoreService
{
/**
/**
* Initialize the asset store
*
*/
public void init() throws IOException;
/**
/**
* Return an identifier unique to this asset store instance
*
* @return a unique ID
*/
public String generateId();
/**
/**
* Retrieve the bits for bitstream
*
* @param bitstream
@@ -56,13 +56,11 @@ public interface BitStoreService
* </p>
*
* @param bitstream
* The bitsream object
* The bitstream object
* @param inputStream
* The stream of bits
* @exception java.io.IOException
* If a problem occurs while storing the bits
*
* @return Map containing technical metadata (size, checksum, etc)
*/
public void put(Bitstream bitstream, InputStream inputStream) throws IOException;

2
dspace-api/src/main/java/org/dspace/storage/bitstore/DSBitStoreService.java
View File

@@ -108,8 +108,6 @@ public class DSBitStoreService implements BitStoreService
* The stream of bits to store
* @exception java.io.IOException
* If a problem occurs while storing the bits
*
* @return Map containing technical metadata (size, checksum, etc)
*/
public void put(Bitstream bitstream, InputStream in) throws IOException
{

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

@@ -160,8 +160,6 @@ public class S3BitStoreService implements BitStoreService
* The stream of bits to store
* @exception java.io.IOException
* If a problem occurs while storing the bits
*
* @return Map containing technical metadata (size, checksum, etc)
*/
public void put(Bitstream bitstream, InputStream in) throws IOException
{
@@ -260,7 +258,7 @@ public class S3BitStoreService implements BitStoreService
/**
* Utility Method: Prefix the key with a subfolder, if this instance assets are stored within subfolder
* @param id
* @return
* @return full key prefixed with a subfolder, if applicable
*/
public String getFullKey(String id) {
if(StringUtils.isNotEmpty(subfolder)) {

4
dspace-api/src/main/java/org/dspace/storage/rdbms/hibernate/postgres/DSpacePostgreSQL82Dialect.java
View File

@@ -45,8 +45,8 @@ public class DSpacePostgreSQL82Dialect extends PostgreSQL82Dialect
/**
* Override is needed to properly support the CLOB on metadatavalue in postgres & oracle.
* @param sqlCode
* @return
* @param sqlCode {@linkplain java.sql.Types JDBC type-code} for the column mapped by this type.
* @return Descriptor for the SQL/JDBC side of a value mapping.
*/
@Override
public SqlTypeDescriptor getSqlTypeDescriptorOverride(int sqlCode) {

6
dspace-api/src/main/java/org/dspace/submit/lookup/LanguageCodeModifier.java
View File

@@ -78,10 +78,10 @@ public class LanguageCodeModifier extends AbstractModifier implements Initializi
/**
* Covert ISO 639-2 alpha-3 code to ISO 639-1 alpha-2 code
*
* @param lang
* 3char language code
* @param lang3
* ISO 639-1 alpha-3 language code
*
* @return String 2char language code ("other" unless code has 2 char code)
* @return String ISO 639-1 alpha-2 language code ("other" if code is not alpha-2)
*
*/
protected String getLang2(String lang3)

2
dspace-api/src/main/java/org/dspace/util/MultiFormatDateParser.java
View File

@@ -30,7 +30,7 @@ import org.slf4j.LoggerFactory;
/**
* Attempt to parse date strings in a variety of formats. This uses an external
* list of regular expressions and associated SimpleDateFormat strings. Inject
* the list as pairs of strings using {@link setPatterns}. {@link parse} walks
* the list as pairs of strings using {@link #setPatterns}. {@link #parse} walks
* the provided list in the order provided and tries each entry against a String.
*
* Dates are parsed as being in the UTC zone.

6
dspace-api/src/main/java/org/dspace/versioning/VersionHistory.java
View File

@@ -56,10 +56,10 @@ public class VersionHistory implements ReloadableEntity<Integer> {
}
/**
* Please use {@link VersioningService#getVersionsByHistory(Context, VersionHistory)} instead.
* Please use {@link org.dspace.versioning.service.VersioningService#getVersionsByHistory(Context, VersionHistory)} instead.
*
* To keep version number stables we keep information about deleted Versions.
* {@code VersioningService.getVersionsByHistory(Context, VersionHistory)} filters
* {@code org.dspace.versioning.service.VersioningService#getVersionsByHistory(Context, VersionHistory) VersioningService#getVersionsByHistory} filters
* such versions and returns only active versions.
*/
protected List<Version> getVersions() {
@@ -109,4 +109,4 @@ public class VersionHistory implements ReloadableEntity<Integer> {
return hash;
}
}
}

10
dspace-jspui/src/main/java/org/dspace/app/webui/jsptag/AccessSettingTag.java
View File

@@ -253,10 +253,10 @@ public class AccessSettingTag extends TagSupport
}
/**
* Set the browseInfo
* Set the subInfo (SubmissionInfo)
*
* @param browseInfo
* the browseInfo
* @param subInfo
* the subInfo
*/
public void setSubInfo(SubmissionInfo subInfo)
{
@@ -276,7 +276,7 @@ public class AccessSettingTag extends TagSupport
/**
* Set the the dso
*
* @param the dso
* @param dso
* the dso
*/
public void setDso(DSpaceObject dso)
@@ -297,7 +297,7 @@ public class AccessSettingTag extends TagSupport
/**
* Set the the rp
*
* @param the rp
* @param rp
* the rp
*/
public void setRp(ResourcePolicy rp)

2
dspace-jspui/src/main/java/org/dspace/app/webui/jsptag/ItemTag.java
View File

@@ -1040,7 +1040,7 @@ public class ItemTag extends TagSupport
// won't have a big problem here
rp = policy;
// if we found a policy allowing anonymous
// group to read the bitsream, mark it as
// group to read the bitstream, mark it as
// being anoymous readable and leave the loop
if (resourcePolicyService.isDateValid(policy))
{

2
dspace-jspui/src/main/java/org/dspace/app/webui/jsptag/PoliciesListTag.java
View File

@@ -130,7 +130,7 @@ public class PoliciesListTag extends TagSupport
/**
* Set the policies to list
*
* @param itemsIn
* @param policies
* the policies
*/
public void setPolicies(List<ResourcePolicy> policies)

2
dspace-jspui/src/main/java/org/dspace/app/webui/submit/step/JSPUploadWithEmbargoStep.java
View File

@@ -67,7 +67,7 @@ import com.google.gson.Gson;
*
* @see org.dspace.app.webui.servlet.SubmissionController
* @see org.dspace.app.webui.submit.JSPStep
* @see org.dspace.app.webui.submit.JSPUploadStep
* @see org.dspace.app.webui.submit.step.JSPUploadStep
* @see org.dspace.submit.step.UploadStep
*
* @author Tim Donohue

9
dspace-jspui/src/main/java/org/dspace/app/webui/util/UIUtil.java
View File

@@ -208,7 +208,8 @@ public class UIUtil extends Util
*
* @param ctx DSpace Context
* @param item the item
* @return
* @return string array containing URL or null if no ID found; string
array contains null if no handle, but a DOI is found
* @throws SQLException
*/
public static String[] getItemIdentifier(Context ctx, Item item)
@@ -600,7 +601,7 @@ public class UIUtil extends Util
* @param hrq The servlet request
* @param dso The DSpaceObject to mark (it can be a BrowseItem or an Item)
* @param markType the type of the mark.
* @return
* @return (X)HTML markup
* @throws JspException
*/
public static String getMarkingMarkup(HttpServletRequest hrq, DSpaceObject dso, String markType)
@@ -610,8 +611,8 @@ public class UIUtil extends Util
try
{
String contextPath = hrq.getContextPath();
String contextPath = hrq.getContextPath();
Context c = UIUtil.obtainContext(hrq);
Item item = (Item) dso;

2
dspace-jspui/src/main/java/org/dspace/app/webui/util/VersionUtil.java
View File

@@ -323,7 +323,7 @@ public class VersionUtil
*
* @param context
* @param stringVersionID
* @return
* @return version summary string
*/
public static String getSummary(Context context, String stringVersionID)
{

4
dspace-rest/src/main/java/org/dspace/rest/BitstreamResource.java
View File

@@ -118,7 +118,7 @@ public class BitstreamResource extends Resource
bitstream = new Bitstream(dspaceBitstream, servletContext, expand, context);
context.complete();
log.trace("Bitsream(id=" + bitstreamId + ") was successfully read.");
log.trace("Bitstream(id=" + bitstreamId + ") was successfully read.");
}
catch (SQLException e)
@@ -311,7 +311,7 @@ public class BitstreamResource extends Resource
writeStats(dspaceBitstream, UsageEvent.Action.VIEW, user_ip, user_agent, xforwardedfor, headers,
request, context);
log.trace("Bitsream(id=" + bitstreamId + ") data was successfully read.");
log.trace("Bitstream(id=" + bitstreamId + ") data was successfully read.");
inputStream = bitstreamService.retrieve(context, dspaceBitstream);
type = dspaceBitstream.getFormat(context).getMIMEType();

4
dspace-rest/src/main/java/org/dspace/rest/Resource.java
View File

@@ -61,14 +61,12 @@ public class Resource
/**
* Create context to work with DSpace database. It can create context
* with or without a logged in user (parameter user is null). Throws
* with or without a logged in user (retrieved from SecurityContextHolder). Throws
* WebApplicationException caused by: SQLException if there was a problem
* with reading from database. Throws AuthorizeException if there was
* a problem with authorization to read from the database. Throws Exception
* if there was a problem creating context.
*
* @param person
* User which will be logged in context.
* @return Newly created context with the logged in user unless the specified user was null.
* If user is null, create the context without a logged in user.
* @throws ContextException

4
dspace-rest/src/main/java/org/dspace/rest/RestIndex.java
View File

@@ -248,7 +248,9 @@ public class RestIndex {
* epersonEMAIL: user@example.com
* epersonNAME: John Doe
* @param headers
* @return
* Request header which contains the header named
* "rest-dspace-token" containing the token as value.
* @return status
*/
@GET
@Path("/status")

5
dspace-rest/src/main/java/org/dspace/rest/filter/ItemFilterSet.java
View File

@@ -40,12 +40,9 @@ public class ItemFilterSet {
*
* @param filterList
* Comma separated list of filter names to include
* @see ItemFilter.ALL to retrieve all filters
* @see org.dspace.rest.common#ItemFilter.ALL to retrieve all filters
* @param reportItems
* If true, return item details. If false, return only counts of items.
*
* @author Terry Brady, Georgetown University
*
*/
public ItemFilterSet(String filterList, boolean reportItems) {
log.debug(String.format("Create ItemFilterSet: %s", filterList));

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

@@ -37,9 +37,9 @@ public class CollectionCollectionGenerator implements 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 DSpaceSwordException
* @param dso
* @return
* @return the SWORD ATOM collection
* @throws DSpaceSwordException
*/
public SwordCollection buildCollection(Context context, DSpaceObject dso,

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

@@ -110,7 +110,7 @@ public class SwordAuthenticator
* method
*
* @param auth
* @return
* @return SWORD context
* @throws DSpaceSwordException
* @throws SwordError
* @throws SwordAuthException

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

@@ -284,9 +284,9 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* Get the bundle name that sword will store its original deposit packages in, when
* Get the bundle name that SWORD will store its original deposit packages in, when
* storing them inside an item
* @return
* @return SWORD bundle name
*/
public String getSwordBundle()
{
@@ -294,9 +294,9 @@ public class SwordConfigurationDSpace implements SwordConfiguration
}
/**
* Set the bundle name that sword will store its original deposit packages in, when
* Set the bundle name that SWORD will store its original deposit packages in, when
* storing them inside an item
* @param swordBundle
* @param swordBundle SWORD bundle name
*/
public void setSwordBundle(String swordBundle)
{