Cleanup and Comments

Author: WilliBoelke

app/src/main/java/de/htwBerlin/ois/adapters/RecyclerAdapterLocalFiles.java

@@ -60,8 +60,51 @@ public class RecyclerAdapterLocalFiles extends RecyclerView.Adapter<RecyclerAdap
 
     //------------Constructors------------
 
+    public RecyclerAdapterLocalFiles(Context context, ArrayList<File> localMapFiles, int resource)
+    {
+        this.mapArrayListBackup = new ArrayList<>(localMapFiles); // need to be initialized like that
+        this.resource = resource;
+        this.mapArrayList = localMapFiles;
+        this.context = context;
+    }
+
 
     //------------RecyclerViewAdapter Methods------------
+
+    @Override
+    public int getItemCount()
+    {
+        return mapArrayList.size();
+    }
+
+
+    //------------OnItemClickListener------------
+
+    /**
+     * An interface to define the
+     * onItemClick method
+     * <p>
+     * can be implemented and set as on itemClickListener through the
+     * {@link this#setOnItemClickListener} method
+     */
+    public interface OnItemClickListener
+    {
+        void onItemClick(int position);
+    }
+
+    /**
+     * Setter for the implemented onItemClick method
+     *
+     * @param listener
+     */
+    public void setOnItemClickListener(RecyclerAdapterLocalFiles.OnItemClickListener listener)
+    {
+        this.onItemClickListener = listener;
+    }
+
+
+    //------------Filter (Name)------------
+
     private Filter nameFilter = new Filter()
     {
         @Override
@@ -97,14 +140,16 @@ protected void publishResults(CharSequence constraint, FilterResults results)
         }
     };
 
-    public RecyclerAdapterLocalFiles(Context context, ArrayList<File> localMapFiles, int ressource)
+    @Override
+    public Filter getFilter()
     {
-        this.mapArrayListBackup = new ArrayList<>(localMapFiles); // need to be initialized like that
-        this.resource = ressource;
-        this.mapArrayList = localMapFiles;
-        this.context = context;
+        return nameFilter;
     }
 
+
+
+    //------------View Holder------------
+
     @NonNull
     @Override
     public LocalMapsViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int i)
@@ -114,9 +159,6 @@ public LocalMapsViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int i)
         return localMapsViewHolder;
     }
 
-
-    //------------OnItemClickListener------------
-
     @Override
     public void onBindViewHolder(@NonNull LocalMapsViewHolder localMapsViewHolder, int position)
     {
@@ -143,46 +185,6 @@ public void onBindViewHolder(@NonNull LocalMapsViewHolder localMapsViewHolder, i
         }
     }
 
-    @Override
-    public int getItemCount()
-    {
-        return mapArrayList.size();
-    }
-
-
-    //------------Filter (Name)------------
-
-    /**
-     * Setter for the implemented onItemClick method
-     *
-     * @param listener
-     */
-    public void setOnItemClickListener(RecyclerAdapterLocalFiles.OnItemClickListener listener)
-    {
-        this.onItemClickListener = listener;
-    }
-
-    @Override
-    public Filter getFilter()
-    {
-        return nameFilter;
-    }
-
-    /**
-     * An interface to define the
-     * onItemClick method
-     * <p>
-     * can be implemented and set as on itemClickListener through the
-     * {@link this#setOnItemClickListener} method
-     */
-    public interface OnItemClickListener
-    {
-        void onItemClick(int position);
-    }
-
-
-    //------------View Holder------------
-
     protected static class LocalMapsViewHolder extends RecyclerView.ViewHolder
     {
 

app/src/main/java/de/htwBerlin/ois/adapters/RecyclerAdapterRequestStatus.java

@@ -82,9 +82,9 @@ public void setOnItemClickListener(RecyclerAdapterRequestStatus.OnItemClickListe
     }
 
 
-    //------------Filter (Name)------------
+    //------------Filter------------
 
-    private Filter nameFilter = new Filter()
+    private Filter filter = new Filter()
     {
         @Override
         protected FilterResults performFiltering(CharSequence constraint)
@@ -122,7 +122,7 @@ protected void publishResults(CharSequence constraint, FilterResults results)
     @Override
     public Filter getFilter()
     {
-        return nameFilter;
+        return filter;
     }
 
 

app/src/main/java/de/htwBerlin/ois/model/models/fileStructure/RemoteFile.java

@@ -25,45 +25,46 @@ public RemoteFile(String filename, String path, Long fileSize, String creationDa
 
     //------------Setter------------
 
-    public String getPath()
-    {
-        return this.path;
-    }
 
     public void setPath(String path)
     {
         this.path = path;
     }
 
-    public Long getFileSize()
+    public void setFilename(String filename)
     {
-        return fileSize;
+        this.filename = filename.trim();
     }
 
     public void setFileSize(Long fileSize)
     {
         this.fileSize = fileSize;
     }
 
+    public void setCreationDate(String creationDate)
+    {
+        this.creationDate = creationDate;
+    }
+
     //------------Getter------------
 
     public String getCreationDate()
     {
         return creationDate;
     }
 
-    public void setCreationDate(String creationDate)
+    public String getPath()
     {
-        this.creationDate = creationDate;
+        return this.path;
     }
 
     public String getFilename()
     {
         return filename;
     }
 
-    public void setFilename(String filename)
+    public Long getFileSize()
     {
-        this.filename = filename.trim();
+        return fileSize;
     }
 }

app/src/main/java/de/htwBerlin/ois/model/repositories/localRepositories/LocalMapsRepository.java

@@ -17,11 +17,17 @@
  */
 public class LocalMapsRepository
 {
+
+    //------------Instance Variables------------
+
     private static LocalMapsRepository instance;
     private final String TAG = getClass().getSimpleName();
-    MutableLiveData<ArrayList<File>> data;
+    private MutableLiveData<ArrayList<File>> data;
     private ArrayList<File> localMaps;
 
+
+    //------------Constructors------------
+
     public static LocalMapsRepository getInstance()
     {
         if (instance == null)
@@ -31,11 +37,19 @@ public static LocalMapsRepository getInstance()
         return instance;
     }
 
+    /**
+     * Private constructor
+     */
     private LocalMapsRepository()
     {
         data = new MutableLiveData<>();
     }
 
+    /**
+     * Getter for the localMaps list inside a LiveData object
+     * @param targetDir
+     * @return
+     */
     public MutableLiveData<ArrayList<File>> getLocalFiles(File targetDir)
     {
         readLocalMapFiles(targetDir);
@@ -69,6 +83,11 @@ private void readLocalMapFiles(File targetDir)
         }
     }
 
+    /**
+     * Delete the File at "position"  from the OHDM directory and from the
+     * localMaps ArrayList
+     * @param position
+     */
     public void deleteLocalMapFile(int position)
     {
         localMaps.get(position).delete();

app/src/main/java/de/htwBerlin/ois/model/repositories/remoteRepositories/FtpRepository.java

@@ -29,8 +29,6 @@ public class FtpRepository
     private static FtpRepository instance;
 
 
-    //------------Instance Variables------------
-
     private final String TAG = this.getClass().getSimpleName();
     private MutableLiveData<ArrayList<RemoteFile>> allMaps;
     private MutableLiveData<ArrayList<RemoteFile>> mostRecentMaps;

app/src/main/java/de/htwBerlin/ois/model/repositories/remoteRepositories/HttpRequestsRepository.java renamed to app/src/main/java/de/htwBerlin/ois/model/repositories/remoteRepositories/HttpRepository.java

@@ -10,16 +10,16 @@
 import de.htwBerlin.ois.model.repositories.localRepositories.UserPreferences;
 import de.htwBerlin.ois.serverCommunication.AsyncResponse;
 import de.htwBerlin.ois.serverCommunication.HttpClient;
-import de.htwBerlin.ois.serverCommunication.HttpRequest;
+import de.htwBerlin.ois.serverCommunication.HttpTaskRequest;
 
-import static de.htwBerlin.ois.serverCommunication.HttpRequest.REQUEST_TYP_STATUS_BY_ID;
+import static de.htwBerlin.ois.serverCommunication.HttpTaskRequest.REQUEST_TYP_STATUS_BY_ID;
 
 
-public class HttpRequestsRepository
+public class HttpRepository
 {
     //------------Static Variables------------
 
-    private static HttpRequestsRepository instance;
+    private static HttpRepository instance;
 
 
     //------------Instance Variables------------
@@ -34,22 +34,21 @@ public class HttpRequestsRepository
     /**
      * Private constructor
      */
-    private HttpRequestsRepository()
+    private HttpRepository()
     {
         data = new MutableLiveData<>();
         requests = "";
     }
 
-    public static HttpRequestsRepository getInstance()
+    public static HttpRepository getInstance()
     {
         if (instance == null)
         {
-            instance = new HttpRequestsRepository();
+            instance = new HttpRepository();
         }
         return instance;
     }
 
-
     //------------Getter------------
 
     /**
@@ -72,7 +71,7 @@ public MutableLiveData<String> getRequests()
      */
     private void retrieveRequests()
     {
-        HttpRequest httpRequest = new HttpRequest();
+        HttpTaskRequest httpRequest = new HttpTaskRequest();
         httpRequest.setParams("id=" + UserPreferences.getInstance().getUserID());
         httpRequest.setRequestType(REQUEST_TYP_STATUS_BY_ID);
         httpRequest.setHttpClient(new HttpClient());

app/src/main/java/de/htwBerlin/ois/serverCommunication/FtpTaskFileListing.java

@@ -21,7 +21,6 @@ public class FtpTaskFileListing extends AsyncTask<Void, Void, String>
 
     //------------Instance Variables------------
 
-    private static final SimpleDateFormat sdf = new SimpleDateFormat("dd.MM.yy");
     /**
      * Log Tag
      */