com.github.wuic.engine.core

Class ImageAggregatorEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.AbstractAggregatorEngine

com.github.wuic.engine.core.ImageAggregatorEngine

All Implemented Interfaces:

Comparable<Engine>

@EngineService(injectDefaultToWorkflow=true,
               isCoreEngine=true)
public class ImageAggregatorEngine
extends AbstractAggregatorEngine

This engine is in charge to merge images into one final image.

Since:

0.2.0

Version:

1.8

Author:

Guillaume DROUET

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATION_NAME The path name when images are aggregated.

Constructor Summary

Constructors

Constructor and Description
ImageAggregatorEngine(Boolean aggregate, DimensionPacker<ConvertibleNut> packer) Builds a new aggregator engine.

Method Summary

Methods

Modifier and Type	Method and Description
List<ConvertibleNut>	aggregationParse(EngineRequest request) Do aggregation parsing.
Dimension	getDimensionPack() Gets the dimension computed by the packer when defining a position for elements.
List<NutType>	getNutTypes() Gets the all types supported by this engine.
static BufferedImage	makeTransparentImage(int width, int height) Makes a transparent image of the given dimensions.
Map<Region,ConvertibleNut>	pack(List<ConvertibleNut> nuts) Packs the given nuts (which embed images) in the smallest area.

Methods inherited from class com.github.wuic.engine.core.AbstractAggregatorEngine

aggregationName, getEngineType, internalParse, works

Methods inherited from class com.github.wuic.engine.NodeEngine

callNextEngine, chain, getNext, getPrevious, parse, setNext

Methods inherited from class com.github.wuic.engine.Engine

compareTo

Methods inherited from class java.lang.Object

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

Field Detail

AGGREGATION_NAME

public static final String AGGREGATION_NAME

The path name when images are aggregated.

Constructor Detail

ImageAggregatorEngine

@ConfigConstructor
public ImageAggregatorEngine(@BooleanConfigParam(defaultValue=true,propertyKey="c.g.wuic.engine.aggregate")
                                       Boolean aggregate,
                                       @ObjectConfigParam(defaultValue="com.github.wuic.engine.core.BinPacker",propertyKey="c.g.wuic.engine.packerClassName")
                                       DimensionPacker<ConvertibleNut> packer)

Builds a new aggregator engine.

Parameters:

aggregate - if aggregation should be activated or not

Method Detail

aggregationParse

public List<ConvertibleNut> aggregationParse(EngineRequest request)
                                      throws WuicException

Do aggregation parsing.

Specified by:

aggregationParse in class AbstractAggregatorEngine

Parameters:

request - the request

Returns:

the aggregated nuts

Throws:

WuicException - if an error occurs

makeTransparentImage

public static BufferedImage makeTransparentImage(int width,
                                 int height)

Makes a transparent image of the given dimensions.

Parameters:

width - the image width

height - the image height

Returns:

transparent image

getNutTypes

public List<NutType> getNutTypes()

Gets the all types supported by this engine.

Specified by:

getNutTypes in class NodeEngine

Returns:

the NutType

pack

public Map<Region,ConvertibleNut> pack(List<ConvertibleNut> nuts)
                                throws WuicException

Packs the given nuts (which embed images) in the smallest area.

Parameters:

nuts - the images to pack

Returns:

a map which associates each packed image to its allocated region

Throws:

WuicException - if one image could not be read

getDimensionPack

public Dimension getDimensionPack()

Gets the dimension computed by the packer when defining a position for elements.

Returns:

the packed dimension