-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract browser interfaces for each package
- Loading branch information
Showing
9 changed files
with
853 additions
and
397 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
src/main/java/fr/igred/omero/annotations/AnnotationBrowser.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
package fr.igred.omero.annotations; | ||
|
||
|
||
import fr.igred.omero.exception.AccessException; | ||
import fr.igred.omero.exception.ServiceException; | ||
import omero.model.IObject; | ||
|
||
import java.util.List; | ||
import java.util.NoSuchElementException; | ||
import java.util.concurrent.ExecutionException; | ||
|
||
|
||
public interface AnnotationBrowser { | ||
|
||
|
||
/** | ||
* Finds objects on OMERO through a database query. | ||
* | ||
* @param query The database query. | ||
* | ||
* @return A list of OMERO objects. | ||
* | ||
* @throws ServiceException Cannot connect to OMERO. | ||
* @throws AccessException Cannot access data. | ||
*/ | ||
List<IObject> findByQuery(String query) | ||
throws ServiceException, AccessException; | ||
|
||
|
||
/** | ||
* Gets the list of tag annotations available to the user. | ||
* | ||
* @return See above. | ||
* | ||
* @throws AccessException Cannot access data. | ||
* @throws ServiceException Cannot connect to OMERO. | ||
*/ | ||
List<TagAnnotation> getTags() | ||
throws AccessException, ServiceException; | ||
|
||
|
||
/** | ||
* Gets the list of tag annotations with the specified name available to the user. | ||
* | ||
* @param name Name of the tag searched. | ||
* | ||
* @return See above. | ||
* | ||
* @throws AccessException Cannot access data. | ||
* @throws ServiceException Cannot connect to OMERO. | ||
*/ | ||
List<TagAnnotation> getTags(String name) | ||
throws AccessException, ServiceException; | ||
|
||
|
||
/** | ||
* Gets a specific tag from the OMERO database. | ||
* | ||
* @param id ID of the tag. | ||
* | ||
* @return See above. | ||
* | ||
* @throws AccessException Cannot access data. | ||
* @throws ServiceException Cannot connect to OMERO. | ||
* @throws NoSuchElementException No element with this ID. | ||
*/ | ||
TagAnnotationWrapper getTag(Long id) | ||
throws AccessException, ServiceException; | ||
|
||
|
||
/** | ||
* Gets the list of map annotations available to the user. | ||
* | ||
* @return See above. | ||
* | ||
* @throws AccessException Cannot access data. | ||
* @throws ServiceException Cannot connect to OMERO. | ||
*/ | ||
List<MapAnnotation> getMapAnnotations() | ||
throws AccessException, ServiceException; | ||
|
||
|
||
/** | ||
* Gets the list of map annotations with the specified key available to the user. | ||
* | ||
* @param key Name of the tag searched. | ||
* | ||
* @return See above. | ||
* | ||
* @throws AccessException Cannot access data. | ||
* @throws ServiceException Cannot connect to OMERO. | ||
*/ | ||
List<MapAnnotation> getMapAnnotations(String key) | ||
throws AccessException, ServiceException; | ||
|
||
|
||
/** | ||
* Gets the list of map annotations with the specified key and value available to the user. | ||
* | ||
* @param key The required key. | ||
* @param value The required value. | ||
* | ||
* @return See above. | ||
* | ||
* @throws AccessException Cannot access data. | ||
* @throws ServiceException Cannot connect to OMERO. | ||
*/ | ||
List<MapAnnotation> getMapAnnotations(String key, String value) | ||
throws AccessException, ServiceException; | ||
|
||
|
||
/** | ||
* Gets a specific map annotation (key/value pairs) from the OMERO database. | ||
* | ||
* @param id ID of the map annotation. | ||
* | ||
* @return See above. | ||
* | ||
* @throws ServiceException Cannot connect to OMERO. | ||
* @throws AccessException Cannot access data. | ||
* @throws ExecutionException A Facility can't be retrieved or instantiated. | ||
*/ | ||
MapAnnotation getMapAnnotation(Long id) | ||
throws ServiceException, ExecutionException, AccessException; | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.