omero.gateway.model

Class SearchParameters

java.lang.Object

omero.gateway.model.SearchParameters

public class SearchParameters
extends Object

Holds all parameters needed to perform a search operation; See SearchFacility.search(omero.gateway.SecurityContext, SearchParameters)

Since:

5.0

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_GROUPS_ID The ID for searching across all groups
static Set<SearchScope>	ALL_SCOPE
static List<Class<? extends DataObject>>	ALL_TYPES
static int	DATE_ACQUISITION Indicates that the date has to be interpreted as acquisition date
static int	DATE_IMPORT Indicates that the date has to be interpreted as import date

Constructor Summary

Constructors

Constructor and Description
SearchParameters(Set<SearchScope> scope, List<Class<? extends DataObject>> types, String query) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	getDateType()
Timestamp	getEnd() Returns the upper bound of the time interval.
long	getGroupId()
String	getQuery() Returns the query terms to search for
Set<SearchScope>	getScope() Returns the scope of the search.
Timestamp	getStart() Returns the lower bound of the time interval.
List<Class<? extends DataObject>>	getTypes() Returns the types to search on.
long	getUserId()
boolean	hasTextToSearch() Returns true if text to search for, false otherwise.
boolean	isValid() Returns true if the context of the search is valid i.e.
void	setDateType(int dateType)
void	setGroupId(long groupId)
void	setTimeInterval(Timestamp start, Timestamp end, int type) Sets the time interval.
void	setUserId(long userId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_GROUPS_ID

public static final int ALL_GROUPS_ID

The ID for searching across all groups

See Also:

Constant Field Values

DATE_IMPORT

public static final int DATE_IMPORT

Indicates that the date has to be interpreted as import date

See Also:

Constant Field Values

DATE_ACQUISITION

public static final int DATE_ACQUISITION

Indicates that the date has to be interpreted as acquisition date

See Also:

Constant Field Values

ALL_SCOPE

public static final Set<SearchScope> ALL_SCOPE

ALL_TYPES

public static final List<Class<? extends DataObject>> ALL_TYPES

Constructor Detail

SearchParameters

public SearchParameters(Set<SearchScope> scope,
                        List<Class<? extends DataObject>> types,
                        String query)

Creates a new instance.

Parameters:

scope - Scope of the search

types - The types to search on, i.e. project, dataset, image.

query - The terms to search for.

Method Detail

setTimeInterval

public void setTimeInterval(Timestamp start,
                            Timestamp end,
                            int type)

Sets the time interval.

Parameters:

start - The lower bound of the time interval.

end - The upper bound of the time interval.

type - The type of date.

getStart

public Timestamp getStart()

Returns the lower bound of the time interval.

Returns:

See above.

getEnd

public Timestamp getEnd()

Returns the upper bound of the time interval.

Returns:

See above.

getScope

public Set<SearchScope> getScope()

Returns the scope of the search.

Returns:

See above.

getTypes

public List<Class<? extends DataObject>> getTypes()

Returns the types to search on.

Returns:

See above.

getQuery

public String getQuery()

Returns the query terms to search for

Returns:

See above.

isValid

public boolean isValid()

Returns true if the context of the search is valid i.e. parameters correctly set, false otherwise.

Returns:

See above.

hasTextToSearch

public boolean hasTextToSearch()

Returns true if text to search for, false otherwise.

Returns:

See above.

getUserId

public long getUserId()

setUserId

public void setUserId(long userId)

getDateType

public int getDateType()

setDateType

public void setDateType(int dateType)

getGroupId

public long getGroupId()

setGroupId

public void setGroupId(long groupId)