org.xcmis.spi
Class RenditionManager

java.lang.Object
  extended by org.xcmis.spi.RenditionManager

public class RenditionManager
extends Object

Manage object's renditions.

Version:
$Id$
Author:
Andrey Parfonov

Field Summary
protected  Map<MimeType,RenditionProvider> renditionProviders
           
 
Constructor Summary
protected RenditionManager()
           
 
Method Summary
 void addRenditionProviders(List<String> provs)
           
static RenditionManager getInstance()
           
 ItemsIterator<Rendition> getRenditions(MimeType mime)
          Get all renditions using all available RenditionProvider that can provide rendition for specified mime-type.
 ItemsIterator<Rendition> getRenditions(ObjectData object)
          Get all renditions of specified entry.
 RenditionContentStream getStream(ContentStream stream, MimeType mime)
          Get rendition from content stream with known mime-type and use most suitable RenditionProvider.
 RenditionContentStream getStream(ObjectData object, String streamId)
          Get rendition stream for objects with specified stream id.
static void setInstance(RenditionManager inst)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

renditionProviders

protected Map<MimeType,RenditionProvider> renditionProviders
Constructor Detail

RenditionManager

protected RenditionManager()
Method Detail

getInstance

public static RenditionManager getInstance()

setInstance

public static void setInstance(RenditionManager inst)

addRenditionProviders

public void addRenditionProviders(List<String> provs)

getRenditions

public ItemsIterator<Rendition> getRenditions(MimeType mime)
Get all renditions using all available RenditionProvider that can provide rendition for specified mime-type.

Parameters:
@param - mime MimeType
Returns:
set of object renditions. If object has not renditions then empty iterator will be returned
Throws:
NullPointerException - if mime == null

getRenditions

public ItemsIterator<Rendition> getRenditions(ObjectData object)
Get all renditions of specified entry.

Parameters:
object - object for getting renditions
Returns:
set of object renditions. If object has not renditions then empty iterator will be returned

getStream

public RenditionContentStream getStream(ContentStream stream,
                                        MimeType mime)
                                 throws IOException
Get rendition from content stream with known mime-type and use most suitable RenditionProvider. For example if two RenditionProviders registered: and provided MimeType is 'image/jpeg' then second provider from list will be in use.

Parameters:
mime - MimeType
stream - ContentStream
Returns:
rendition content stream or null if there is no RenditionProvider which can produce stream for requested type
Throws:
IOException - if any I/O error occurs

getStream

public RenditionContentStream getStream(ObjectData object,
                                        String streamId)
                                 throws IOException
Get rendition stream for objects with specified stream id.

Parameters:
streamId - stream id
obj - ObjectData
Returns:
Renditions content stream
Throws:
IOException - if any I/O error occurs


Copyright © 2003-2013 eXo Platform SAS. All Rights Reserved.