Package com.levigo.jadice.web.server.annotation

Class AnnotationImageResolver

java.lang.Object

com.levigo.jadice.web.server.annotation.AnnotationImageResolver

public class AnnotationImageResolver
extends Object

The AnnotationImageResolver maps specific AnnotationProfiles onto appropriate AnnotationImageProviders. Therefore providers can be registered and requested by their annotation profile name.

Constructor Summary

Constructors

Constructor	Description
AnnotationImageResolver()

Method Summary

Modifier and Type	Method	Description
static com.levigo.jadice.document.io.SeekableInputStream	getAnnotationImage(String annotationProfileName, String annotationImageID)	Obtains a image for a given AnnotationProfile and image identifer.
static boolean	registerAnnotationImageProvider(String annotationProfileName, AnnotationImageProvider annotationImageProvider)	Registers a AnnotationImageProvider for a given AnnotationProfile.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnnotationImageResolver

public AnnotationImageResolver()

Method Details

getAnnotationImage

public static com.levigo.jadice.document.io.SeekableInputStream getAnnotationImage(String annotationProfileName,
 String annotationImageID)
                                                                            throws IllegalStateException,
IOException

Obtains a image for a given AnnotationProfile and image identifer.

Parameters:

annotationProfileName - the name of the annotation profile.

annotationImageID - the id of the requested image

Returns:

the appropriate AnnotationImageProvider.

Throws:

NullPointerException - if the argument was null.

IllegalStateException - if no appropriate AnnotationImageProvider was found.

IOException - if the image couldn't be loaded/obtained.

registerAnnotationImageProvider

public static boolean registerAnnotationImageProvider(String annotationProfileName,
 AnnotationImageProvider annotationImageProvider)
                                               throws IllegalArgumentException

Registers a AnnotationImageProvider for a given AnnotationProfile. Multiple registrations for the same profile will result in nothing happening.

Parameters:

annotationProfileName - the name of the annotation profile.

annotationImageProvider - the appropriate annotation image provider.

Returns:

true if added successfully, else false

Throws:

NullPointerException - if the given profile name or annotation image provider was null.

IllegalArgumentException