/*
* RapidMiner
*
* Copyright (C) 2001-2011 by Rapid-I and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapid-i.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.gui.tools;
import com.rapidminer.gui.tools.dialogs.ConfirmDialog;
import com.rapidminer.repository.BlobEntry;
import com.rapidminer.repository.Entry;
import com.rapidminer.repository.Folder;
import com.rapidminer.repository.MalformedRepositoryLocationException;
import com.rapidminer.repository.RepositoryException;
import com.rapidminer.repository.RepositoryLocation;
import com.rapidminer.repository.RepositoryManager;
import com.rapidminer.repository.gui.RepositoryLocationChooser;
/**
* A class that presents helper methods for interacting with the repository.
*
* @author Sebastian Land
*/
public class RepositoryGuiTools {
/**
* This method will return an {@link Entry} if the given location
* is a valid repository location. If the entry already exists,
* the user will be asked if it can be overwritten.
* Null is returned if the user denies to overwrite the existing file.
*/
public static BlobEntry createBlobEntry(String loc) {
try {
RepositoryLocation location = new RepositoryLocation(loc);
Entry entry = location.locateEntry();
if (entry != null) {
if (entry instanceof BlobEntry) {
if (SwingTools.showConfirmDialog("overwrite_entry_different_type", ConfirmDialog.YES_NO_OPTION, entry.getLocation()) == ConfirmDialog.YES_OPTION) {
return (BlobEntry) entry;
}
} else {
if (SwingTools.showConfirmDialog("overwrite_entry", ConfirmDialog.YES_NO_OPTION, entry.getLocation()) == ConfirmDialog.YES_OPTION) {
Folder folder = entry.getContainingFolder();
String name = entry.getName();
entry.delete();
return folder.createBlobEntry(name);
}
}
}
return RepositoryManager.getInstance(null).getOrCreateBlob(location);
} catch (MalformedRepositoryLocationException e) {
SwingTools.showSimpleErrorMessage("cannot_access_repository", e);
} catch (RepositoryException e) {
SwingTools.showSimpleErrorMessage("cannot_access_repository", e);
}
return null;
}
/**
* This method will show an Repository Entry chooser and returns the entry if
* the user has chosen an unused entry or confirmed to overwrite the existing. Otherwise null is
* returned.
*/
public static BlobEntry selectBlobEntryForStoring() {
String selectEntry = RepositoryLocationChooser.selectEntry(null, null);
return createBlobEntry(selectEntry);
}
/**
* This method will show an Repository Entry chooser and lets the user choose
* an entry. This entry must be of the type {@link BlobEntry}, otherwise an
* error message is shown. If the user aborts the selection, null is returned.
*
* TODO: Needs to add filter mechanism to {@link RepositoryLocationChooser} to restrict
* shown types to {@link BlobEntry}s.
*/
public static BlobEntry selectBlobEntryForLoading(String mimeType) {
String locationString = RepositoryLocationChooser.selectEntry(null, null);
if (locationString != null) {
RepositoryLocation location;
try {
location = new RepositoryLocation(locationString);
Entry entry = location.locateEntry();
if (entry instanceof BlobEntry) {
BlobEntry blobEntry = (BlobEntry) entry;
if (mimeType.equals(blobEntry.getMimeType())) {
return blobEntry;
} else {
SwingTools.showSimpleErrorMessage("entry_must_be_blob", blobEntry.getName());
return selectBlobEntryForLoading(mimeType);
}
} else {
SwingTools.showSimpleErrorMessage("entry_must_be_blob", entry.getName());
return selectBlobEntryForLoading(mimeType);
}
} catch (MalformedRepositoryLocationException e) {
SwingTools.showSimpleErrorMessage("cannot_access_repository", e);
} catch (RepositoryException e) {
SwingTools.showSimpleErrorMessage("cannot_access_repository", e);
}
}
return null;
}
/**
* This method will check if the given location is either empty or is an BlobEntry of the given mimeType.
* If neither is the case, null will be returned. Otherwise the BlobEntry denoting this location will be returned.
*/
public static BlobEntry isBlobEntryForStoring(String repositoryLocation, String mimeType) {
RepositoryLocation location;
try {
location = new RepositoryLocation(repositoryLocation);
Entry entry = location.locateEntry();
if (entry instanceof BlobEntry) {
BlobEntry blobEntry = (BlobEntry) entry;
if (mimeType.equals(blobEntry.getMimeType())) {
return blobEntry;
} else {
SwingTools.showSimpleErrorMessage("entry_must_be_blob", blobEntry.getName());
return null;
}
} else if (entry == null) {
return createBlobEntry(repositoryLocation);
} else {
SwingTools.showSimpleErrorMessage("entry_must_be_blob", entry.getName());
}
} catch (RepositoryException e) {
SwingTools.showSimpleErrorMessage("cannot_access_repository", e);
} catch (MalformedRepositoryLocationException e) {
SwingTools.showSimpleErrorMessage("cannot_access_repository", e);
}
return null;
}
}