omero.api

Class _SearchTie

java.lang.Object

Ice.ObjectImpl

omero.api._SearchDisp

omero.api._SearchTie

All Implemented Interfaces:

Ice.Object, Ice.TieBase, java.io.Serializable, java.lang.Cloneable, _SearchOperations, _SearchOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, Search, ServiceInterface, StatefulServiceInterface

public class _SearchTie
extends _SearchDisp
implements Ice.TieBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class omero.api._SearchDisp

__ids

Fields inherited from interface omero.api.Search

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_SearchTie(_SearchOperations delegate)
_SearchTie()

Method Summary

Modifier and Type	Method and Description
void	activate_async(AMD_StatefulServiceInterface_activate __cb, Ice.Current __current) Load a service implementation from disk if it was previously passivated.
void	activeQueries_async(AMD_Search_activeQueries __cb, Ice.Current __current) Returns the number of active queries.
void	addOrderByAsc_async(AMD_Search_addOrderByAsc __cb, java.lang.String path, Ice.Current __current) A path from the target entity which will be added to the current stack of order statements applied to the query.
void	addOrderByDesc_async(AMD_Search_addOrderByDesc __cb, java.lang.String path, Ice.Current __current) A path from the target entity which will be added to the current stack of order statements applied to the query.
void	allTypes_async(AMD_Search_allTypes __cb, Ice.Current __current) Permits all types to be returned.
void	and_async(AMD_Search_and __cb, Ice.Current __current) Applies the next by* method to the previous by* method, so that a call hasNext, next, or results sees only the intersection of the two calls.
void	byAnnotatedWith_async(AMD_Search_byAnnotatedWith __cb, java.util.List<Annotation> examples, Ice.Current __current) Finds entities annotated with an Annotation similar to the example.
void	byFullText_async(AMD_Search_byFullText __cb, java.lang.String query, Ice.Current __current) Passes the query as is to the Lucene backend.
void	byGroupForTags_async(AMD_Search_byGroupForTags __cb, java.lang.String group, Ice.Current __current) Returns transient (without ID) TagAnnotation instances which represent all the TagAnnotation tags in the given group.
void	byHqlQuery_async(AMD_Search_byHqlQuery __cb, java.lang.String query, Parameters params, Ice.Current __current) Delegates to omero.api.IQuery.findAllByQuery method to take advantage of the and, or, and not methods, or queue-semantics.
void	byLuceneQueryBuilder_async(AMD_Search_byLuceneQueryBuilder __cb, java.lang.String fields, java.lang.String from, java.lang.String to, java.lang.String dateType, java.lang.String query, Ice.Current __current) Builds a Lucene query and passes it to the Lucene backend.
void	bySimilarTerms_async(AMD_Search_bySimilarTerms __cb, java.util.List<java.lang.String> terms, Ice.Current __current) Returns transient (without ID) TextAnnotation instances which represent terms which are similar to the given terms.
void	bySomeMustNone_async(AMD_Search_bySomeMustNone __cb, java.util.List<java.lang.String> some, java.util.List<java.lang.String> must, java.util.List<java.lang.String> none, Ice.Current __current) Builds a Lucene query and passes it to byFullText.
void	byTagForGroups_async(AMD_Search_byTagForGroups __cb, java.lang.String tag, Ice.Current __current) Creates a query which will return transient (without ID) TagAnnotation instances which represent all the TagAnnotation tag groups which the given tag belongs to.
void	clearQueries_async(AMD_Search_clearQueries __cb, Ice.Current __current) Removes all active queries (leaving resetDefaults settings alone), such that activeQueries will return 0.
void	close_async(AMD_StatefulServiceInterface_close __cb, Ice.Current __current) Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.
void	currentMetadata_async(AMD_Search_currentMetadata __cb, Ice.Current __current) Provides access to the extra query information (for example Lucene score and boost values) for a single call to next.
void	currentMetadataList_async(AMD_Search_currentMetadataList __cb, Ice.Current __current) Provides access to the extra query information (for example Lucene score and boost values) for a single call to results.
boolean	equals(java.lang.Object rhs)
void	fetchAlso_async(AMD_Search_fetchAlso __cb, java.util.List<java.lang.String> fetches, Ice.Current __current) Adds a fetch clause for loading non-annotation fields of returned entities.
void	fetchAnnotations_async(AMD_Search_fetchAnnotations __cb, java.util.List<java.lang.String> classes, Ice.Current __current) Queries the database for all Annotation annotations of the given types for all returned instances.
void	getBatchSize_async(AMD_Search_getBatchSize __cb, Ice.Current __current) Returns the current batch size.
void	getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb, Ice.Current __current) To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.
int	hashCode()
void	hasNext_async(AMD_Search_hasNext __cb, Ice.Current __current) Returns true if another call to next is valid.
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
void	isAllowLeadingWildcard_async(AMD_Search_isAllowLeadingWildcard __cb, Ice.Current __current) Returns the current leading-wildcard setting.
void	isCaseSensitive_async(AMD_Search_isCaseSensitive __cb, Ice.Current __current) Returns the current case sensitivity setting.
void	isMergedBatches_async(AMD_Search_isMergedBatches __cb, Ice.Current __current) Returns the current merged-batches setting.
void	isReturnUnloaded_async(AMD_Search_isReturnUnloaded __cb, Ice.Current __current) Returns the current return-unloaded setting.
void	isUseProjections_async(AMD_Search_isUseProjections __cb, Ice.Current __current) Returns the current use-projection setting.
void	next_async(AMD_Search_next __cb, Ice.Current __current) Returns the next entity from the current query.
void	not_async(AMD_Search_not __cb, Ice.Current __current) Applies the next by* method to the previous by* method, so that a call hasNext, next, or results sees only the intersection of the two calls.
void	notAnnotatedBy_async(AMD_Search_notAnnotatedBy __cb, Details d, Ice.Current __current) Restricts entities by who has not annotated them with an Annotation matching the other filters.
void	notOwnedBy_async(AMD_Search_notOwnedBy __cb, Details d, Ice.Current __current) Uses the Details.getOwner() and Details.getGroup() information to restrict the entities which will be returned.
void	onlyAnnotatedBetween_async(AMD_Search_onlyAnnotatedBetween __cb, RTime start, RTime stop, Ice.Current __current) Restricts entities by the time in which any annotation (which matches the other filters) was added them.
void	onlyAnnotatedBy_async(AMD_Search_onlyAnnotatedBy __cb, Details d, Ice.Current __current) Restricts entities by who has annotated them with an Annotation matching the other filters.
void	onlyAnnotatedWith_async(AMD_Search_onlyAnnotatedWith __cb, java.util.List<java.lang.String> classes, Ice.Current __current) Restricts entities to having an Annotation of all the given types.
void	onlyCreatedBetween_async(AMD_Search_onlyCreatedBetween __cb, RTime start, RTime stop, Ice.Current __current) Restricts the time between which an entity may have been created.
void	onlyIds_async(AMD_Search_onlyIds __cb, java.util.List<java.lang.Long> ids, Ice.Current __current) Restricts the set of ids which will be checked.
void	onlyModifiedBetween_async(AMD_Search_onlyModifiedBetween __cb, RTime start, RTime stop, Ice.Current __current) Restricts the time between which an entity may have last been modified.
void	onlyOwnedBy_async(AMD_Search_onlyOwnedBy __cb, Details d, Ice.Current __current) Uses the Details.getOwner() and Details.getGroup() information to restrict the entities which will be returned.
void	onlyType_async(AMD_Search_onlyType __cb, java.lang.String klass, Ice.Current __current) Restricts the search to a single type.
void	onlyTypes_async(AMD_Search_onlyTypes __cb, java.util.List<java.lang.String> classes, Ice.Current __current) Restricts searches to a set of types.
void	or_async(AMD_Search_or __cb, Ice.Current __current) Applies the next by* method to the previous by* method, so that a call hasNext, next or results sees only the union of the two calls.
void	passivate_async(AMD_StatefulServiceInterface_passivate __cb, Ice.Current __current) Causes the blitz server to store the service implementation to disk to free memory.
void	remove_async(AMD_Search_remove __cb, Ice.Current __current) Unsupported operation.
void	resetDefaults_async(AMD_Search_resetDefaults __cb, Ice.Current __current) Resets all settings (non-query state) to the original default values, as if the instance had just be created.
void	results_async(AMD_Search_results __cb, Ice.Current __current) Returns up to getBatchSize batch size number of results along with the related query metadata.
void	setAllowLeadingWildcard_async(AMD_Search_setAllowLeadingWildcard __cb, boolean allowLeadingWildcard, Ice.Current __current) Permits full-text queries with a leading query if true.
void	setBatchSize_async(AMD_Search_setBatchSize __cb, int size, Ice.Current __current) Sets the maximum number of results that will be returned by one call to results.
void	setCaseSensitive_async(AMD_Search_setCaseSensitive __cb, boolean caseSensitive, Ice.Current __current) Sets the case sensitivity on all queries where case-sensitivity is supported.
void	setCaseSentivice_async(AMD_Search_setCaseSentivice __cb, boolean caseSensitive, Ice.Current __current) Deprecated.
void	setMergedBatches_async(AMD_Search_setMergedBatches __cb, boolean merge, Ice.Current __current) Set whether or not results from two separate queries can be returned in the same call to results.
void	setReturnUnloaded_async(AMD_Search_setReturnUnloaded __cb, boolean returnUnloaded, Ice.Current __current) Determines if all results should be returned as unloaded objects.
void	setUseProjections_async(AMD_Search_setUseProjections __cb, boolean useProjections, Ice.Current __current) Determines if Lucene queries should not hit the database.
void	unordered_async(AMD_Search_unordered __cb, Ice.Current __current) Removes the current stack of order statements.

Methods inherited from class omero.api._SearchDisp

___activeQueries, ___addOrderByAsc, ___addOrderByDesc, ___allTypes, ___and, ___byAnnotatedWith, ___byFullText, ___byGroupForTags, ___byHqlQuery, ___byLuceneQueryBuilder, ___bySimilarTerms, ___bySomeMustNone, ___byTagForGroups, ___clearQueries, ___currentMetadata, ___currentMetadataList, ___fetchAlso, ___fetchAnnotations, ___getBatchSize, ___hasNext, ___isAllowLeadingWildcard, ___isCaseSensitive, ___isMergedBatches, ___isReturnUnloaded, ___isUseProjections, ___next, ___not, ___notAnnotatedBy, ___notOwnedBy, ___onlyAnnotatedBetween, ___onlyAnnotatedBy, ___onlyAnnotatedWith, ___onlyCreatedBetween, ___onlyIds, ___onlyModifiedBetween, ___onlyOwnedBy, ___onlyType, ___onlyTypes, ___or, ___remove, ___resetDefaults, ___results, ___setAllowLeadingWildcard, ___setBatchSize, ___setCaseSensitive, ___setCaseSentivice, ___setMergedBatches, ___setReturnUnloaded, ___setUseProjections, ___unordered, __dispatch, __readImpl, __writeImpl, activate_async, 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, close_async, currentMetadata_async, currentMetadataList_async, fetchAlso_async, fetchAnnotations_async, getBatchSize_async, getCurrentEventContext_async, hasNext_async, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, 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, passivate_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 class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_SearchTie

public _SearchTie()

_SearchTie

public _SearchTie(_SearchOperations delegate)

Method Detail

ice_delegate

public java.lang.Object ice_delegate()

Specified by:

ice_delegate in interface Ice.TieBase

ice_delegate

public void ice_delegate(java.lang.Object delegate)

Specified by:

ice_delegate in interface Ice.TieBase

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

activeQueries_async

public void activeQueries_async(AMD_Search_activeQueries __cb,
                                Ice.Current __current)
                         throws ServerError

Description copied from interface: _SearchOperations

Returns the number of active queries. This means that activeQueries gives the minimum number of remaining calls to results when batches are not merged.

Specified by:

activeQueries_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

addOrderByAsc_async

public void addOrderByAsc_async(AMD_Search_addOrderByAsc __cb,
                                java.lang.String path,
                                Ice.Current __current)
                         throws ServerError

Description copied from interface: _SearchOperations

A path from the target entity which will be added to the current stack of order statements applied to the query.

Specified by:

addOrderByAsc_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

path - Non-null.

__current - The Current object for the invocation.

Throws:

ServerError

addOrderByDesc_async

public void addOrderByDesc_async(AMD_Search_addOrderByDesc __cb,
                                 java.lang.String path,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _SearchOperations

A path from the target entity which will be added to the current stack of order statements applied to the query.

Specified by:

addOrderByDesc_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

path - Non-null.

__current - The Current object for the invocation.

Throws:

ServerError

allTypes_async

public void allTypes_async(AMD_Search_allTypes __cb,
                           Ice.Current __current)
                    throws ServerError

Description copied from interface: _SearchOperations

Permits all types to be returned. For some types of queries, this carries a performance penalty as every database table must be hit.

Specified by:

allTypes_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

and_async

public void and_async(AMD_Search_and __cb,
                      Ice.Current __current)
               throws ServerError

Description copied from interface: _SearchOperations

Applies the next by* method to the previous by* method, so that a call hasNext, next, or results sees only the intersection of the two calls. For example,

 
 service.onlyType(Image.class);
 service.byFullText("foo");
 service.intersection();
 service.byAnnotatedWith(TagAnnotation.class);
 
 

will return only the Images with TagAnnotations.

Calling this method overrides a previous setting of or or not. If there is no active queries (i.e. activeQueries > 0), then an ApiUsageException will be thrown.

Specified by:

and_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

byAnnotatedWith_async

public void byAnnotatedWith_async(AMD_Search_byAnnotatedWith __cb,
                                  java.util.List<Annotation> examples,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _SearchOperations

Finds entities annotated with an Annotation similar to the example. This does not use Hibernate's omero.api.IQuery.findByExample Query-By-Example} mechanism, since that cannot handle joins. The fields which are used are:

• the main content of the annotation : String, IObject.getId(), etc.

If the main content is null it is assumed to be a wildcard searched, and only the type of the annotation is searched. Currently, ListAnnotations are not supported.

Specified by:

byAnnotatedWith_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

examples - Not empty.

__current - The Current object for the invocation.

Throws:

ServerError

byFullText_async

public void byFullText_async(AMD_Search_byFullText __cb,
                             java.lang.String query,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _SearchOperations

Passes the query as is to the Lucene backend.

Specified by:

byFullText_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

query - May not be null or of zero length.

__current - The Current object for the invocation.

Throws:

ServerError

byGroupForTags_async

public void byGroupForTags_async(AMD_Search_byGroupForTags __cb,
                                 java.lang.String group,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _SearchOperations

Returns transient (without ID) TagAnnotation instances which represent all the TagAnnotation tags in the given group. The entities are transient and without ownership since multiple users can own the same tag. This method will override settings for types.

Specified by:

byGroupForTags_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

group - Can be null or empty to return all tags.

__current - The Current object for the invocation.

Throws:

ServerError

byHqlQuery_async

public void byHqlQuery_async(AMD_Search_byHqlQuery __cb,
                             java.lang.String query,
                             Parameters params,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _SearchOperations

Delegates to omero.api.IQuery.findAllByQuery method to take advantage of the and, or, and not methods, or queue-semantics.

Specified by:

byHqlQuery_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

query - Not null.

__current - The Current object for the invocation.

Throws:

ServerError

byLuceneQueryBuilder_async

public void byLuceneQueryBuilder_async(AMD_Search_byLuceneQueryBuilder __cb,
                                       java.lang.String fields,
                                       java.lang.String from,
                                       java.lang.String to,
                                       java.lang.String dateType,
                                       java.lang.String query,
                                       Ice.Current __current)
                                throws ServerError

Description copied from interface: _SearchOperations

Builds a Lucene query and passes it to the Lucene backend.

Specified by:

byLuceneQueryBuilder_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

fields - The fields (comma separated) to search in (name, description, ...)

from - The date range from, in the form YYYYMMDD (may be null)

to - The date range to (inclusive), in the form YYYYMMDD (may be null)

dateType - DATE_TYPE_ACQUISITION or DATE_TYPE_IMPORT

query - May not be null or of zero length.

__current - The Current object for the invocation.

Throws:

ServerError

bySimilarTerms_async

public void bySimilarTerms_async(AMD_Search_bySimilarTerms __cb,
                                 java.util.List<java.lang.String> terms,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _SearchOperations

Returns transient (without ID) TextAnnotation instances which represent terms which are similar to the given terms. For example, if the argument is cell, one return value might have as its textValue: cellular while another has cellularize. No filtering or fetching is performed.

Specified by:

bySimilarTerms_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

terms - Cannot be empty.

__current - The Current object for the invocation.

Throws:

ServerError

bySomeMustNone_async

public void bySomeMustNone_async(AMD_Search_bySomeMustNone __cb,
                                 java.util.List<java.lang.String> some,
                                 java.util.List<java.lang.String> must,
                                 java.util.List<java.lang.String> none,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _SearchOperations

Builds a Lucene query and passes it to byFullText.

Specified by:

bySomeMustNone_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

some - Some (at least one) of these terms must be present in the document. May be null.

must - All of these terms must be present in the document. May be null.

none - None of these terms may be present in the document. May be null.

__current - The Current object for the invocation.

Throws:

ServerError

byTagForGroups_async

public void byTagForGroups_async(AMD_Search_byTagForGroups __cb,
                                 java.lang.String tag,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _SearchOperations

Creates a query which will return transient (without ID) TagAnnotation instances which represent all the TagAnnotation tag groups which the given tag belongs to. The entities are transient and without ownership since multiple users can own the same tag group. This method will override settings for types.

Specified by:

byTagForGroups_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

tag - Can be null or empty to return all groups.

__current - The Current object for the invocation.

Throws:

ServerError

clearQueries_async

public void clearQueries_async(AMD_Search_clearQueries __cb,
                               Ice.Current __current)
                        throws ServerError

Description copied from interface: _SearchOperations

Removes all active queries (leaving resetDefaults settings alone), such that activeQueries will return 0.

Specified by:

clearQueries_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

currentMetadata_async

public void currentMetadata_async(AMD_Search_currentMetadata __cb,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _SearchOperations

Provides access to the extra query information (for example Lucene score and boost values) for a single call to next. This method may only be called once for any given call to next.

Specified by:

currentMetadata_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

currentMetadataList_async

public void currentMetadataList_async(AMD_Search_currentMetadataList __cb,
                                      Ice.Current __current)
                               throws ServerError

Description copied from interface: _SearchOperations

Provides access to the extra query information (for example Lucene score and boost values) for a single call to results. This method may only be called once for any given call to results.

Specified by:

currentMetadataList_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

fetchAlso_async

public void fetchAlso_async(AMD_Search_fetchAlso __cb,
                            java.util.List<java.lang.String> fetches,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _SearchOperations

Adds a fetch clause for loading non-annotation fields of returned entities. Each fetch is a hibernate clause in dot notation.

Specified by:

fetchAlso_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

fetches - Can be empty, which removes previous fetch setting.

__current - The Current object for the invocation.

Throws:

ServerError

fetchAnnotations_async

public void fetchAnnotations_async(AMD_Search_fetchAnnotations __cb,
                                   java.util.List<java.lang.String> classes,
                                   Ice.Current __current)
                            throws ServerError

Description copied from interface: _SearchOperations

Queries the database for all Annotation annotations of the given types for all returned instances.

Specified by:

fetchAnnotations_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

classes - Can be empty, which removes previous fetch setting.

__current - The Current object for the invocation.

Throws:

ServerError

getBatchSize_async

public void getBatchSize_async(AMD_Search_getBatchSize __cb,
                               Ice.Current __current)
                        throws ServerError

Description copied from interface: _SearchOperations

Returns the current batch size. If setBatchSize has not been called, the default value will be in effect.

Specified by:

getBatchSize_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

hasNext_async

public void hasNext_async(AMD_Search_hasNext __cb,
                          Ice.Current __current)
                   throws ServerError

Description copied from interface: _SearchOperations

Returns true if another call to next is valid. A call to next may throw an exception for another reason, however.

Specified by:

hasNext_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

isAllowLeadingWildcard_async

public void isAllowLeadingWildcard_async(AMD_Search_isAllowLeadingWildcard __cb,
                                         Ice.Current __current)
                                  throws ServerError

Description copied from interface: _SearchOperations

Returns the current leading-wildcard setting. If false, byFullText and bySomeMustNone will throw an ApiUsageException, since leading-wildcard searches are quite slow. Use setAllowLeadingWildcard in order to permit this usage.

Specified by:

isAllowLeadingWildcard_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

isCaseSensitive_async

public void isCaseSensitive_async(AMD_Search_isCaseSensitive __cb,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _SearchOperations

Returns the current case sensitivity setting. If setCaseSensitive has not been called, the default value will be in effect.

Specified by:

isCaseSensitive_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

isMergedBatches_async

public void isMergedBatches_async(AMD_Search_isMergedBatches __cb,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _SearchOperations

Returns the current merged-batches setting. If setMergedBatches has not been called, the default value will be in effect.

Specified by:

isMergedBatches_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

isReturnUnloaded_async

public void isReturnUnloaded_async(AMD_Search_isReturnUnloaded __cb,
                                   Ice.Current __current)
                            throws ServerError

Description copied from interface: _SearchOperations

Returns the current return-unloaded setting. If true, all returned entities will be unloaded. If setReturnUnloaded has not been called, the default value will be in effect.

Specified by:

isReturnUnloaded_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

isUseProjections_async

public void isUseProjections_async(AMD_Search_isUseProjections __cb,
                                   Ice.Current __current)
                            throws ServerError

Description copied from interface: _SearchOperations

Returns the current use-projection setting. If true, the client must be careful with all results that are returned. See setUseProjections for more. If setUseProjections has not been called, the default value will be in effect.

Specified by:

isUseProjections_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

next_async

public void next_async(AMD_Search_next __cb,
                       Ice.Current __current)
                throws ServerError

Description copied from interface: _SearchOperations

Returns the next entity from the current query. If the previous call returned the last entity from a given query, the first entity from the next query will be returned and activeQueries decremented. Since this method only returns the entity itself, a single call to currentMetadata may follow this call to gather the extra metadata which is returned in the map via results.

Specified by:

next_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

not_async

public void not_async(AMD_Search_not __cb,
                      Ice.Current __current)
               throws ServerError

Description copied from interface: _SearchOperations

Applies the next by* method to the previous by* method, so that a call hasNext, next, or results sees only the intersection of the two calls. For example,

 
 service.onlyType(Image.class);
 service.byFullText("foo");
 service.complement();
 service.byAnnotatedWith(TagAnnotation.class);
 
 

will return all the Images not annotated with TagAnnotation.

Calling this method overrides a previous setting of or or and. If there is no active queries (i.e. activeQueries > 0), then an ApiUsageException will be thrown.

Specified by:

not_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

notAnnotatedBy_async

public void notAnnotatedBy_async(AMD_Search_notAnnotatedBy __cb,
                                 Details d,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _SearchOperations

Restricts entities by who has not annotated them with an Annotation matching the other filters. As notOwnedBy, the Details.getOwner() and Details.getGroup() information is combined with an AND condition.

Specified by:

notAnnotatedBy_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

d - Can be null, in which case any previous restriction is removed.

__current - The Current object for the invocation.

Throws:

ServerError

notOwnedBy_async

public void notOwnedBy_async(AMD_Search_notOwnedBy __cb,
                             Details d,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _SearchOperations

Uses the Details.getOwner() and Details.getGroup() information to restrict the entities which will be returned. If both are non-null, the two restrictions are joined by an AND.

Specified by:

notOwnedBy_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

d - Can be null, in which case the previous restriction is removed.

__current - The Current object for the invocation.

Throws:

ServerError

onlyAnnotatedBetween_async

public void onlyAnnotatedBetween_async(AMD_Search_onlyAnnotatedBetween __cb,
                                       RTime start,
                                       RTime stop,
                                       Ice.Current __current)
                                throws ServerError

Description copied from interface: _SearchOperations

Restricts entities by the time in which any annotation (which matches the other filters) was added them. This matches the Details.getCreationEvent() creation event of the Annotation.

Specified by:

onlyAnnotatedBetween_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

start - Can be null, i.e. interval open to negative infinity.

stop - Can be null, i.e. interval open to positive infinity.

__current - The Current object for the invocation.

Throws:

ServerError

onlyAnnotatedBy_async

public void onlyAnnotatedBy_async(AMD_Search_onlyAnnotatedBy __cb,
                                  Details d,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _SearchOperations

Restricts entities by who has annotated them with an Annotation matching the other filters. As onlyOwnedBy, the Details.getOwner() and Details.getGroup() information is combined with an AND condition.

Specified by:

onlyAnnotatedBy_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

d - Can be null, in which case any previous restriction is removed.

__current - The Current object for the invocation.

Throws:

ServerError

onlyAnnotatedWith_async

public void onlyAnnotatedWith_async(AMD_Search_onlyAnnotatedWith __cb,
                                    java.util.List<java.lang.String> classes,
                                    Ice.Current __current)
                             throws ServerError

Description copied from interface: _SearchOperations

Restricts entities to having an Annotation of all the given types. This is useful in combination with the other onlyAnnotated* methods to say, e.g., only annotated with a file by user X. By default, this value is null and imposes no restriction. Passing an empty array implies an object that is not annotated at all. Note: If the semantics were OR, then a client would have to query each class individually, and compare all the various values, checking which ids are where. However, since this method defaults to AND, multiple calls (optionally with isMergedBatches and isReturnUnloaded) and combine the results. Duplicate ids are still possible so a set of some form should be used to collect the results.

Specified by:

onlyAnnotatedWith_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

classes - Can be empty, in which case restriction is removed.

__current - The Current object for the invocation.

Throws:

ServerError

onlyCreatedBetween_async

public void onlyCreatedBetween_async(AMD_Search_onlyCreatedBetween __cb,
                                     RTime start,
                                     RTime stop,
                                     Ice.Current __current)
                              throws ServerError

Description copied from interface: _SearchOperations

Restricts the time between which an entity may have been created.

Specified by:

onlyCreatedBetween_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

start - Can be null, i.e. interval open to negative infinity.

stop - Can be null, i.e. interval opens to positive infinity.

__current - The Current object for the invocation.

Throws:

ServerError

onlyIds_async

public void onlyIds_async(AMD_Search_onlyIds __cb,
                          java.util.List<java.lang.Long> ids,
                          Ice.Current __current)
                   throws ServerError

Description copied from interface: _SearchOperations

Restricts the set of ids which will be checked. This is useful for testing one of the given restrictions on a reduced set of objects.

Specified by:

onlyIds_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

ids - Can be null, in which case the previous restriction is removed.

__current - The Current object for the invocation.

Throws:

ServerError

onlyModifiedBetween_async

public void onlyModifiedBetween_async(AMD_Search_onlyModifiedBetween __cb,
                                      RTime start,
                                      RTime stop,
                                      Ice.Current __current)
                               throws ServerError

Description copied from interface: _SearchOperations

Restricts the time between which an entity may have last been modified.

Specified by:

onlyModifiedBetween_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

start - Can be null, i.e. interval open to negative infinity.

stop - Can be null, i.e. interval open to positive infinity.

__current - The Current object for the invocation.

Throws:

ServerError

onlyOwnedBy_async

public void onlyOwnedBy_async(AMD_Search_onlyOwnedBy __cb,
                              Details d,
                              Ice.Current __current)
                       throws ServerError

Description copied from interface: _SearchOperations

Uses the Details.getOwner() and Details.getGroup() information to restrict the entities which will be returned. If both are non-null, the two restrictions are joined by an AND.

Specified by:

onlyOwnedBy_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

d - Can be null, in which case the previous restriction is removed.

__current - The Current object for the invocation.

Throws:

ServerError

onlyType_async

public void onlyType_async(AMD_Search_onlyType __cb,
                           java.lang.String klass,
                           Ice.Current __current)
                    throws ServerError

Description copied from interface: _SearchOperations

Restricts the search to a single type. All return values will match this type.

Specified by:

onlyType_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

onlyTypes_async

public void onlyTypes_async(AMD_Search_onlyTypes __cb,
                            java.util.List<java.lang.String> classes,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _SearchOperations

Restricts searches to a set of types. The entities returned are guaranteed to be one of these types.

Specified by:

onlyTypes_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

or_async

public void or_async(AMD_Search_or __cb,
                     Ice.Current __current)
              throws ServerError

Description copied from interface: _SearchOperations

Applies the next by* method to the previous by* method, so that a call hasNext, next or results sees only the union of the two calls. For example,

 
 service.onlyType(Image.class);
 service.byFullText("foo");
 service.or();
 service.onlyType(Dataset.class);
 service.byFullText("foo");
 
 

will return both Images and Datasets together. Calling this method overrides a previous setting of and or not. If there is no active queries (i.e. activeQueries > 0), then an ApiUsageException will be thrown.

Specified by:

or_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

remove_async

public void remove_async(AMD_Search_remove __cb,
                         Ice.Current __current)
                  throws ServerError

Description copied from interface: _SearchOperations

Unsupported operation.

Specified by:

remove_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

resetDefaults_async

public void resetDefaults_async(AMD_Search_resetDefaults __cb,
                                Ice.Current __current)
                         throws ServerError

Description copied from interface: _SearchOperations

Resets all settings (non-query state) to the original default values, as if the instance had just be created.

Specified by:

resetDefaults_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

results_async

public void results_async(AMD_Search_results __cb,
                          Ice.Current __current)
                   throws ServerError

Description copied from interface: _SearchOperations

Returns up to getBatchSize batch size number of results along with the related query metadata. If isMergedBatches batches are merged then the results from multiple queries may be returned together.

Specified by:

results_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setAllowLeadingWildcard_async

public void setAllowLeadingWildcard_async(AMD_Search_setAllowLeadingWildcard __cb,
                                          boolean allowLeadingWildcard,
                                          Ice.Current __current)
                                   throws ServerError

Description copied from interface: _SearchOperations

Permits full-text queries with a leading query if true.

Specified by:

setAllowLeadingWildcard_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setBatchSize_async

public void setBatchSize_async(AMD_Search_setBatchSize __cb,
                               int size,
                               Ice.Current __current)
                        throws ServerError

Description copied from interface: _SearchOperations

Sets the maximum number of results that will be returned by one call to results. If batches are not merged, then results may often be less than the batch size. If batches are merged, then only the last call to results can be less than batch size. Note: some query types may not support batching at the query level, and all instances must then be loaded into memory simultaneously.

Specified by:

setBatchSize_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

size - maximum number of results per call to results

__current - The Current object for the invocation.

Throws:

ServerError

setCaseSensitive_async

public void setCaseSensitive_async(AMD_Search_setCaseSensitive __cb,
                                   boolean caseSensitive,
                                   Ice.Current __current)
                            throws ServerError

Description copied from interface: _SearchOperations

Sets the case sensitivity on all queries where case-sensitivity is supported.

Specified by:

setCaseSensitive_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setCaseSentivice_async

@Deprecated
public void setCaseSentivice_async(AMD_Search_setCaseSentivice __cb,
                                               boolean caseSensitive,
                                               Ice.Current __current)
                                        throws ServerError

Deprecated.

Description copied from interface: _SearchOperations

Sets the case sensitivity on all queries where case-sensitivity is supported.

Specified by:

setCaseSentivice_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setMergedBatches_async

public void setMergedBatches_async(AMD_Search_setMergedBatches __cb,
                                   boolean merge,
                                   Ice.Current __current)
                            throws ServerError

Description copied from interface: _SearchOperations

Set whether or not results from two separate queries can be returned in the same call to results.

Specified by:

setMergedBatches_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setReturnUnloaded_async

public void setReturnUnloaded_async(AMD_Search_setReturnUnloaded __cb,
                                    boolean returnUnloaded,
                                    Ice.Current __current)
                             throws ServerError

Description copied from interface: _SearchOperations

Determines if all results should be returned as unloaded objects. This is particularly useful for creating lists for further querying via IQuery. This value overrides the setUseProjections setting.

Specified by:

setReturnUnloaded_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setUseProjections_async

public void setUseProjections_async(AMD_Search_setUseProjections __cb,
                                    boolean useProjections,
                                    Ice.Current __current)
                             throws ServerError

Description copied from interface: _SearchOperations

Determines if Lucene queries should not hit the database. Instead all values which are stored in the index will be loaded into the object, which includes the id. However, the entity will not be marked unloaded and therefore it is especially important to not allow a projection-instance to be saved back to the server. This can result in DATA LOSS.

Specified by:

setUseProjections_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

unordered_async

public void unordered_async(AMD_Search_unordered __cb,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _SearchOperations

Removes the current stack of order statements.

Specified by:

unordered_async in interface _SearchOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

activate_async

public void activate_async(AMD_StatefulServiceInterface_activate __cb,
                           Ice.Current __current)
                    throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

Load a service implementation from disk if it was previously passivated. It is unnecessary to call this method since activation happens automatically, but calling this may prevent a short lapse when the service is first accessed after passivation. It is safe to call this method at any time, even when the service is not passivated.

Specified by:

activate_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

close_async

public void close_async(AMD_StatefulServiceInterface_close __cb,
                        Ice.Current __current)
                 throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter. Any further method calls will fail with a Ice::NoSuchObjectException. Note: with JavaEE, the close method was called publicly, and internally this called destroy(). As of the OmeroBlitz migration, this functionality has been combined.

Specified by:

close_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getCurrentEventContext_async

public void getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb,
                                         Ice.Current __current)
                                  throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.

Specified by:

getCurrentEventContext_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

passivate_async

public void passivate_async(AMD_StatefulServiceInterface_passivate __cb,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _StatefulServiceInterfaceOperations

Causes the blitz server to store the service implementation to disk to free memory. This is typically done automatically by the server when a pre-defined memory limit is reached, but can be used by the client if it clear that a stateful service will not be used for some time. Activation will happen automatically whether passivation was done manually or automatically.

Specified by:

passivate_async in interface _StatefulServiceInterfaceOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError