source: extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/dao/TagDao.java @ 9392

package fr.mael.jiwigo.dao;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import org.jdom.Document;
import org.jdom.Element;

import fr.mael.jiwigo.om.Image;
import fr.mael.jiwigo.om.Tag;
import fr.mael.jiwigo.transverse.enumeration.MethodsEnum;
import fr.mael.jiwigo.transverse.enumeration.TagEnum;
import fr.mael.jiwigo.transverse.session.SessionManager;
import fr.mael.jiwigo.transverse.util.Tools;

/**
 * Dao of the categories
 * @author mael
 *
 */
public class TagDao {
    /**
     * Logger
     */
    public static final org.apache.commons.logging.Log LOG = org.apache.commons.logging.LogFactory.getLog(TagDao.class);
    /**
     * Instance, to use a singleton
     */
    private static TagDao instance;

    private SessionManager sessionManager;

    /**
     * private constructor to use a singleton
     */
    private TagDao(SessionManager sessionManager) {
        this.sessionManager = sessionManager;
    }

    /**
     * @return the instance
     */
    public static TagDao getInstance(SessionManager sessionManager) {
        if (instance == null) {
            instance = new TagDao(sessionManager);
        }
        return instance;
    }

    /**
     * lists the tags
     * @return the list of tags
     * @throws IOException
     */
    public List<Tag> list() throws IOException {
        Document doc = sessionManager.executeReturnDocument(MethodsEnum.TAGS_ADMIN_LIST.getLabel());
        //      System.out.println(Outil.documentToString(doc));
        return getTagsFromDocument(doc.getRootElement().getChild("tags"));

    }

    /**
     * COnstructs a list of tags from a document
     * @param doc the document
     * @return the list of tags
     */
    private List<Tag> getTagsFromDocument(Element element) {

        List<Element> listElement = (List<Element>) element.getChildren("tag");
        ArrayList<Tag> tags = new ArrayList<Tag>();
        for (Element tagElement : listElement) {
            Tag tag = new Tag();
            tag.setIdentifier(Integer.valueOf(tagElement.getAttributeValue(TagEnum.ID.getLabel())));
            tag.setName(tagElement.getAttributeValue(TagEnum.NAME.getLabel()));
            tags.add(tag);
        }
        return tags;

    }

    /**
     * Creation of a tag
     * @param tag the tag to create
     * @return true if the tag as been successfully created
     */
    public boolean create(Tag tag) {
        try {
            return Tools.checkOk(sessionManager.executeReturnDocument(MethodsEnum.ADD_TAG.getLabel(), "name", tag
                    .getName()));
        } catch (IOException e) {
            LOG.error(Tools.getStackTrace(e));
        }
        return false;
    }

    /**
     * Function that returns the tags for an image
     * @param image the image
     * @return the tags list
     * @throws IOException
     */
    public List<Tag> tagsForImage(Image image) throws IOException {
        Document doc = sessionManager.executeReturnDocument(MethodsEnum.GET_INFO.getLabel(), "image_id", String
                .valueOf(image.getIdentifier()));
        return getTagsFromDocument(doc.getRootElement().getChild("image").getChild("tags"));
    }

}