org.pentaho.reporting.engine.classic.core
Interface URLImageContainer

All Superinterfaces:

Cloneable, ImageContainer

All Known Implementing Classes:

DefaultImageReference

public interface URLImageContainer
extends ImageContainer

An image container, that references a remote image. The image is not required to be loadable as long as this container returns all necessary information correctly.

Some output targets will not display anything, if the image is not loadable.

Author:

Thomas Morgner

Method Summary

org.pentaho.reporting.libraries.resourceloader.ResourceKey	getResourceKey() Returns the resourcekey that was used to load the image.
URL	getSourceURL() Returns the source URL, if available.
String	getSourceURLString() Returns the source URL as string.
boolean	isLoadable() Defines, whether the given URLs are readable.

Methods inherited from interface org.pentaho.reporting.engine.classic.core.ImageContainer

getImageHeight, getImageWidth, getScaleX, getScaleY

Method Detail

getResourceKey

org.pentaho.reporting.libraries.resourceloader.ResourceKey getResourceKey()

Returns the resourcekey that was used to load the image.

Returns:

the resource key.

getSourceURL

URL getSourceURL()

Returns the source URL, if available.

Returns:

the source URL of the image.

getSourceURLString

String getSourceURLString()

Returns the source URL as string. This could also be a relative URL which is not readable by the report processor, the source URL string is copied as is - without being interpreted by the output target.

Returns:

the source URL as string.

isLoadable

boolean isLoadable()

Defines, whether the given URLs are readable. If there is no java.net.URL sourceURL, then this method must return false.

Returns:

true, if the source URL is loadable, false otherwise.