1452: Implement a GUI for StatMan Algorithms Importer

Task-Url: https://support.d4science.org/issues/1452

Fixed Documentation

git-svn-id: https://svn.d4science.research-infrastructures.eu/gcube/trunk/portlets/user/statistical-algorithms-importer@124335 82a268e6-3cf1-43bd-a215-b396298e98cf

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/client/monitor/StatAlgoImporterMonitor.java

@@ -18,7 +18,8 @@ public class StatAlgoImporterMonitor extends AutoProgressMessageBox {
 	
 	/**
 	 * 
-	 * {@inheritDoc}
+	 * @param headingHtml
+	 * @param messageHtml
 	 */
 	public StatAlgoImporterMonitor(SafeHtml headingHtml, SafeHtml messageHtml) {
 		super(headingHtml, messageHtml);
@@ -27,7 +28,7 @@ public class StatAlgoImporterMonitor extends AutoProgressMessageBox {
 	
 	/**
 	 * 
-	 * {@inheritDoc}
+	 * @param headingHtml
 	 */
 	public StatAlgoImporterMonitor(SafeHtml headingHtml) {
 		super(headingHtml);
@@ -36,7 +37,8 @@ public class StatAlgoImporterMonitor extends AutoProgressMessageBox {
 
 	/**
 	 * 
-	 * {@inheritDoc}
+	 * @param headingHtml
+	 * @param messageHtml
 	 */
 	public StatAlgoImporterMonitor(String headingHtml, String messageHtml) {
 		super(headingHtml, messageHtml);
@@ -45,7 +47,7 @@ public class StatAlgoImporterMonitor extends AutoProgressMessageBox {
 
 	/**
 	 * 
-	 * {@inheritDoc}
+	 * @param headingHtml
 	 */
 	public StatAlgoImporterMonitor(String headingHtml) {
 		super(headingHtml);

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/client/rpc/StatAlgoImporterService.java

@@ -24,7 +24,7 @@ public interface StatAlgoImporterService extends RemoteService {
 	/**
 	 * Get informations on the current user
 	 * 
-	 * @return
+	 * @return UserInfo user inforamations
 	 * @throws StatAlgoImporterServiceException
 	 */
 	public UserInfo hello() throws StatAlgoImporterServiceException;
@@ -33,7 +33,7 @@ public interface StatAlgoImporterService extends RemoteService {
 	/**
 	 * Get File Upload Monitor during the file upload operation in Import CSV
 	 * 
-	 * @return
+	 * @return FileUploadMonitor
 	 * @throws StatAlgoImporterServiceException
 	 */
 	public FileUploadMonitor getFileUploadMonitor()

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/client/upload/progress/FileUploadProgressBarUpdater.java

@@ -8,7 +8,7 @@ import com.allen_sauer.gwt.log.client.Log;
 import com.sencha.gxt.widget.core.client.ProgressBar;
 
 /**
- * Updates a {@link ProgressBar} progress and text based on {@link CSVImportProgressListener} events.
+ * Updates a {@link ProgressBar} progress and text based on {@link FileUploadProgressListener} events.
  * 
  * @author "Giancarlo Panichi" 
  * <a href="mailto:g.panichi@isti.cnr.it">g.panichi@isti.cnr.it</a> 

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/client/upload/progress/FileUploadProgressListener.java

@@ -7,7 +7,7 @@ package org.gcube.portlets.user.statisticalalgorithmsimporter.client.upload.prog
 
 
 /**
- * Defines a listener for operation progress.
+ * Defines a listener for file upload progress.
  *
  * @author "Giancarlo Panichi" 
  * <a href="mailto:g.panichi@isti.cnr.it">g.panichi@isti.cnr.it</a> 

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/client/upload/progress/FileUploadProgressUpdater.java

@@ -13,8 +13,7 @@ import com.google.gwt.user.client.Timer;
 import com.google.gwt.user.client.rpc.AsyncCallback;
 
 /**
- * This {@link Timer} retrieves {@link OperationProgress} from the specified {@link OperationProgressSource} with the scheduled interval.
+ * 
- * The retrieved information are spread to the subscribed {@link CSVImportProgressListener}.
  * 
  * @author "Giancarlo Panichi" 
  * <a href="mailto:g.panichi@isti.cnr.it">g.panichi@isti.cnr.it</a> 

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/server/storage/FilesStorage.java

@@ -408,7 +408,7 @@ public class FilesStorage {
 	 * 
 	 * @param user
 	 * @param folderId
-	 * @return
+	 * @return boolean
 	 * @throws StatAlgoImporterServiceException
 	 */
 	public boolean existProjectItemOnWorkspace(String user, String folderId)
@@ -444,7 +444,7 @@ public class FilesStorage {
 	 * 
 	 * @param user
 	 * @param itemId
-	 * @return
+	 * @return WorkspaceItem
 	 * @throws StatAlgoImporterServiceException
 	 */
 	public WorkspaceItem retrieveItemInfoOnWorkspace(String user, String itemId)
@@ -493,13 +493,12 @@ public class FilesStorage {
 		}
 	}
 
+	
 	/**
 	 * 
-	 * @param user
+	 * @param user User
-	 *            User
+	 * @param wi WorkspaceItem
-	 * @param remotePath
+	 * @return InputStream 
-	 *            File path on storage
-	 * @return Input stream back to read the file
 	 * @throws StatAlgoImporterServiceException
 	 */
 	public InputStream retrieveImputStream(String user, WorkspaceItem wi)

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/server/storage/MainCodeSave.java

@@ -52,7 +52,7 @@ public class MainCodeSave {
 	 * @param file description of destination file
 	 * @param code code to insert in the file
 	 * @param project 
-	 * @return
+	 * @return ItemDescription
 	 * @throws StatAlgoImporterServiceException
 	 */
 	public ItemDescription saveNew(ASLSession aslSession, ItemDescription file,

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/shared/file/FileUploadMonitor.java

@@ -82,7 +82,8 @@ public class FileUploadMonitor implements Serializable {
 	}
 
 	/**
-	 * @return the reason
+	 * 
+	 * @return failureReason
 	 */
 	public String getFailureReason() {
 		return failureReason;
@@ -96,14 +97,17 @@ public class FileUploadMonitor implements Serializable {
 	}
 
 	/**
-	 * @param elaboratedLenght the elaboratedLenght to set
+	 * 
+	 * @param elaboratedLenght
 	 */
 	public void setElaboratedLenght(long elaboratedLenght) {
 		this.elaboratedLenght = elaboratedLenght;
 	}
 
 	/**
-	 * @param failed the failed to set
+	 * 
+	 * @param failureReason
+	 * @param failureDetails
 	 */
 	public void setFailed(String failureReason, String failureDetails) {
 		this.state = FileUploadState.FAILED;

src/main/java/org/gcube/portlets/user/statisticalalgorithmsimporter/shared/workspace/ItemDescription.java

@@ -85,7 +85,8 @@ public class ItemDescription implements Serializable {
 	 * Compare basic information with another ItemDescription not null
 	 * 
 	 * @param itemDescription
-	 * @return 
+	 * @return boolean  
+	 *
 	 */
 	public boolean compareInfo(ItemDescription itemDescription){
 		if(itemDescription!=null && id.compareTo(itemDescription.getId())==0 &&