PageNode.java

/**
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.exoplatform.portal.config.model;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.exoplatform.portal.mop.Visibility;
import org.exoplatform.portal.mop.navigation.AttributesState;
import org.exoplatform.portal.mop.navigation.NodeState;
import org.exoplatform.portal.mop.page.PageKey;

/**
 * @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
 *
 */
public class PageNode extends PageNodeContainer {

    /** . */
    private I18NString labels;

    /** . */
    private String icon;

    /** . */
    private String name;

    /** . */
    private Date startPublicationDate;

    /** . */
    private Date endPublicationDate;

    /** . */
    private Visibility visibility = Visibility.DISPLAYED;

    /** . */
    private String pageReference;

    private boolean restrictOutsidePublicationWindow;

    /** . */
    private Properties properties;

    public PageNode() {
    }

    /**
     * Always returns {@code null} as there is no <code><uri></code> since gatein_objects_1_4.
     * @return
     */
    public String getUri() {
        return null;
    }

    /**
     * Ignored but still here for backwards compatibility
     *
     * @param s ignored
     */
    public void setUri(String s) {
    }

    public I18NString getLabels() {
        return labels;
    }

    public void setLabels(I18NString labels) {
        this.labels = labels;
    }

    public String getLabel() {
        if (labels != null) {
            for (LocalizedString label : labels) {
                if (label.getLang() == null) {
                    return label.getValue();
                }
            }
        }
        return null;
    }

    public void setLabel(String s) {
        if (labels == null) {
            labels = new I18NString();
        } else {
            labels.clear();
        }
        labels.add(new LocalizedString(s));
    }

    public String getIcon() {
        return icon;
    }

    public void setIcon(String s) {
        icon = s;
    }

    public String getPageReference() {
        return pageReference;
    }

    public void setPageReference(String s) {
        pageReference = s;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public List<PageNode> getChildren() {
        return getNodes();
    }

    public void setChildren(ArrayList<PageNode> children) {
        setNodes(children);
    }

    public Date getStartPublicationDate() {
        return startPublicationDate;
    }

    public void setStartPublicationDate(Date startDate) {
        startPublicationDate = startDate;
    }

    public Date getEndPublicationDate() {
        return endPublicationDate;
    }

    public void setEndPublicationDate(Date endDate) {
        endPublicationDate = endDate;
    }

    public void setVisibility(Visibility visibility) {
        this.visibility = visibility;
    }

    public Visibility getVisibility() {
        return this.visibility;
    }

    public PageNode getChild(String name) {
        return getNode(name);
    }

    public Properties getProperties() {
        if (properties == null)
            properties = new Properties();
        return properties;
    }

    public void setProperties(Properties properties) {
        this.properties = properties;
    }

    public NodeState getState() {
        return new NodeState(labels.getSimple(), icon, startPublicationDate == null ? -1 : startPublicationDate.getTime(),
                endPublicationDate == null ? -1 : endPublicationDate.getTime(), visibility,
                pageReference != null ? PageKey.parse(pageReference) : null,
                restrictOutsidePublicationWindow,
                new AttributesState.Builder(properties).build());
    }

    @Override
    public String toString() {
        return "PageNode[" + name + "]";
    }

    public boolean isRestrictOutsidePublicationWindow() {
        return restrictOutsidePublicationWindow;
    }

    public void setRestrictOutsidePublicationWindow(boolean restrictOutsidePublicationWindow) {
        this.restrictOutsidePublicationWindow = restrictOutsidePublicationWindow;
    }
}