org.nuxeo.ecm.platform.pictures.tiles.service

Class PictureTilingComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.pictures.tiles.service.PictureTilingComponent

All Implemented Interfaces:

PictureTilingService, Adaptable, Component, Extensible

public class PictureTilingComponent
extends DefaultComponent
implements PictureTilingService

Runtime component that expose the PictureTilingService interface. Also exposes the configuration Extension Point

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOB_PROPERTY_EP
static String	ENV_PARAMETERS_EP
static String	IMAGES_TO_CONVERT_EP

Constructor Summary

Constructors

Constructor and Description
PictureTilingComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
PictureTiles	completeTiles(PictureTiles existingTiles, int xCenter, int yCenter)
void	deactivate(ComponentContext context) Deactivates the component.
static void	endGC()
Map<String,String>	getBlobProperties()
String	getBlobProperty(String docType)
String	getBlobProperty(String docType, String defaultValue)
static Map<String,PictureTilingCacheInfo>	getCache()
static Map<String,String>	getEnv()
static String	getEnvValue(String paramName)
static String	getEnvValue(String paramName, String defaultValue)
PictureTiles	getTiles(ImageResource resource, int tileWidth, int tileHeight, int maxTiles)
PictureTiles	getTiles(ImageResource resource, int tileWidth, int tileHeight, int maxTiles, int xCenter, int yCenter, boolean fullGeneration)
PictureTiles	getTilesFromBlob(Blob blob, int tileWidth, int tileHeight, int maxTiles) Deprecated.
PictureTiles	getTilesFromBlob(Blob blob, int tileWidth, int tileHeight, int maxTiles, int xCenter, int yCenter, boolean fullGeneration) Deprecated.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	removeCacheEntry(ImageResource resource)
static void	setDefaultTiler(PictureTiler tiler)
static void	setEnvValue(String paramName, String paramValue)
void	setWorkingDirPath(String path)
static void	startGC()
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, registerExtension, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

ENV_PARAMETERS_EP

public static final String ENV_PARAMETERS_EP

See Also:

Constant Field Values

BLOB_PROPERTY_EP

public static final String BLOB_PROPERTY_EP

See Also:

Constant Field Values

IMAGES_TO_CONVERT_EP

public static final String IMAGES_TO_CONVERT_EP

See Also:

Constant Field Values

Constructor Detail

PictureTilingComponent

public PictureTilingComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

startGC

public static void startGC()

endGC

public static void endGC()

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

getCache

public static Map<String,PictureTilingCacheInfo> getCache()

setWorkingDirPath

public void setWorkingDirPath(String path)

Specified by:

setWorkingDirPath in interface PictureTilingService

getTilesFromBlob

@Deprecated
public PictureTiles getTilesFromBlob(Blob blob,
                                       int tileWidth,
                                       int tileHeight,
                                       int maxTiles)
                              throws ClientException

Deprecated.

Description copied from interface: PictureTilingService

Gets the picture tiles from a blob.

Specified by:

getTilesFromBlob in interface PictureTilingService

Returns:

Throws:

ClientException

getTiles

public PictureTiles getTiles(ImageResource resource,
                    int tileWidth,
                    int tileHeight,
                    int maxTiles)
                      throws ClientException

Specified by:

getTiles in interface PictureTilingService

Throws:

ClientException

completeTiles

public PictureTiles completeTiles(PictureTiles existingTiles,
                         int xCenter,
                         int yCenter)
                           throws ClientException

Specified by:

completeTiles in interface PictureTilingService

Throws:

ClientException

getTilesFromBlob

@Deprecated
public PictureTiles getTilesFromBlob(Blob blob,
                                       int tileWidth,
                                       int tileHeight,
                                       int maxTiles,
                                       int xCenter,
                                       int yCenter,
                                       boolean fullGeneration)
                              throws ClientException

Deprecated.

Description copied from interface: PictureTilingService

Gets the picture tiles from a blob Tiles are lazily generated.

Specified by:

getTilesFromBlob in interface PictureTilingService

Returns:

Throws:

ClientException

getTiles

public PictureTiles getTiles(ImageResource resource,
                    int tileWidth,
                    int tileHeight,
                    int maxTiles,
                    int xCenter,
                    int yCenter,
                    boolean fullGeneration)
                      throws ClientException

Specified by:

getTiles in interface PictureTilingService

Throws:

ClientException

setDefaultTiler

public static void setDefaultTiler(PictureTiler tiler)

getEnv

public static Map<String,String> getEnv()

getEnvValue

public static String getEnvValue(String paramName)

getEnvValue

public static String getEnvValue(String paramName,
                 String defaultValue)

setEnvValue

public static void setEnvValue(String paramName,
               String paramValue)

getBlobProperties

public Map<String,String> getBlobProperties()

Specified by:

getBlobProperties in interface PictureTilingService

getBlobProperty

public String getBlobProperty(String docType)

Specified by:

getBlobProperty in interface PictureTilingService

getBlobProperty

public String getBlobProperty(String docType,
                     String defaultValue)

Specified by:

getBlobProperty in interface PictureTilingService

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)
                            throws Exception

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

removeCacheEntry

public void removeCacheEntry(ImageResource resource)
                      throws ClientException

Specified by:

removeCacheEntry in interface PictureTilingService

Throws:

ClientException