ilog.cpl.service

Interface IlpImageRepository

All Known Implementing Classes:

IlpDefaultImageRepository, IltDefaultImageRepository, IltDefaultImageRepository

public interface IlpImageRepository

Image repository where images can be accessed by their relative location. The image repository serves two primary functions:

• Provides an association between an image and the file location of the image.
• Provides memory management - reuse of images that have already been loaded. By keeping one reusable instance of an image in a repository, the image does not need to be loaded in memory multiple times.

Since:

JTGO 3.0

Method Summary

Modifier and Type	Method and Description
Image	getImage(String location) Gets an image by location.
String	getImageLocation(Image image) Gets the location string associated with an image in the repository.
List	getImageLocations() Gets a list of all the image locations currently in the repository.
URL	getImageURL(Image image) Gets the location of an image in the repository as a URL.
void	removeImage(String location) Removes an image from the repository.

Method Detail

getImage

Image getImage(String location)

Gets an image by location. The location is described in the form of a string presenting the relative path of the image. If the image is not already in the repository, it will be retrieved from the given location (as resolved by the URL access service).

Parameters:

location - The relative path of the image.

Returns:

The image associated with the given location.

getImageLocation

String getImageLocation(Image image)

Gets the location string associated with an image in the repository. This method searches the repository for the given image and returns the location of the image if it is found or null otherwise.

Parameters:

image - The image to search for.

Returns:

Location string associated with the image or null if the image was not found.

getImageLocations

List getImageLocations()

Gets a list of all the image locations currently in the repository.

Returns:

The list of image locations as String instances for the images currently in the repository.

getImageURL

URL getImageURL(Image image)

Gets the location of an image in the repository as a URL. This method searches the repository for the given image and returns the location of the image as a URL if it is found or null otherwise.

Parameters:

image - The image to search for.

Returns:

URL for the location of the image or null if the image was not found.

removeImage

void removeImage(String location)

Removes an image from the repository.

Parameters:

location - The location string associated with the image to be removed.