FileNameParameter.java

/*
 * Copyright 2006-2016 The MZmine 3 Development Team
 * 
 * This file is part of MZmine 3.
 * 
 * MZmine 3 is free software; you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 * 
 * MZmine 3 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with MZmine 3; if not,
 * write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 * USA
 */

package io.github.mzmine.parameters.parametertypes.filenames;

import java.io.File;
import java.util.List;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import com.google.common.base.Strings;

import io.github.mzmine.parameters.ParameterValidator;
import io.github.mzmine.parameters.parametertypes.AbstractParameter;
import javafx.stage.FileChooser;

public class FileNameParameter extends AbstractParameter<File> {

  public enum Type {
    OPEN, SAVE
  }

  private static final String fileNameElement = "filename";
  private static final String lastOpenPathElement = "lastdirectory";

  private final @Nullable List<FileChooser.ExtensionFilter> extensions;
  private final @Nonnull Type type;
  private File lastOpenPath;

  public FileNameParameter(@Nonnull String name, @Nonnull String description,
      @Nonnull String category, @Nonnull Type type) {
    this(name, description, category, null, type, null, null);
  }

  public FileNameParameter(@Nonnull String name, @Nonnull String description,
      @Nonnull String category, @Nullable ParameterValidator<File> validator, @Nonnull Type type) {
    this(name, description, category, validator, type, null, null);
  }

  public FileNameParameter(@Nonnull String name, @Nonnull String description,
      @Nonnull String category, @Nullable ParameterValidator<File> validator, @Nonnull Type type,
      @Nonnull List<FileChooser.ExtensionFilter> extensions) {
    this(name, description, category, validator, type, extensions, null);
  }

  public FileNameParameter(@Nonnull String name, @Nonnull String description,
      @Nonnull String category, @Nullable ParameterValidator<File> validator, @Nonnull Type type,
      @Nullable List<FileChooser.ExtensionFilter> extensions, File defaultValue) {
    super(name, description, category, FileNameEditor.class, validator);
    this.type = type;
    this.extensions = extensions;
    setValue(defaultValue);
  }

  public Type getFileNameParameterType() {
    return type;
  }

  @Override
  public @Nonnull FileNameParameter clone() {
    FileNameParameter copy = new FileNameParameter(getName(), getDescription(), getCategory(),
        getValidator(), type, extensions, getValue());
    return copy;
  }

  @Override
  public void loadValueFromXML(@Nonnull Element xmlElement) {
    NodeList list = xmlElement.getElementsByTagName(fileNameElement);
    for (int i = 0; i < list.getLength(); i++) {
      Element nextElement = (Element) list.item(i);
      String textValue = nextElement.getTextContent();
      if (!Strings.isNullOrEmpty(textValue))
        setValue(new File(textValue));
    }
    list = xmlElement.getElementsByTagName(lastOpenPathElement);
    for (int i = 0; i < list.getLength(); i++) {
      Element nextElement = (Element) list.item(i);
      lastOpenPath = new File(nextElement.getTextContent());
    }
  }

  @Override
  public void saveValueToXML(@Nonnull Element xmlElement) {
    final Document parentDocument = xmlElement.getOwnerDocument();
    final File value = getValue();
    if (value != null) {
      Element newElement = parentDocument.createElement(fileNameElement);
      newElement.setTextContent(value.getPath());
      xmlElement.appendChild(newElement);
    }
    if (lastOpenPath != null) {
      Element newElement = parentDocument.createElement(lastOpenPathElement);
      newElement.setTextContent(lastOpenPath.getPath());
      xmlElement.appendChild(newElement);
    }
  }

  public List<FileChooser.ExtensionFilter> getExtensions() {
    return extensions;
  }

  public File getLastOpenPath() {
    return lastOpenPath;
  }

  public void setLastOpenPath(File lastOpenPath) {
    this.lastOpenPath = lastOpenPath;
  };

}