omero.api

Interface Search

All Superinterfaces:

_SearchOperations, _SearchOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, Ice.Object, ServiceInterface, StatefulServiceInterface

All Known Implementing Classes:

_SearchDisp, _SearchTie

public interface Search
extends Ice.Object, _SearchOperations, _SearchOperationsNC, StatefulServiceInterface

Central search interface, allowing Web2.0 style queries. Each Search instance keeps up with several queries and lazily-loads the results as hasNext, next and results are called. These queries are created by the by* methods. Each instance also has a number of settings which can all be changed from their defaults via accessors, e.g. setBatchSize or setCaseSensitive. The only methods which are required for the proper functioning of a Search instance are:

• onlyType, onlyTypes OR allTypes
• Any by* method to create a query

Use of the allTypes method is discouraged, since it is possibly very resource intensive, which is why any attempt to receive results without specifically setting types or allowing all is prohibited.

See Also:

IQuery

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ice_staticId
static long	serialVersionUID

Method Summary

Methods inherited from interface omero.api._SearchOperations

activeQueries_async, addOrderByAsc_async, addOrderByDesc_async, allTypes_async, and_async, byAnnotatedWith_async, byFullText_async, byGroupForTags_async, byHqlQuery_async, byLuceneQueryBuilder_async, bySimilarTerms_async, bySomeMustNone_async, byTagForGroups_async, clearQueries_async, currentMetadata_async, currentMetadataList_async, fetchAlso_async, fetchAnnotations_async, getBatchSize_async, hasNext_async, isAllowLeadingWildcard_async, isCaseSensitive_async, isMergedBatches_async, isReturnUnloaded_async, isUseProjections_async, next_async, not_async, notAnnotatedBy_async, notOwnedBy_async, onlyAnnotatedBetween_async, onlyAnnotatedBy_async, onlyAnnotatedWith_async, onlyCreatedBetween_async, onlyIds_async, onlyModifiedBetween_async, onlyOwnedBy_async, onlyType_async, onlyTypes_async, or_async, remove_async, resetDefaults_async, results_async, setAllowLeadingWildcard_async, setBatchSize_async, setCaseSensitive_async, setCaseSentivice_async, setMergedBatches_async, setReturnUnloaded_async, setUseProjections_async, unordered_async

Methods inherited from interface omero.api._SearchOperationsNC

activeQueries_async, addOrderByAsc_async, addOrderByDesc_async, allTypes_async, and_async, byAnnotatedWith_async, byFullText_async, byGroupForTags_async, byHqlQuery_async, byLuceneQueryBuilder_async, bySimilarTerms_async, bySomeMustNone_async, byTagForGroups_async, clearQueries_async, currentMetadata_async, currentMetadataList_async, fetchAlso_async, fetchAnnotations_async, getBatchSize_async, hasNext_async, isAllowLeadingWildcard_async, isCaseSensitive_async, isMergedBatches_async, isReturnUnloaded_async, isUseProjections_async, next_async, not_async, notAnnotatedBy_async, notOwnedBy_async, onlyAnnotatedBetween_async, onlyAnnotatedBy_async, onlyAnnotatedWith_async, onlyCreatedBetween_async, onlyIds_async, onlyModifiedBetween_async, onlyOwnedBy_async, onlyType_async, onlyTypes_async, or_async, remove_async, resetDefaults_async, results_async, setAllowLeadingWildcard_async, setBatchSize_async, setCaseSensitive_async, setCaseSentivice_async, setMergedBatches_async, setReturnUnloaded_async, setUseProjections_async, unordered_async

Methods inherited from interface omero.api._StatefulServiceInterfaceOperations

activate_async, close_async, getCurrentEventContext_async, passivate_async

Methods inherited from interface omero.api._StatefulServiceInterfaceOperationsNC

activate_async, close_async, getCurrentEventContext_async, passivate_async

Methods inherited from interface Ice.Object

__dispatch, __read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

ice_staticId

static final java.lang.String ice_staticId

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values