Package | Description |
---|---|
messif.algorithms |
Search algorithms base classes.
|
messif.algorithms.impl |
Implementation of basic search algorithms.
|
messif.operations |
Generic classes for data manipulatioin and querying operations.
|
messif.operations.data |
Implementation of data-manipulation operations.
|
messif.operations.query |
Implementation of data querying operations.
|
messif.statistics |
Statistic gathering support.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AsynchronousNavigationProcessor<O extends AbstractOperation>
Extension of the
NavigationProcessor that supports asynchronous execution
of the processing steps via Callable s. |
class |
AsynchronousNavigationProcessorWrapper<O extends AbstractOperation>
Wrapper class for any
AsynchronousNavigationProcessor that delegates the methods
to an encapsulated AsynchronousNavigationProcessor . |
interface |
NavigationProcessor<O extends AbstractOperation>
Interface for processing operations via
NavigationDirectory . |
class |
NavigationProcessorWrapper<O extends AbstractOperation>
Wrapper class for any
NavigationProcessor that delegates the methods
to an encapsulated NavigationProcessor . |
Modifier and Type | Method and Description |
---|---|
<T extends AbstractOperation> |
Algorithm.backgroundExecuteOperation(T operation)
Execute algorithm operation on background.
|
<T extends AbstractOperation> |
RMIAlgorithm.backgroundExecuteOperation(T operation) |
<T extends AbstractOperation> |
RMIAlgorithmOriginal.backgroundExecuteOperation(T operation)
Deprecated.
|
<T extends AbstractOperation> |
Algorithm.backgroundExecuteOperationWithStatistics(T operation)
Execute algorithm operation on background.
|
<T extends AbstractOperation> |
RMIAlgorithm.backgroundExecuteOperationWithStatistics(T operation) |
<T extends AbstractOperation> |
RMIAlgorithmOriginal.backgroundExecuteOperationWithStatistics(T operation)
Deprecated.
|
protected <T extends AbstractOperation> |
Algorithm.createBackgroundExecutionCallable(T operation)
Creates a new
Callable that simply runs the Algorithm.executeOperation(T) method on the given operation. |
static <O extends AbstractOperation> |
NavigationProcessors.execute(java.util.concurrent.ExecutorService executor,
NavigationProcessor<O> processor)
Executes a given
NavigationProcessor either asynchronously using ExecutorService
if the processor implements AsynchronousNavigationProcessor or sequentially. |
static <O extends AbstractOperation> |
NavigationProcessors.executeAsync(java.util.concurrent.ExecutorService executor,
AsynchronousNavigationProcessor<? extends O> processor)
Executes a given
AsynchronousNavigationProcessor using ExecutorService . |
<T extends AbstractOperation> |
Algorithm.executeOperation(T operation)
Execute operation on this algorithm.
|
<T extends AbstractOperation> |
DistributedAlgorithm.executeOperation(T operation)
Execute operation on this algorithm.
|
<T extends AbstractOperation> |
RMIAlgorithm.executeOperation(T operation) |
<T extends AbstractOperation> |
RMIAlgorithmOriginal.executeOperation(T operation)
Deprecated.
|
<E extends AbstractOperation> |
Algorithm.getFirstSupportedOperation(java.lang.Class<? extends E> subclassToSearch)
Returns the first operation that is a supported by this algorithm and is a subclass of (or the same class as)
subclassToSearch . |
<O extends AbstractOperation> |
NavigationDirectory.getNavigationProcessor(O operation)
Returns the
navigator that provides the steps
in which the given operation should be evaluated. |
static <E extends AbstractOperation> |
Algorithm.getOperationSubClasses(java.util.Collection<java.lang.Class<? extends AbstractOperation>> operations,
java.lang.Class<? extends E> subclassToSearch)
Given a list of abstract operation classes and a required class,
this auxiliary static method returns list of all classes that are subclass of the required class.
|
<E extends AbstractOperation> |
Algorithm.getSupportedOperations(java.lang.Class<? extends E> subclassToSearch)
Returns the list of operations this particular algorithm supports.
|
<T extends AbstractOperation> |
RMIAlgorithm.getSupportedOperations(java.lang.Class<? extends T> subclassToSearch) |
<T extends AbstractOperation> |
RMIAlgorithmOriginal.getSupportedOperations(java.lang.Class<? extends T> subclassToSearch)
Deprecated.
|
<T extends AbstractOperation> |
Algorithm.setupStatsAndExecuteOperation(T operation,
java.lang.String operationStatsRegexp)
Reset
operation statistics ,
bind the operation statistics according to the given regular expression,
and execute operation on this algorithm. |
<T extends AbstractOperation> |
RMIAlgorithm.setupStatsAndExecuteOperation(T operation,
java.lang.String operationStatsRegexp) |
<T extends AbstractOperation> |
RMIAlgorithmOriginal.setupStatsAndExecuteOperation(T operation,
java.lang.String operationStatsRegexp)
Deprecated.
|
static <T extends AbstractOperation> |
Algorithm.waitBackgroundExecution(java.util.concurrent.Future<? extends T> future)
Helper method for waiting for an operation executed on background.
|
Modifier and Type | Method and Description |
---|---|
AbstractOperation |
DistAlgReplyMessage.getOperation()
Returns the operation processed by the algorithm.
|
AbstractOperation |
DistAlgRequestMessage.getOperation()
Returns the operation processed by the algorithm.
|
AbstractOperation |
Algorithm.getRunningOperationById(java.util.UUID operationId)
Returns the currently executed operation with the given identifier.
|
AbstractOperation |
RMIAlgorithm.getRunningOperationById(java.util.UUID operationId) |
AbstractOperation |
RMIAlgorithmOriginal.getRunningOperationById(java.util.UUID operationId)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
java.util.Collection<AbstractOperation> |
Algorithm.getAllRunningOperations()
Returns all operations currently executed by this algorithm.
|
java.util.Collection<AbstractOperation> |
RMIAlgorithm.getAllRunningOperations() |
java.util.Collection<AbstractOperation> |
RMIAlgorithmOriginal.getAllRunningOperations()
Deprecated.
|
java.util.List<java.lang.Class<? extends AbstractOperation>> |
Algorithm.getSupportedOperations()
Returns the list of operations this particular algorithm supports.
|
java.util.List<java.lang.Class<? extends AbstractOperation>> |
RMIAlgorithm.getSupportedOperations() |
java.util.List<java.lang.Class<? extends AbstractOperation>> |
RMIAlgorithmOriginal.getSupportedOperations()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
Algorithm.backgroundExecuteOperationIndependent(AbstractOperation operation)
Execute algorithm operation on background independently, i.e. without the
possibility to wait for its finish.
|
void |
RMIAlgorithm.backgroundExecuteOperationIndependent(AbstractOperation operation) |
void |
RMIAlgorithmOriginal.backgroundExecuteOperationIndependent(AbstractOperation operation)
Deprecated.
|
protected DistAlgRequestMessage |
DistributedAlgorithm.createRequestMessage(AbstractOperation operation)
Creates a request message used by this algorithm.
|
static NavigationProcessor<?> |
NavigationProcessors.getNavigationProcessor(java.lang.Object navigationDirectory,
AbstractOperation operation)
Returns the
NavigationDirectory.getNavigationProcessor(messif.operations.AbstractOperation)
with type casts. |
static void |
DistributedAlgorithm.mergeOperationsFromReplies(AbstractOperation targetOperation,
java.util.Collection<? extends DistAlgReplyMessage> replyMessages)
Update supplied operation answer with partial answers from reply messages
|
protected int |
DistributedAlgorithm.navigationAfterProcessing(AbstractOperation operation,
DistAlgRequestMessage request,
ReplyReceiver<? extends DistAlgReplyMessage> receiver)
Processes navigation after the local processing.
|
protected ReplyReceiver<? extends DistAlgReplyMessage> |
DistributedAlgorithm.navigationBeforeProcessing(AbstractOperation operation,
DistAlgRequestMessage request,
java.util.Collection<NetworkNode> nodes)
Processes navigation before the local processing.
|
protected ReplyReceiver<? extends DistAlgReplyMessage> |
DistributedAlgorithm.navigationBeforeProcessing(AbstractOperation operation,
DistAlgRequestMessage request,
NetworkNode node)
Processes navigation before the local processing.
|
protected void |
DistributedAlgorithm.navigationNoProcessing(AbstractOperation operation,
DistAlgRequestMessage request,
java.util.Collection<NetworkNode> nodes)
Processes navigation when there will be no local processing.
|
protected void |
DistributedAlgorithm.navigationNoProcessing(AbstractOperation operation,
DistAlgRequestMessage request,
NetworkNode node)
Processes navigation when there will be no local processing.
|
void |
Algorithm.statisticsAfterOperation(AbstractOperation operation)
This method can be used by all algorithms after processing any operation to set default (operation) statistics.
|
boolean |
Algorithm.terminateOperation(AbstractOperation operation)
Terminates processing of the given operation.
|
Modifier and Type | Method and Description |
---|---|
static <E extends AbstractOperation> |
Algorithm.getOperationSubClasses(java.util.Collection<java.lang.Class<? extends AbstractOperation>> operations,
java.lang.Class<? extends E> subclassToSearch)
Given a list of abstract operation classes and a required class,
this auxiliary static method returns list of all classes that are subclass of the required class.
|
Constructor and Description |
---|
DistAlgRequestMessage(AbstractOperation operation)
Creates a new instance of DistAlgRequestMessage for the given operation.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractNavigationProcessor<O extends AbstractOperation,T>
Basic implementation of
NavigationProcessor that processes any AbstractOperation
on a set of processing items (e.g. buckets). |
Modifier and Type | Method and Description |
---|---|
NavigationProcessor<? extends AbstractOperation> |
MultipleOverlaysAlgorithm.getNavigationProcessor(AbstractOperation operation) |
Modifier and Type | Method and Description |
---|---|
NavigationProcessor<? extends AbstractOperation> |
MultipleOverlaysAlgorithm.getNavigationProcessor(AbstractOperation operation) |
AsynchronousNavigationProcessor<? extends QueryOperation<?>> |
ParallelSequentialScan.getNavigationProcessor(AbstractOperation operation) |
void |
LocatorStorageAlgorithm.processOperation(AbstractOperation op)
Implementation of a generic operation.
|
void |
MultiQueryWrapperAlgorithm.processOperation(AbstractOperation op)
Implementation of a generic operation.
|
Modifier and Type | Class and Description |
---|---|
class |
GetCandidateSetOperation
This operation encapsulates
RankingSingleQueryOperation and returns a candidate set requested size for
this operation. |
class |
ListingQueryOperation
The base class for query operations that return unsorted collections of
objects . |
class |
QueryOperation<TAnswer>
The base class for all query operations.
|
class |
RankingMultiQueryOperation
The base class for query operations that return objects
ranked by a distance to multiple objects.
|
class |
RankingQueryOperation
The base class for query operations that return
objects
ranked by a distance. |
class |
RankingSingleQueryOperation
The base class for query operations that return objects ranked by a distance
to a single object.
|
class |
RefineCandidateOperation
This operation starts refinement of the encapsulated
RankingSingleQueryOperation using
the candidate set stored in the provided GetCandidateSetOperation . |
class |
SingletonQueryOperation
The base class for query operations that return a single
object . |
Modifier and Type | Field and Description |
---|---|
static IndexComparator<java.util.UUID,AbstractOperation> |
AbstractOperation.uuidOperationComparator
Comparator to be used in buckets and storages to index & compare operations according to operation UUID.
|
Modifier and Type | Method and Description |
---|---|
static <E extends AbstractOperation> |
AbstractOperation.createOperation(java.lang.Class<E> operationClass,
java.lang.Object... arguments)
Creates a new operation of the specified class.
|
static <T extends AbstractOperation> |
AbstractOperation.getAnnotatedConstructor(java.lang.Class<? extends T> operationClass)
Searches the given
operationClass for an annotated constructor. |
static <T extends AbstractOperation> |
AbstractOperation.getAnnotatedConstructor(java.lang.Class<? extends T> operationClass,
int argumentsCount)
Searches the given
operationClass for an annotated constructor
that has the given argumentsCount . |
Modifier and Type | Method and Description |
---|---|
AbstractOperation |
AbstractOperation.clone()
Create a duplicate of this operation.
|
Modifier and Type | Method and Description |
---|---|
void |
EndOperationListener.onEndOperation(AbstractOperation operation,
ErrorCode errorCode)
Called whenever the operation's
endOperation() or
endOperation(messif.utility.ErrorCode) is called. |
void |
AbstractOperation.updateFrom(AbstractOperation operation)
Update the error code of this operation from another operation.
|
void |
GetCandidateSetOperation.updateFrom(AbstractOperation operation) |
void |
ListingQueryOperation.updateFrom(AbstractOperation operation)
Update the error code and answer of this operation from another operation.
|
void |
RankingQueryOperation.updateFrom(AbstractOperation operation)
Update the error code and answer of this operation from another operation.
|
void |
RefineCandidateOperation.updateFrom(AbstractOperation operation) |
void |
SingletonQueryOperation.updateFrom(AbstractOperation operation)
Update the error code and answer of this operation from another operation.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.String[] |
AbstractOperation.getConstructorArgumentDescriptions(java.lang.Class<? extends AbstractOperation> operationClass)
Returns constructor argument descriptions for the provided operation class.
|
static java.lang.String[] |
AbstractOperation.getConstructorArgumentDescriptions(java.lang.Class<? extends AbstractOperation> operationClass,
int nArguments)
Returns constructor argument descriptions for the provided operation class with given number of arguments.
|
static java.lang.Class<?>[] |
AbstractOperation.getConstructorArguments(java.lang.Class<? extends AbstractOperation> operationClass)
Returns constructor argument types for the provided operation class.
|
static java.lang.Class<?>[] |
AbstractOperation.getConstructorArguments(java.lang.Class<? extends AbstractOperation> operationClass,
int nArguments)
Returns constructor arguments for the provided operation class for an annotated constructor with given number of arguments.
|
static java.lang.String |
AbstractOperation.getConstructorDescription(java.lang.Class<? extends AbstractOperation> operationClass)
Returns full constructor description for the provided operation class.
|
static java.lang.String |
AbstractOperation.getName(java.lang.Class<? extends AbstractOperation> operationClass)
Returns the name of operation represented by the provided class.
|
Modifier and Type | Class and Description |
---|---|
class |
BulkInsertOperation
Operation for inserting several objects at once.
|
class |
DataManipulationOperation
Common abstract ancestor of all data manipulation operations (insert, delete, update).
|
class |
DeleteByLocatorOperation
Operation for deleting an object.
|
class |
DeleteOperation
Operation for deleting object(s).
|
class |
DeleteOperationLegacy
Operation for deleting an object.
|
class |
InsertOperation
Operation for inserting an object.
|
class |
TruncateOperation
Operation for removing all object(s).
|
Modifier and Type | Method and Description |
---|---|
void |
DeleteByLocatorOperation.updateFrom(AbstractOperation operation)
Update the operation result.
|
void |
DeleteOperation.updateFrom(AbstractOperation operation) |
void |
DeleteOperationLegacy.updateFrom(AbstractOperation operation) |
Modifier and Type | Class and Description |
---|---|
class |
AggregationFunctionQueryOperation
Aggregation function kNN query operation.
|
class |
ApproxKNNQueryOperation
Approximate k-nearest neighbors query with specific early termination parameters
and support for obtaining some guarantees on results.
|
class |
ApproxRangeQueryOperation
Approximate range query with specific early termination parameters
and support for obtaining some guarantees on results.
|
class |
BatchKNNQueryOperation
A batch of several K-nearest neighbors query operations encapsulated as a single operation.
|
class |
GetAlgorithmInfoOperation
Special operation that returns the algorithm info (i.e. the algorithm toString() value).
|
class |
GetAllObjectsQueryOperation
Operation for retrieving all objects locally stored (organized by an algorithm).
|
class |
GetObjectByLocatorOperation
This query retrieves from the structure a set of objects given their locators.
|
class |
GetObjectCountOperation
Operation for retrieving the number of objects stored in indexing structure.
|
class |
GetObjectsByLocatorPrefixOperation
This operation returns objects with locator that have a given prefix.
|
class |
GetObjectsByLocatorsOperation
This operation returns objects with given locators.
|
class |
GetRandomObjectQueryOperation
Operation for retriving a random object.
|
class |
GetRandomObjectsQueryOperation
Operation for retriving a list of random objects.
|
class |
IncrementalNNQueryOperation
Incremental Nearest Neighbor Search.
|
class |
JoinQueryOperation
Similarity join query operation.
|
class |
KNNMultiQueryOperation
K-nearest neighbors query operation with multiple query objects.
|
class |
KNNQueryByLocatorOperation
K-nearest neighbors query operation for query identified just by locator.
|
class |
KNNQueryOperation
K-nearest neighbors query operation.
|
class |
PartitionedKNNQueryOperation
This class represents a range query that distinguish the partition
from which a matching object comes from.
|
class |
PartitionedRangeQueryOperation
This class represents a range query that distinguish the partition
from which a matching object comes from.
|
class |
PrintAllObjectsOperation
Operation for retrieving all objects locally stored (organized by an algorithm) and printing
their text representation to specified file.
|
class |
QuantizeOperation
Operation for quantizing all data objects passed.
|
class |
RangeJoinQueryOperation
Similarity join query operation evaluated using range queries on an external index.
|
class |
RangeMultiQueryOperation
Range query operation with multiple query objects.
|
class |
RangeQueryOperation
Range query operation.
|
class |
TopCombinedQueryOperation
Top-k combined query operation.
|
Modifier and Type | Method and Description |
---|---|
void |
GetAlgorithmInfoOperation.updateFrom(AbstractOperation operation) |
void |
JoinQueryOperation.updateFrom(AbstractOperation operation)
Update the error code and answer of this operation from another operation.
|
Modifier and Type | Method and Description |
---|---|
static <T extends AbstractOperation> |
FutureWithStatisticsImpl.submit(java.util.concurrent.ExecutorService executorService,
java.util.concurrent.Callable<T> callable)
Executes the given callable and collects the
OperationStatistics . |