pt.ua.dicoogle.sdk

Interface IndexerInterface

All Superinterfaces:

DicooglePlugin

public interface IndexerInterface
extends DicooglePlugin

Index Interface Plugin. Indexers analyze documents for performing queries. They may index documents by DICOM metadata for instance, but other document processing procedures may be involved.

Method Summary

Modifier and Type	Method and Description
boolean	handles(java.net.URI path) Checks whether the file in the given path can be indexed by this indexer.
Task<Report>	index(java.lang.Iterable<StorageInputStream> files, java.lang.Object... parameters) Indexes multiple file paths to the database.
Task<Report>	index(StorageInputStream file, java.lang.Object... parameters) Indexes the file path to the database.
boolean	unindex(java.net.URI path) Removes the indexed file at the given path from the database.

Methods inherited from interface pt.ua.dicoogle.sdk.DicooglePlugin

disable, enable, getName, getSettings, isEnabled, setSettings

Method Detail

index

Task<Report> index(StorageInputStream file,
                   java.lang.Object... parameters)

Indexes the file path to the database. Indexation procedures are asynchronous, and will return immediately after the call. The outcome is a report that can be retrieved from the given task as a future.

Parameters:

file - directory or file to index

Returns:

a representation of the asynchronous indexation task

index

Task<Report> index(java.lang.Iterable<StorageInputStream> files,
                   java.lang.Object... parameters)

Indexes multiple file paths to the database. Indexation procedures are asynchronous, and will return immediately after the call. The outcomes are aggregated into a single report and can be retrieved from the given task as a future.

Parameters:

files - a collection of directories and/or files to index

Returns:

a representation of the asynchronous indexation task

handles

boolean handles(java.net.URI path)

Checks whether the file in the given path can be indexed by this indexer. The indexer should verify if the file holds compatible content (e.g. a DICOM file). If this method returns false, the file will not be indexed.

Parameters:

path - a URI to the file to check

Returns:

whether the indexer can handle the file at the given path

unindex

boolean unindex(java.net.URI path)

Removes the indexed file at the given path from the database.

Parameters:

path - the URI of the document

Returns:

whether it was successfully deleted from the database