ComponentDeliveryContext.java

/* ===============================================================================
 *
 * Part of the InfoGlue Content Management Platform (www.infoglue.org)
 *
 * ===============================================================================
 *
 *  Copyright (C)
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 2, as published by the
 * Free Software Foundation. See the file LICENSE.html for more information.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY, including the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc. / 59 Temple
 * Place, Suite 330 / Boston, MA 02111-1307 / USA.
 *
 * ===============================================================================
 */

package org.infoglue.deliver.applications.databeans;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.infoglue.deliver.applications.actions.InfoGlueComponent;

/**
 * @author Mattias Bogeblad
 *
 * This class is used to store the context of a page and get and set information that is central to it.
 * TODO - write more
 */

public class ComponentDeliveryContext implements UsageListener
{
	private String componentKey = null;
	//private InfoGlueComponent infoGlueComponent;
	    
	//This section has control over what contents and sitenodes are used where so the pagecache can be selectively updated.
	private Set<String> usedContents 			= new HashSet<String>();
	private Set<String> usedContentVersions 	= new HashSet<String>();
	private Set<String> usedSiteNodes 			= new HashSet<String>();
	private Set<String> usedSiteNodeVersions 	= new HashSet<String>();
	
	//private DeliveryContext deliveryContext;
	private String pageKey = null;
	
	public static ComponentDeliveryContext getComponentDeliveryContext(DeliveryContext deliveryContext, InfoGlueComponent infoGlueComponent)
	{
		return new ComponentDeliveryContext(deliveryContext, infoGlueComponent);
	}
	
	private ComponentDeliveryContext(DeliveryContext deliveryContext, InfoGlueComponent infoGlueComponent)
	{
		this.pageKey = deliveryContext.getPageKey();
	    //this.deliveryContext = deliveryContext;
	    //this.infoGlueComponent = infoGlueComponent;
 		this.componentKey = pageKey + "_" + infoGlueComponent.getId();
	}
	
    public void addUsedContent(String usedContent)
    {
        synchronized(usedContents)
        {
        	this.usedContents.add(usedContent);
        }
    }

    public void addUsedSiteNode(String usedSiteNode)
    {
    	synchronized(usedSiteNodes)
        {
            this.usedSiteNodes.add(usedSiteNode);
        }
    }

    public void addUsedContentVersion(String usedContentVersion)
    {
        synchronized(usedContentVersions)
        {
            this.usedContentVersions.add(usedContentVersion);
        }
    }

    public void addUsedSiteNodeVersion(String usedSiteNodeVersion)
    {
        synchronized(usedSiteNodeVersions)
        {
            this.usedSiteNodeVersions.add(usedSiteNodeVersion);
        }
    }
    
    public String[] getAllUsedEntities()
    {
        List<String> list = new ArrayList<String>();
        synchronized(usedContents)
        {
            list.addAll(this.usedContents);
        }
        
        synchronized(usedContentVersions)
        {
            list.addAll(this.usedContentVersions);
        }
        
        synchronized(usedSiteNodes)
        {
            list.addAll(this.usedSiteNodes);
        }
        
        synchronized(usedSiteNodeVersions)
        {
            list.addAll(this.usedSiteNodeVersions);
        }
        
        Object[] array = list.toArray();
        String[] groups = new String[array.length];
        for(int i=0; i<array.length; i++)
            groups[i] = array[i].toString();
        
        return groups;
    }
    
    public String getComponentKey()
    {
        return componentKey;
    }

    public String getPageKey()
    {
        return pageKey; //this.deliveryContext.getPageKey();
    }
}