org.exoplatform.services.cms.thumbnail

Interface ThumbnailService

All Known Implementing Classes:

ThumbnailServiceImpl

public interface ThumbnailService

This service will be support to create thumbnail for node Get image and any file type in node

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIG_SIZE
static String	EXO_THUMBNAIL
static String	EXO_THUMBNAILS
static String	EXO_THUMBNAILS_FOLDER
static String	HIDDENABLE_NODETYPE
static String	MEDIUM_SIZE
static String	SMALL_SIZE
static String	THUMBNAIL_LAST_MODIFIED

Method Summary

Modifier and Type	Method and Description
void	addPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Add Thumbnail Plugin
void	addThumbnailImage(javax.jcr.Node node, BufferedImage image, String propertyName) Add a thumbnail image to node
javax.jcr.Node	addThumbnailNode(javax.jcr.Node node) Create thumbnail node
void	copyThumbnailNode(javax.jcr.Node srcThumbnailNode, javax.jcr.Node destNode) Copy thumbnail node to destination node after moving or copy/paste.
void	createSpecifiedThumbnail(javax.jcr.Node node, BufferedImage image, String propertyName) Create a thumbnail for node with size specified
void	createThumbnailImage(javax.jcr.Node node, BufferedImage image, String mimeType) Create thumbnail for node with default size: Small size, medium size, big size
List<javax.jcr.Node>	getAllFileInNode(javax.jcr.Node node) Return all nt:file node at current node
List<org.exoplatform.container.component.ComponentPlugin>	getComponentPlugins() Return a list of Thumbnail plugin
List<javax.jcr.Node>	getFileNodesByType(javax.jcr.Node node, String jcrMimeType) Return the list of node in the current node with mimetype specified
List<javax.jcr.Node>	getFlowImages(javax.jcr.Node node) Return a list image in node
List<String>	getMimeTypes() Get mime types which allow to view
InputStream	getThumbnailImage(javax.jcr.Node node, String thumbnailType) Return the data of thumbnail with specified type
javax.jcr.Node	getThumbnailNode(javax.jcr.Node node) Get thumbnail node
boolean	isEnableThumbnail() Return the status of node is enable thumbnail or not
void	processRemoveThumbnail(javax.jcr.Node showingNode) Process to remove thumbnail
void	processThumbnailList(List<javax.jcr.Node> listNodes, String type) Process thumbnail with list nodes
void	setEnableThumbnail(boolean isEnable) To setup status of node is allow thumbnail or not

Field Detail

EXO_THUMBNAILS

static final String EXO_THUMBNAILS

See Also:

Constant Field Values

EXO_THUMBNAIL

static final String EXO_THUMBNAIL

See Also:

Constant Field Values

SMALL_SIZE

static final String SMALL_SIZE

See Also:

Constant Field Values

MEDIUM_SIZE

static final String MEDIUM_SIZE

See Also:

Constant Field Values

BIG_SIZE

static final String BIG_SIZE

See Also:

Constant Field Values

THUMBNAIL_LAST_MODIFIED

static final String THUMBNAIL_LAST_MODIFIED

See Also:

Constant Field Values

EXO_THUMBNAILS_FOLDER

static final String EXO_THUMBNAILS_FOLDER

See Also:

Constant Field Values

HIDDENABLE_NODETYPE

static final String HIDDENABLE_NODETYPE

See Also:

Constant Field Values

Method Detail

getAllFileInNode

List<javax.jcr.Node> getAllFileInNode(javax.jcr.Node node)
                               throws javax.jcr.RepositoryException

Return all nt:file node at current node

Parameters:

node - Current node

Returns:

all nt:file nodes

Throws:

javax.jcr.RepositoryException

getFileNodesByType

List<javax.jcr.Node> getFileNodesByType(javax.jcr.Node node,
                                        String jcrMimeType)
                                 throws Exception

Return the list of node in the current node with mimetype specified

Parameters:

node - Current node

jcrMimeType - Mime type of node will be retrieve

Returns:

node list

Throws:

Exception

getFlowImages

List<javax.jcr.Node> getFlowImages(javax.jcr.Node node)
                            throws Exception

Return a list image in node

Parameters:

node - Current node

Returns:

images nodes list

Throws:

Exception

setEnableThumbnail

void setEnableThumbnail(boolean isEnable)

To setup status of node is allow thumbnail or not

Parameters:

isEnable -

isEnableThumbnail

boolean isEnableThumbnail()

Return the status of node is enable thumbnail or not

Returns:

Boolean value

createThumbnailImage

void createThumbnailImage(javax.jcr.Node node,
                          BufferedImage image,
                          String mimeType)
                   throws Exception

Create thumbnail for node with default size: Small size, medium size, big size

Parameters:

node - Current node which will be added thumbnail

image - BufferedImage which contain the original image

mimeType - File type

Throws:

Exception

getThumbnailImage

InputStream getThumbnailImage(javax.jcr.Node node,
                              String thumbnailType)
                       throws Exception

Return the data of thumbnail with specified type

Parameters:

node - Current node which will be added thumbnail

thumbnailType - Type of thumbnail will be return (small, medium, big or specified if has)

Throws:

Exception

addThumbnailNode

javax.jcr.Node addThumbnailNode(javax.jcr.Node node)
                         throws Exception

Create thumbnail node

Parameters:

node - Current node which included thumbnail

Returns:

Node

Throws:

Exception

getThumbnailNode

javax.jcr.Node getThumbnailNode(javax.jcr.Node node)
                         throws Exception

Get thumbnail node

Parameters:

node -

Returns:

Node

Throws:

Exception

createSpecifiedThumbnail

void createSpecifiedThumbnail(javax.jcr.Node node,
                              BufferedImage image,
                              String propertyName)
                       throws Exception

Create a thumbnail for node with size specified

Parameters:

node - Current node which will be added thumbnail

image - BufferedImage which contain the original image

propertyName - Data will be set to this property

Throws:

Exception

addThumbnailImage

void addThumbnailImage(javax.jcr.Node node,
                       BufferedImage image,
                       String propertyName)
                throws Exception

Add a thumbnail image to node

Parameters:

node - Current node which will be added thumbnail

image - BufferedImage which contain the original image

propertyName - Data will be set to this property

Throws:

Exception

processThumbnailList

void processThumbnailList(List<javax.jcr.Node> listNodes,
                          String type)
                   throws Exception

Process thumbnail with list nodes

Parameters:

listNodes - List node which will be process to add thumbnail

type - Type of thumbnail image

Throws:

Exception

getMimeTypes

List<String> getMimeTypes()

Get mime types which allow to view

Returns:

mimetypes list

processRemoveThumbnail

void processRemoveThumbnail(javax.jcr.Node showingNode)
                     throws Exception

Process to remove thumbnail

Parameters:

showingNode - Node contain the thumbnail

Throws:

Exception

copyThumbnailNode

void copyThumbnailNode(javax.jcr.Node srcThumbnailNode,
                       javax.jcr.Node destNode)
                throws Exception

Copy thumbnail node to destination node after moving or copy/paste.

Parameters:

srcThumbnailNode - thumbnailNode of source node

destNode - destination Node

Throws:

Exception

addPlugin

void addPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Add Thumbnail Plugin

Parameters:

plugin - ComponentPlugin

getComponentPlugins

List<org.exoplatform.container.component.ComponentPlugin> getComponentPlugins()

Return a list of Thumbnail plugin

Returns:

ComponentPlugin list