org.nuxeo.ecm.platform.picture.api.adapters

Interface PictureResourceAdapter

All Known Implementing Classes:

AbstractPictureAdapter, DefaultPictureAdapter, NoPictureAdapter

public interface PictureResourceAdapter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createPicture(Blob fileContent, String filename, String title, ArrayList<Map<String,Object>> pictureConversions) Deprecated. since 5.7. Use fillPictureViews(org.nuxeo.ecm.core.api.Blob, String, String, java.util.ArrayList) instead.
void	doCrop(String coords)
void	doRotate(int angle)
boolean	fillPictureViews(Blob blob, String filename, String title) This method just delegate the job to fillPictureViews(Blob, String, String, ArrayList) by passing null instead of statics picture templates.
boolean	fillPictureViews(Blob blob, String filename, String title, ArrayList<Map<String,Object>> pictureConversions) Fill this Picture views using the given pictureConversions and blob to compute the picture views.
String	getFirstViewXPath() Convenience method to get the XPath of the first view of the Picture.
Blob	getPictureFromTitle(String title)
String	getViewXPath(String viewName) Returns the XPath of the given view name, or null if the view is not found on the Picture.
void	preFillPictureViews(Blob blob, List<Map<String,Object>> pictureConversions, ImageInfo imageInfo) Pre-fill this Picture views using the given pictureConversions and blob.
void	setDocumentModel(DocumentModel doc)

Method Detail

setDocumentModel

void setDocumentModel(DocumentModel doc)

createPicture

@Deprecated
boolean createPicture(Blob fileContent,
                               String filename,
                               String title,
                               ArrayList<Map<String,Object>> pictureConversions)
                      throws IOException,
                             ClientException

Deprecated. since 5.7. Use fillPictureViews(org.nuxeo.ecm.core.api.Blob, String, String, java.util.ArrayList) instead.

Throws:

IOException

ClientException

fillPictureViews

boolean fillPictureViews(Blob blob,
                       String filename,
                       String title,
                       ArrayList<Map<String,Object>> pictureConversions)
                         throws IOException,
                                ClientException

Fill this Picture views using the given pictureConversions and blob to compute the picture views.

The blob is converted to fit the defined pictureConversions.

Throws:

IOException

ClientException

Since:

5.7

fillPictureViews

boolean fillPictureViews(Blob blob,
                       String filename,
                       String title)
                         throws IOException,
                                ClientException

This method just delegate the job to fillPictureViews(Blob, String, String, ArrayList) by passing null instead of statics picture templates.

This will fill the picture views by using the registered picture templates.

Throws:

IOException

ClientException

Since:

6.9.6

See Also:

PictureResourceAdapter#fillPictureViews(Blob, String, String, ArrayList)}

preFillPictureViews

void preFillPictureViews(Blob blob,
                       List<Map<String,Object>> pictureConversions,
                       ImageInfo imageInfo)
                         throws IOException,
                                ClientException

Pre-fill this Picture views using the given pictureConversions and blob.

The blob is not converted and just stored as the Blob of the picture views.

Throws:

IOException

ClientException

Since:

5.7

doRotate

void doRotate(int angle)
              throws ClientException

Throws:

ClientException

doCrop

void doCrop(String coords)
            throws ClientException

Throws:

ClientException

getPictureFromTitle

Blob getPictureFromTitle(String title)
                         throws PropertyException,
                                ClientException

Throws:

PropertyException

ClientException

getViewXPath

String getViewXPath(String viewName)

Returns the XPath of the given view name, or null if the view is not found on the Picture.

Parameters:

viewName - the view name

getFirstViewXPath

String getFirstViewXPath()

Convenience method to get the XPath of the first view of the Picture.

Returns:

the XPath of the first view