libreccm/ccm-cms/src/main/java/org/librecms/contentsection/ContentSection.java

/*
 * Copyright (C) 2015 LibreCCM Foundation.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */
package org.librecms.contentsection;

import org.libreccm.categorization.Category;
import org.libreccm.security.Role;
import org.libreccm.web.CcmApplication;

import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Objects;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.OneToOne;
import javax.persistence.Table;

import static org.librecms.CmsConstants.*;

/**
 *
 * @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
 */
@Entity
@Table(name = "CONTENT_SECTIONS", schema = DB_SCHEMA)
public class ContentSection extends CcmApplication implements Serializable {

    private static final long serialVersionUID = -671718122153931727L;
    
    protected static final String ROOT = "root";
    protected static final String ASSETS = "assets";
    protected static final String ALERT_RECIPIENT = "alert_recipient";
    protected static final String AUTHOR = "author";
    protected static final String EDITOR = "editor";
    protected static final String MANAGER = "manager";
    protected static final String PUBLISHER = "publisher";
    protected static final String CONTENT_READER = "content_reader";
    

    @Column(name = "LABEL", length = 512)
    private String label;

    @OneToOne
    @JoinColumn(name = "ROOT_DOCUMENTS_FOLDER_ID")
    private Category rootDocumentsFolder;

    @OneToOne
    @JoinColumn(name = "ROOT_ASSETS_FOLDER_ID")
    private Category rootAssetsFolder;

    @Column(name = "PAGE_RESOLVER_CLASS", length = 1024)
    private String pageResolverClass;

    @Column(name = "ITEM_RESOLVER_CLASS", length = 1024)
    private String itemResolverClass;

    @Column(name = "TEMPLATE_RESOLVER_CLASS", length = 1024)
    private String templateResolverClass;

    @Column(name = "XML_GENERATOR_CLASS", length = 1024)
    private String xmlGeneratorClass;

    @ManyToMany
    @JoinTable(name = "CONTENT_SECTION_ROLES",
               schema = DB_SCHEMA,
               joinColumns = {
                   @JoinColumn(name = "SECTION_ID")
               },
               inverseJoinColumns = {
                   @JoinColumn(name = "ROLE_ID")
               })
    private List<Role> roles;

    @Column(name = "DEFAULT_LOCALE")
    private Locale defaultLocale;

    public String getLabel() {
        return label;
    }

    public void setLabel(final String label) {
        this.label = label;
    }

    public Category getRootDocumentsFolder() {
        return rootDocumentsFolder;
    }

    protected void setRootDocumentFolder(final Category rootDocumentsFolder) {
        this.rootDocumentsFolder = rootDocumentsFolder;
    }

    public Category getRootAssetsFolder() {
        return rootAssetsFolder;
    }

    protected void setRootAssetsFolder(final Category rootAssetsFolder) {
        this.rootAssetsFolder = rootAssetsFolder;
    }

    public String getPageResolverClass() {
        return pageResolverClass;
    }

    public void setPageResolverClass(final String pageResolverClass) {
        this.pageResolverClass = pageResolverClass;
    }

    public String getItemResolverClass() {
        return itemResolverClass;
    }

    public void setItemResolverClass(final String itemResolverClass) {
        this.itemResolverClass = itemResolverClass;
    }

    public String getTemplateResolverClass() {
        return templateResolverClass;
    }

    public void setTemplateResolverClass(final String templateResolverClass) {
        this.templateResolverClass = templateResolverClass;
    }

    public String getXmlGeneratorClass() {
        return xmlGeneratorClass;
    }

    public void setXmlGeneratorClass(final String xmlGeneratorClass) {
        this.xmlGeneratorClass = xmlGeneratorClass;
    }

    public List<Role> getRoles() {
        return Collections.unmodifiableList(roles);
    }

    protected void setRoles(final List<Role> roles) {
        this.roles = roles;
    }

    protected void addRole(final Role role) {
        roles.add(role);
    }

    protected void removeRole(final Role role) {
        roles.remove(role);
    }

    public Locale getDefaultLocale() {
        return defaultLocale;
    }

    public void setDefaultLocale(final Locale defaultLocale) {
        this.defaultLocale = defaultLocale;
    }

    @Override
    public int hashCode() {
        int hash = super.hashCode();
        hash = 47 * hash + Objects.hashCode(label);
        hash = 47 * hash + Objects.hashCode(rootDocumentsFolder);
        hash = 47 * hash + Objects.hashCode(rootAssetsFolder);
        hash = 47 * hash + Objects.hashCode(pageResolverClass);
        hash = 47 * hash + Objects.hashCode(itemResolverClass);
        hash = 47 * hash + Objects.hashCode(templateResolverClass);
        hash = 47 * hash + Objects.hashCode(xmlGeneratorClass);
        hash = 47 * hash + Objects.hashCode(defaultLocale);
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }

        if (!super.equals(obj)) {
            return false;
        }

        if (!(obj instanceof ContentSection)) {
            return false;
        }

        final ContentSection other = (ContentSection) obj;
        if (!other.canEqual(this)) {
            return false;
        }

        if (!Objects.equals(label, other.getLabel())) {
            return false;
        }
        if (!Objects.equals(rootDocumentsFolder, other.getRootDocumentsFolder())) {
            return false;
        }
        if (!Objects.equals(rootAssetsFolder, other.getRootAssetsFolder())) {
            return false;
        }
        if (!Objects.equals(pageResolverClass, other.getPageResolverClass())) {
            return false;
        }
        if (!Objects.equals(itemResolverClass, other.getItemResolverClass())) {
            return false;
        }
        if (!Objects.equals(templateResolverClass,
                            other.getTemplateResolverClass())) {
            return false;
        }
        if (!Objects.equals(xmlGeneratorClass, other.getXmlGeneratorClass())) {
            return false;
        }
        return Objects.equals(defaultLocale, other.getDefaultLocale());
    }

    @Override
    public boolean canEqual(final Object obj) {
        return obj instanceof ContentSection;
    }

    @Override
    public String toString(final String data) {
        return super.toString(String.format(
            ", label = \"%s\", "
                + "rootDocumentsFolder = \"%s\", "
                + "rootAssetsFolder = \"%s\", "
                + "pageResolverClass = \"%s\", "
                + "itemResolverClass = \"%s\", "
                + "templateResolverClass = \"%s\", "
                + "xmlGeneratorClass = \"%s\", "
                + "defaultLocale = \"%s\"%s",
            label,
            Objects.toString(rootDocumentsFolder),
            Objects.toString(rootAssetsFolder),
            pageResolverClass,
            itemResolverClass,
            templateResolverClass,
            xmlGeneratorClass,
            Objects.toString(defaultLocale),
            data));
    }

}