/*
*------------------------------------------------------------------------------
* Copyright (C) 2006 University of Dundee. All rights reserved.
*
*
* This program 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.
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.env.data.views.calls;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import org.openmicroscopy.shoola.env.data.AdminService;
import org.openmicroscopy.shoola.env.data.OmeroDataService;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.BatchCall;
import org.openmicroscopy.shoola.env.data.views.BatchCallTree;
import omero.gateway.model.DataObject;
import omero.gateway.model.GroupData;
/**
* Command to save existing <code>DataObject</code>s.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* @since OME2.2
*/
public class ExistingObjectsSaver
extends BatchCallTree
{
/** Loads the specified tree. */
private BatchCall call;
/** The result of the save action. */
private Object result;
/** The security context.*/
private SecurityContext ctx;
/**
* Creates a {@link BatchCall} to add the given children to the
* specified parent.
*
* @param parent The <code>DataObject</code>s to update. Either a
* <code>ProjectData</code> or <code>DatasetData</code>.
* @param children The items to add.
* @param admin Pass <code>true</code> to indicate to handle
* experimenters, <code>false</code> otherwise.
* @return The {@link BatchCall}.
*/
private BatchCall makeBatchCall(final Collection parent,
final Collection children, final boolean admin)
{
return new BatchCall("Loading container tree: ") {
public void doCall() throws Exception
{
OmeroDataService os = context.getDataService();
Iterator i = parent.iterator();
Object obj;
while (i.hasNext()) {
obj = i.next();
if (obj instanceof DataObject) {
os.addExistingObjects(ctx, (DataObject) obj, children);
}
}
result = parent;
}
};
}
/**
* Creates a {@link BatchCall} to add the given children to the
* specified parent.
*
* @param toPaste The <code>DataObjects</code> to update.
* @return The {@link BatchCall}.
*/
private BatchCall makeBatchCall(final Map toPaste)
{
return new BatchCall("Copy and paste: ") {
public void doCall() throws Exception
{
AdminService as = context.getAdminService();
OmeroDataService os = context.getDataService();
Iterator i = toPaste.entrySet().iterator();
Object p;
Entry entry;
while (i.hasNext()) {
entry = (Entry) i.next();
p = entry.getKey();
if (p instanceof GroupData) {
as.copyExperimenters(ctx, (GroupData) p, (Collection)
entry.getValue());
} else {
if (p instanceof DataObject) {
os.addExistingObjects(ctx,
(DataObject) p, (Collection) entry.getValue());
}
}
}
result = toPaste;
}
};
}
/**
* Creates a {@link BatchCall} to add the given children to the
* specified parent.
*
* @param toPaste The <code>DataObjects</code> to update.
* @param toRemove The <code>DataObjects</code> to remove.
* @param admin Pass <code>true</code> to indicate to handle
* experimenters, <code>false</code> otherwise.
* @return The {@link BatchCall}.
*/
private BatchCall makeBatchCall(final Map toPaste, final Map toRemove,
final boolean admin)
{
return new BatchCall("Cut and paste: ") {
public void doCall() throws Exception
{
if (admin) {
AdminService as = context.getAdminService();
as.cutAndPasteExperimenters(ctx, toPaste, toRemove);
result = toPaste;
} else {
OmeroDataService os = context.getDataService();
os.cutAndPaste(ctx, toPaste, toRemove);
result = toPaste;
}
}
};
}
/**
* Adds the {@link #call} to the computation tree.
*
* @see BatchCallTree#buildTree()
*/
protected void buildTree() { add(call); }
/**
* Returns the found objects.
*
* @see BatchCallTree#getResult()
*/
protected Object getResult() { return result; }
/**
* Creates a new instance.
* If bad arguments are passed, we throw a runtime
* exception so to fail early and in the caller's thread.
*
* @param ctx The security context.
* @param parent The <code>DataObject</code> to update. Either a
* <code>ProjectData</code> or <code>DatasetData</code>.
* @param children The items to add.
*/
public ExistingObjectsSaver(SecurityContext ctx, Collection parent,
Collection children, boolean admin)
{
if (children == null || children.size() == 0)
throw new IllegalArgumentException("No item to add.");
if (parent == null)
throw new IllegalArgumentException("No parent to update.");
this.ctx = ctx;
call = makeBatchCall(parent, children, admin);
}
/**
* Creates a new instance.
* If bad arguments are passed, we throw a runtime
* exception so to fail early and in the caller's thread.
*
* @param ctx The security context.
* @param toPaste The <code>DataObject</code>s to update.
* @param toRemove The <code>DataObject</code>s to cut.
* @param admin Pass <code>true</code> to indicate to handle
* experimenters, <code>false</code> otherwise.
*/
public ExistingObjectsSaver(SecurityContext ctx, Map toPaste, Map toRemove,
boolean admin)
{
this.ctx = ctx;
if (toPaste == null) toPaste = new HashMap();
if (toRemove == null) call = makeBatchCall(toPaste);
else call = makeBatchCall(toPaste, toRemove, admin);
}
}