/*
* org.openmicroscopy.shoola.env.data.views.calls.ObjectFinder
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2014 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;
//Java imports
//Third-party libraries
//Application-internal dependencies
import org.openmicroscopy.shoola.env.data.OmeroDataService;
import omero.gateway.SecurityContext;
import omero.gateway.model.SearchParameters;
import org.openmicroscopy.shoola.env.data.views.BatchCall;
import org.openmicroscopy.shoola.env.data.views.BatchCallTree;
/**
* Searches for objects.
*
* @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
* <small>
* (<b>Internal version:</b> $Revision: $Date: $)
* </small>
* @since OME3.0
*/
public class ObjectFinder
extends BatchCallTree
{
/** The root nodes of the found trees. */
private Object result;
/** The search call. */
private BatchCall loadCall;
/** The security context.*/
private SecurityContext ctx;
/** The context of the search.*/
private SearchParameters searchContext;
/**
* Adds the {@link #loadCall} to the computation tree.
* @see BatchCallTree#buildTree()
*/
protected void buildTree()
{
loadCall = new BatchCall("Searching") {
public void doCall() throws Exception
{
OmeroDataService os = context.getDataService();
result = os.search(ctx, searchContext);
}
};
add(loadCall);
}
/**
* Returns the server call-handle to the computation.
*
* @return See above.
*/
protected Object getPartialResult() { return null; }
/**
* Returns the result of the search.
* @see BatchCallTree#getResult()
*/
protected Object getResult() { return result; }
/**
* Creates a new instance.
*
* @param ctx The security context.
* @param searchContext The context of the search.
*/
public ObjectFinder(SecurityContext ctx, SearchParameters searchContext)
{
this.ctx = ctx;
this.searchContext = searchContext;
}
}