Merge pull request #1 from payammeyer/BigWorkflowRefactor

Merging into my master

Author: payammeyer

dcs-packaging-tool/dcs-packaging-tool-gui/src/main/java/org/dataconservancy/packaging/gui/Controller.java

@@ -66,33 +66,39 @@ public class Controller {
     private PackageToolPopup crossPageProgressIndicatorPopUp;
     private Page currentPage;
     private Stack<Page> previousPages;
-    
+
     /* For handling file dialog mutex locks as a MacOS bug workaround DC-1624 */
     private final ConcurrentHashMap<Object, Semaphore> locks = new ConcurrentHashMap<>();
-    
+
     public Controller() {
         this.container = new BorderPane();
         container.getStyleClass().add(CssConstants.ROOT_CLASS);
         previousPages = new Stack<>();
         toolVersion = new ApplicationVersion();
     }
 
-    public Factory getFactory() { return factory; }
-    public void setFactory(Factory factory) { this.factory = factory; }
+    public Factory getFactory() {
+        return factory;
+    }
+
+    public void setFactory(Factory factory) {
+        this.factory = factory;
+    }
 
     public void startApp() {
         defaultPackageGenerationParametersFilePath = factory.getConfiguration().getPackageGenerationParameters();
         packageFilenameIllegalCharacters = factory.getConfiguration().getPackageFilenameIllegalCharacters();
         availableProjects = factory.getConfiguration().getAvailableProjects();
         showHome(true);
     }
-    
+
     /**
      * Switch to home.
+     *
      * @param clear Set to true if the fields on the home page should be cleared, false if not.
      */
     public void showHome(boolean clear) {
-        container.setTop((VBox)factory.getHeaderView());
+        container.setTop((VBox) factory.getHeaderView());
         currentPage = Page.HOMEPAGE;
         packageDescription = null;
         packageDescriptionFile = null;
@@ -112,8 +118,9 @@ public void showHome(boolean clear) {
      */
     private void clearPresenters() {
         factory.getHomepagePresenter().clear();
+        factory.getPackageMetadataPresenter().clear();
         factory.getCreateNewPackagePresenter().clear();
-        factory.getContentDirectoryPresenter().clear();
+        factory.getOpenExistingPackagePresenter().clear();
         factory.getPackageDescriptionPresenter().clear();
         factory.getPackageGenerationPresenter().clear();
     }
@@ -122,9 +129,19 @@ private void clearPresenters() {
      * Switch to homepage
      */
     private void showHomepage() {
+        previousPages.clear();
+        clearPresenters();
         show(factory.getHomepagePresenter());
     }
 
+    /**
+     * Switch to package metadata
+     */
+    private void showPackageMetadata() {
+        show(factory.getPackageMetadataPresenter());
+        factory.getPackageMetadataPresenter().setExistingValues();
+    }
+
     /**
      * Switch to creating package description.
      */
@@ -136,7 +153,14 @@ public void showCreatePackageDescription() {
      * Switch to the screen for selecting a content directory.
      */
     public void showSelectContentDirectory() {
-        show(factory.getContentDirectoryPresenter());
+        show(factory.getOpenExistingPackagePresenter());
+    }
+
+    /**
+     * Switch to the screen for selecting a package directory.
+     */
+    public void showSelectPackageDirectory() {
+        show(factory.getOpenExistingPackagePresenter());
     }
 
     /**
@@ -148,12 +172,13 @@ public Parent asParent() {
 
     /**
      * Shows the presenter and optionally clears the information
+     *
      * @param presenter The presenter to show
      */
     private void show(Presenter presenter) {
         container.setCenter(presenter.display());
     }
-    
+
     public void showGeneratePackage() {
         show(factory.getPackageGenerationPresenter());
     }
@@ -163,9 +188,10 @@ public PackageDescriptionPresenter showPackageDescriptionViewer() {
         show(presenter);
         return presenter;
     }
+
     /**
      * Pops up a dialog that waits for the user to choose a file.
-     * 
+     *
      * @param chooser the FileChooser
      * @return file chosen or null on cancel
      */
@@ -185,10 +211,11 @@ public File showOpenFileDialog(FileChooser chooser) {
             return null;
         }
     }
-    
-    /** Pops up a save file dialog.
-     * 
-     * @param chooser  the FileChooser
+
+    /**
+     * Pops up a save file dialog.
+     *
+     * @param chooser the FileChooser
      * @return File to save or null on cancel.
      */
     public File showSaveFileDialog(FileChooser chooser) {
@@ -209,6 +236,7 @@ public File showSaveFileDialog(FileChooser chooser) {
 
     /**
      * Pops up a dialog that waits for the user to choose a directory
+     *
      * @param chooser the DirectoryChooser
      * @return directory chosen or null on cancel
      */
@@ -227,35 +255,19 @@ public File showOpenDirectoryDialog(DirectoryChooser chooser) {
             return null;
         }
     }
-    
+
     private Semaphore getLock(Object exclusive) {
         locks.putIfAbsent(exclusive, new Semaphore(1));
         return locks.get(exclusive);
     }
-    
-    //Advances the application to the next page. Or redisplays the current page if it's the last page.
-    public void goToNextPage() {
-        Page nextPage = currentPage;
-        int currentPosition = currentPage.getPosition();
-        int nextPosition = Integer.MAX_VALUE;
-        for (Page pages : Page.values()) {
-            if (pages.getPosition() > currentPosition && pages.getPosition() < nextPosition && pages.isValidPage(this)) {
-                nextPosition = pages.getPosition();
-            }
-        }
-        
-        if (nextPosition < Integer.MAX_VALUE) {
-            Page pageForPosition = Page.getPageByPosition(nextPosition);
-            if (pageForPosition != null) {
-                nextPage = pageForPosition;
-            }
-        }
 
+    //Advances the application to the next page. Or redisplays the current page if it's the last page.
+    public void goToNextPage(Page nextPage) {
         previousPages.push(currentPage);
         currentPage = nextPage;
         showPage();
     }
-    
+
     //Returns the application to the previous page, or redisplays the current page if it's the first page. 
     public void goToPreviousPage() {
         if (previousPages != null && !previousPages.isEmpty()) {
@@ -264,20 +276,18 @@ public void goToPreviousPage() {
         }
     }
 
-    public void goToPage(Page page) {
-        currentPage = page;
-        showPage();
-    }
-    
     /**
-     * Shows the current page, a tells the presenter if it should clear it's information. 
+     * Shows the current page, a tells the presenter if it should clear it's information.
      */
     private void showPage() {
-        factory.getHeaderView().highlightNextPage(currentPage.getPosition());
+        factory.getHeaderView().highlightNextPage(currentPage);
         switch (currentPage) {
             case HOMEPAGE:
                 showHomepage();
                 break;
+            case PACKAGE_METADATA:
+                showPackageMetadata();
+                break;
             case CREATE_NEW_PACKAGE:
                 showCreatePackageDescription();
                 break;
@@ -290,25 +300,28 @@ private void showPage() {
             case SELECT_CONTENT_DIRECTORY:
                 showSelectContentDirectory();
                 break;
+            case SELECT_PACKAGE_DIRECTORY:
+                showSelectPackageDirectory();
+                break;
             default:
                 //There is no next page do nothing
                 break;
         }
     }
-    
+
     public void setPackageDescription(PackageDescription description) {
         this.packageDescription = description;
     }
-    
+
     public PackageDescription getPackageDescription() {
         return packageDescription;
     }
-    
-    public void setPackageDescriptionFile(File packageDescriptionFile){
+
+    public void setPackageDescriptionFile(File packageDescriptionFile) {
         this.packageDescriptionFile = packageDescriptionFile;
     }
 
-    public File getPackageDescriptionFile(){
+    public File getPackageDescriptionFile() {
         return packageDescriptionFile;
     }
 
@@ -320,17 +333,29 @@ public void setContentRoot(File contentRoot) {
         this.contentRoot = contentRoot;
     }
 
-    public File getRootArtifactDir() { return rootArtifactDir; }
+    public File getRootArtifactDir() {
+        return rootArtifactDir;
+    }
 
-    public void setRootArtifactDir(File rootArtifactDir) { this.rootArtifactDir = rootArtifactDir; }
+    public void setRootArtifactDir(File rootArtifactDir) {
+        this.rootArtifactDir = rootArtifactDir;
+    }
 
-    public String getPackageFilenameIllegalCharacters() { return packageFilenameIllegalCharacters; }
+    public String getPackageFilenameIllegalCharacters() {
+        return packageFilenameIllegalCharacters;
+    }
 
-    public void setPackageFilenameIllegalCharacters(String illegalCharacters) { this.packageFilenameIllegalCharacters = illegalCharacters;}
+    public void setPackageFilenameIllegalCharacters(String illegalCharacters) {
+        this.packageFilenameIllegalCharacters = illegalCharacters;
+    }
 
-    public String getAvailableProjects() { return availableProjects; }
+    public String getAvailableProjects() {
+        return availableProjects;
+    }
 
-    public void setAvailableProjects(String availableProjects) { this.availableProjects = availableProjects; }
+    public void setAvailableProjects(String availableProjects) {
+        this.availableProjects = availableProjects;
+    }
 
     public PackageState getPackageState() {
         return packageState;
@@ -351,14 +376,16 @@ public void setCrossPageProgressIndicatorPopUp(PackageToolPopup crossPageProgres
     public void setToolBuildNumber(String buildNumber) {
         toolVersion.setBuildNumber(buildNumber);
     }
+
     public void setToolBuildRevision(String buildRevision) {
         toolVersion.setBuildRevision(buildRevision);
     }
+
     public void setToolBuildTimestamp(String buildTimestamp) {
         toolVersion.setBuildTimeStamp(buildTimestamp);
     }
 
-    public String getDefaultPackageGenerationParametersFilePath () {
+    public String getDefaultPackageGenerationParametersFilePath() {
         return defaultPackageGenerationParametersFilePath;
     }
 }

dcs-packaging-tool/dcs-packaging-tool-gui/src/main/java/org/dataconservancy/packaging/gui/CssConstants.java

@@ -53,4 +53,8 @@ public interface CssConstants {
     public static final String UNEDITABLE_PROPERTY_VALUE = "UneditablePropertyValue";
     public static final String PROPERTY_TEXT_AREA = "PopertyTextArea";
     public static final String HOMEPAGE_VIEW_CLASS = "HomepageView";
+    public static final String HOMEPAGE_VIEW_BUTTON_CLASS = "HomepageViewButton";
+    public static final String CLICKABLE = "Clickable";
+    public static final String VBOX_BORDER = "VBoxBorder";
+    public static final String TRASH_IMAGE = "TrashImage";
 }

dcs-packaging-tool/dcs-packaging-tool-gui/src/main/java/org/dataconservancy/packaging/gui/Factory.java

@@ -22,7 +22,7 @@
 import javafx.stage.Stage;
 
 import org.dataconservancy.packaging.gui.presenter.*;
-import org.dataconservancy.packaging.gui.presenter.impl.SelectContentDirectoryPresenter;
+import org.dataconservancy.packaging.gui.presenter.impl.OpenExistingPackagePresenterImpl;
 import org.dataconservancy.packaging.gui.view.*;
 import org.dataconservancy.packaging.tool.api.PackageGenerationService;
 import org.dataconservancy.packaging.tool.api.generator.PackageAssembler;
@@ -59,8 +59,10 @@ public class Factory {
     private PackageDescriptionPresenter pkgDescriptionPresenter;
     private PackageDescriptionView pkgDescriptionView;
     private HeaderView headerView;
-    private SelectContentDirectoryPresenter contentDirectoryPresenter;
-    private SelectContentDirectoryView contentDirectoryView;
+    private OpenExistingPackagePresenterImpl openExistingPackagePresenter;
+    private OpenExistingPackageView openExistingPackageView;
+    private PackageMetadataPresenter packageMetadataPresenter;
+    private PackageMetadataView packageMetadataView;
 
     private Labels labels;
     private Messages messages;
@@ -144,9 +146,25 @@ private void initializeAssemblers() {
     public HeaderView getHeaderView() { return headerView; }
     public void setHeaderView(HeaderView headerView) { this.headerView = headerView; }
 
-    public SelectContentDirectoryPresenter getContentDirectoryPresenter() { return contentDirectoryPresenter; }
-    public void setContentDirectoryPresenter(SelectContentDirectoryPresenter presenter) {this.contentDirectoryPresenter = presenter; }
+    public OpenExistingPackagePresenterImpl getOpenExistingPackagePresenter() { return openExistingPackagePresenter; }
+    public void setOpenExistingPackagePresenter(OpenExistingPackagePresenterImpl presenter) {this.openExistingPackagePresenter = presenter; }
 
-    public SelectContentDirectoryView getContentDirectoryView() { return contentDirectoryView; }
-    public void setContentDirectoryView(SelectContentDirectoryView contentDirectoryView) { this.contentDirectoryView = contentDirectoryView; }
+    public OpenExistingPackageView getOpenExistingPackageView() { return openExistingPackageView; }
+    public void setOpenExistingPackageView(OpenExistingPackageView openExistingPackageView) { this.openExistingPackageView = openExistingPackageView; }
+
+    public PackageMetadataPresenter getPackageMetadataPresenter() {
+        return packageMetadataPresenter;
+    }
+
+    public void setPackageMetadataPresenter(PackageMetadataPresenter packageMetadataPresenter) {
+        this.packageMetadataPresenter = packageMetadataPresenter;
+    }
+
+    public PackageMetadataView getPackageMetadataView() {
+        return packageMetadataView;
+    }
+
+    public void setPackageMetadataView(PackageMetadataView packageMetadataView) {
+        this.packageMetadataView = packageMetadataView;
+    }
 }

dcs-packaging-tool/dcs-packaging-tool-gui/src/main/java/org/dataconservancy/packaging/gui/Help.java

@@ -37,6 +37,7 @@ public class Help {
     public enum HelpKey {
 
         HOMEPAGE_HELP("homepage.help"),
+        PACKAGE_METADATA_HELP("packagemetadata.help"),
         PACKAGE_GENERATION_HELP("packagegeneration.help"), 
         CREATE_NEW_PACKAGE_HELP("createnewpackage.help"), 
         PACKAGE_DESCRIPTION_HELP("packagedescription.help");

dcs-packaging-tool/dcs-packaging-tool-gui/src/main/java/org/dataconservancy/packaging/gui/Labels.java

@@ -125,8 +125,28 @@ public enum LabelKey {
         SHOW_IGNORED_TIP("showignored.tip"),
         CONTENT_DIRECTORY_LABEL("contentdirectory.label"),
         CREATE_NEW_PACKAGE("createnewpackage.label"),
-        OPEN_EXISTING_PACKAGE("openexistingpackage.label");
-
+        OPEN_EXISTING_PACKAGE("openexistingpackage.label"),
+        HOMEPAGE_PAGE("homepage.page"),
+        SELECT_DOMAIN_PROFILE_LABEL("selectdomainprofile.label"),
+        ADD_BUTTON("add.button"),
+        KEYWORD_LABEL("keyword.label"),
+        EXTERNAL_DESCRIPTION_LABEL("externaldescritption.label"),
+        INTERNAL_SENDER_IDENTIFIER_LABEL("internalsenderidentifier.label"),
+        INTERNAL_DESCRIPTION_LABEL("internaldescritption.label"),
+        SOURCE_ORGANIZATION_LABEL("sourceorganization.label"),
+        ORGANIZATION_ADDRESS_LABEL("organizatoinaddress.label"),
+        BAG_COUNT_LABEL("bagcount.label"),
+        BAG_GROUP_IDENTIFIER_LABEL("baggroupidentifier.label"),
+        RIGHTS_LABEL("rights.label"),
+        RIGHTS_URI_LABEL("rightsuri.label"),
+        BAGGING_DATE_LABEL("baggingdate.label"),
+        BAG_SIZE_LABEL("bagsize.label"),
+        PACKAGE_METADATA("packagemetadata.label"),
+        SERIALIZATION_FORMAT_LABEL("serialization.label"),
+        JSON_BUTTON("json.button"),
+        XML_BUTTON("xml.button"),
+        TURTLE_BUTTON("turtle.button"),
+        SELECT_PACKAGE_FILE_LABEL("selectpackagefile.label");
 
         private String property;