/*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2008 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 org.openmicroscopy.shoola.env.data.OmeroMetadataService;
import omero.gateway.SecurityContext;
import org.openmicroscopy.shoola.env.data.views.BatchCall;
import org.openmicroscopy.shoola.env.data.views.BatchCallTree;
import org.openmicroscopy.shoola.env.rnd.RenderingControl;
import omero.gateway.model.ImageData;
/**
* Loads the acquisition metadata for an image or a given channel.
*
* @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 3.0-Beta4
*/
public class AcquisitionDataLoader
extends BatchCallTree
{
/** Indicates to load the instrument's data. */
public static final int INSTRUMENT = 0;
/** Indicates to load the image's data. */
public static final int IMAGE = 1;
/** Result of the call. */
private Object result;
/** Loads the specified tree. */
private BatchCall loadCall;
/**
* Creates a {@link BatchCall} to retrieve the acquisition data linked
* to the passed object.
*
* @param ctx The security context.
* @param refObject Either an <code>ImageData</code> or
* <code>ChannelData</code> node.
* @return The {@link BatchCall}.
*/
private BatchCall makeBatchCall(final SecurityContext ctx,
final Object refObject)
{
return new BatchCall("Loading Acquisition data: ") {
public void doCall() throws Exception
{
OmeroMetadataService svc = context.getMetadataService();
result = svc.loadAcquisitionData(ctx, refObject);
}
};
}
/**
* Creates a {@link BatchCall} to retrieve the components of the passed
* instrument.
*
* @param ctx The security context.
* @param id The id of the instrument.
* @return The {@link BatchCall}.
*/
private BatchCall makeInstrumentBatchCall(final SecurityContext ctx,
final long id)
{
return new BatchCall("Loading Instrument data: ") {
public void doCall() throws Exception
{
OmeroMetadataService svc = context.getMetadataService();
result = svc.loadInstrument(ctx, id);
}
};
}
/**
* Adds the {@link #loadCall} to the computation tree.
*
* @see BatchCallTree#buildTree()
*/
protected void buildTree() { add(loadCall); }
/**
* Returns the {@link RenderingControl}.
*
* @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 refObject Either an <code>ImageData</code> or
* <code>ChannelData</code> node.
*/
public AcquisitionDataLoader(SecurityContext ctx, Object refObject)
{
if (refObject == null)
throw new IllegalArgumentException("Ref Object cannot be null.");
loadCall = makeBatchCall(ctx, refObject);
}
/**
* 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 type One of the constants defined by this class.
* @param id The id of the object corresponding to the passed type.
*/
public AcquisitionDataLoader(SecurityContext ctx, int type, long id)
{
if (id <= 0)
throw new IllegalArgumentException("Id not valid.");
switch (type) {
case INSTRUMENT:
loadCall = makeInstrumentBatchCall(ctx, id);
break;
case IMAGE:
ImageData img = new ImageData();
img.setId(id);
loadCall = makeBatchCall(ctx, img);
break;
default:
throw new IllegalArgumentException("Type not supported");
}
}
}