001/*
002 * (C) Copyright 2006-2016 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 */
019package org.nuxeo.ecm.platform.pictures.tiles.api.adapter;
020
021import org.nuxeo.ecm.core.api.DocumentModel;
022import org.nuxeo.ecm.platform.pictures.tiles.api.PictureTiles;
023
024/**
025 * Interface for the DocumentModelAdapter that gives access to the PictureTiles of the underlying image.
026 *
027 * @author tiry
028 */
029public interface PictureTilesAdapter {
030
031    PictureTiles getTiles(int tileWidth, int tileHeight, int maxTiles);
032
033    void setXPath(String path);
034
035    void setDoc(DocumentModel doc);
036
037    /**
038     * @deprecated since 9.1 as filename is now hold by the blob and no longer exist beside it
039     */
040    @Deprecated
041    void setFileName(String fileName);
042
043    void cleanup();
044}