Added Comments
git-svn-id: https://svn.d4science.research-infrastructures.eu/gcube/trunk/portlets/user/tabular-data-gwt-service@84939 82a268e6-3cf1-43bd-a215-b396298e98cf
This commit is contained in:
parent
21c68ae4cd
commit
5df6f4eb2c
|
|
@ -3,13 +3,9 @@
|
|||
*/
|
||||
package org.gcube.portlets.user.td.gwtservice.client.rpc;
|
||||
|
||||
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
|
||||
|
||||
import org.gcube.portlets.user.td.gwtservice.shared.Agencies;
|
||||
import org.gcube.portlets.user.td.gwtservice.shared.Codelist;
|
||||
import org.gcube.portlets.user.td.gwtservice.shared.Dataset;
|
||||
|
|
@ -27,8 +23,19 @@ import org.gcube.portlets.user.td.gwtservice.shared.sdmx.SDMXImportSession;
|
|||
|
||||
import com.google.gwt.user.client.rpc.RemoteService;
|
||||
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
* Implements the basic interfaces for access to the service.
|
||||
*
|
||||
* <p>
|
||||
* In particular allows: *
|
||||
* <ul>
|
||||
* <li>Access to Tabular Resources</li>
|
||||
* <li>Import of CSV file</li>
|
||||
* <li>Import from SDMX Registry</li>
|
||||
* <ul>
|
||||
* </p>
|
||||
*
|
||||
* @author "Giancarlo Panichi" <a
|
||||
* href="mailto:g.panichi@isti.cnr.it">g.panichi@isti.cnr.it</a>
|
||||
|
|
@ -37,44 +44,167 @@ import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
|
|||
@RemoteServiceRelativePath("TDGWTService")
|
||||
public interface TDGWTService extends RemoteService {
|
||||
|
||||
/**
|
||||
* Get informations on the current tabular resource
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public TabResource getTabResourceInformation() throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
* Set current tabular resource
|
||||
*
|
||||
* @param tr
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public void setTabResource(TabResource tr) throws TDGWTServiceException;
|
||||
|
||||
public List<TabResource> getTabularResources() throws TDGWTServiceException;
|
||||
|
||||
public TabResource createTabularResource(TabResource tabResource) throws TDGWTServiceException;
|
||||
|
||||
//Open
|
||||
|
||||
/**
|
||||
* Creates a TabResource on Service
|
||||
*
|
||||
* @param tabResource
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public TabResource createTabularResource(TabResource tabResource)
|
||||
throws TDGWTServiceException;
|
||||
|
||||
// Open
|
||||
|
||||
/**
|
||||
* Return all tabular resource of a user
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public List<TabResource> getTabularResources() throws TDGWTServiceException;
|
||||
|
||||
/**
|
||||
* Set open session for return all tabular resource of a user
|
||||
*
|
||||
* @param s
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public void setTDOpenSession(TDOpenSession s) throws TDGWTServiceException;
|
||||
|
||||
//Import SDMX
|
||||
|
||||
// Import SDMX
|
||||
|
||||
/**
|
||||
* Get Codelist on a registry
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public ArrayList<Codelist> getCodelists() throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
* Get Datasets on a registry
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public ArrayList<Dataset> getDatasets() throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
* Get Agecies on a registry
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public ArrayList<Agencies> getAgencies() throws TDGWTServiceException;
|
||||
|
||||
public void setSDMXSession(SDMXImportSession s) throws TDGWTServiceException;
|
||||
|
||||
public SDMXImportMonitor getSDMXImportMonitor() throws TDGWTServiceException;
|
||||
|
||||
public void importSDMXClientLibraryRequest(SDMXImportSession s) throws TDGWTServiceException;
|
||||
|
||||
//Import CSV
|
||||
public FileUploadMonitor getFileUploadMonitor() throws TDGWTServiceException;
|
||||
/**
|
||||
* Set SDMXImportSession for SDMX Import
|
||||
*
|
||||
* @param s
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public void setSDMXSession(SDMXImportSession s)
|
||||
throws TDGWTServiceException;
|
||||
|
||||
public CSVImportMonitor getCSVImportMonitor() throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
* Start SDMX Import and invokes the client library
|
||||
*
|
||||
* @param s
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public void startSDMXImport(SDMXImportSession s)
|
||||
throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
* Get Operation Monitor during the SDMX Import operation
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public SDMXImportMonitor getSDMXImportMonitor()
|
||||
throws TDGWTServiceException;
|
||||
|
||||
// Import CSV
|
||||
/**
|
||||
* Get File Upload Monitor during the file upload operation in Import CSV
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public FileUploadMonitor getFileUploadMonitor()
|
||||
throws TDGWTServiceException;
|
||||
|
||||
/**
|
||||
*
|
||||
* @param s
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public void setCSVSession(CSVImportSession s) throws TDGWTServiceException;
|
||||
|
||||
|
||||
public AvailableCharsetList getAvailableCharset() throws TDGWTServiceException;
|
||||
|
||||
public ArrayList<String> configureCSVParser(String encoding, HeaderPresence headerPresence, char delimiter, char comment) throws TDGWTServiceException;
|
||||
|
||||
public ArrayList<CSVRowError> checkCSV(long errorsLimit) throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public AvailableCharsetList getAvailableCharset()
|
||||
throws TDGWTServiceException;
|
||||
|
||||
/**
|
||||
*
|
||||
* @param encoding
|
||||
* @param headerPresence
|
||||
* @param delimiter
|
||||
* @param comment
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public ArrayList<String> configureCSVParser(String encoding,
|
||||
HeaderPresence headerPresence, char delimiter, char comment)
|
||||
throws TDGWTServiceException;
|
||||
|
||||
/**
|
||||
*
|
||||
* @param errorsLimit
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public ArrayList<CSVRowError> checkCSV(long errorsLimit)
|
||||
throws TDGWTServiceException;
|
||||
|
||||
/**
|
||||
* Start CSV Import and invokes the client library
|
||||
*
|
||||
* @param s
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public void startCSVImport(CSVImportSession s) throws TDGWTServiceException;
|
||||
|
||||
|
||||
/**
|
||||
* Get Operation Monitor during the CSV Import operation
|
||||
*
|
||||
* @return
|
||||
* @throws TDGWTServiceException
|
||||
*/
|
||||
public CSVImportMonitor getCSVImportMonitor() throws TDGWTServiceException;
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ public interface TDGWTServiceAsync {
|
|||
|
||||
void getSDMXImportMonitor(AsyncCallback<SDMXImportMonitor> callback);
|
||||
|
||||
void importSDMXClientLibraryRequest(SDMXImportSession s,AsyncCallback<Void> callback);
|
||||
void startSDMXImport(SDMXImportSession s,AsyncCallback<Void> callback);
|
||||
|
||||
//Import CSV
|
||||
void getFileUploadMonitor(AsyncCallback<FileUploadMonitor> callback);
|
||||
|
|
|
|||
|
|
@ -423,7 +423,7 @@ public class TDGWTServiceImpl extends RemoteServiceServlet implements
|
|||
* {@inheritDoc}
|
||||
*/
|
||||
@Override
|
||||
public void importSDMXClientLibraryRequest(
|
||||
public void startSDMXImport(
|
||||
SDMXImportSession sdmxImportSession) throws TDGWTServiceException {
|
||||
|
||||
try {
|
||||
|
|
|
|||
Loading…
Reference in New Issue