Return to AbstractContainer.java CVS log

Up to [Public] / java / classes / org / w3c / tools / resources

generics + raw types + serializer

// ContainerInterfaceImpl.java
// $Id: AbstractContainer.java,v 1.11 2013/10/18 13:42:25 ylafon Exp $
// (c) COPYRIGHT MIT and INRIA, 1996.
// Please first read the full copyright statement in file COPYRIGHT.html

package org.w3c.tools.resources;

import java.util.Enumeration;
import java.util.Map;
import org.w3c.tools.resources.event.AttributeChangedEvent;
import org.w3c.tools.resources.event.AttributeChangedListener;
import org.w3c.tools.resources.event.StructureChangedEvent;
import org.w3c.tools.resources.event.StructureChangedListener;

/**
 * The top level class for Resource Container.
 */
public abstract class AbstractContainer extends FramedResource
        implements ContainerInterface,
        StructureChangedListener,
        AttributeChangedListener {

    public static String ur = "url".intern();

    /**
     * This handles the <code>RESOURCE_MODIFIED</code> kind of events.
     *
     * @param evt The StructureChangeEvent.
     */

    public void resourceModified(StructureChangedEvent evt) {
        if (debugEvent)
            displayEvent(this, evt);
    }

    /**
     * A new resource has been created in some space.
     * This handles the <code>RESOURCE_CREATED</code> kind of events.
     *
     * @param evt The event describing the change.
     */

    public void resourceCreated(StructureChangedEvent evt) {
        if (debugEvent)
            displayEvent(this, evt);
    }

    /**
     * A resource is about to be removed
     * This handles the <code>RESOURCE_REMOVED</code> kind of events.
     *
     * @param evt The event describing the change.
     */

    public void resourceRemoved(StructureChangedEvent evt) {
        if (debugEvent)
            displayEvent(this, evt);
    }

    /**
     * A resource is about to be unloaded
     * This handles the <code>RESOURCE_UNLOADED</code> kind of events.
     *
     * @param evt The event describing the change.
     */

    public void resourceUnloaded(StructureChangedEvent evt) {
        // don't display event here, because the resource is about
        // to be unloaded.
    }

    /**
     * Gets called when a property changes.
     *
     * @param evt The AttributeChangeEvent describing the change.
     */

    public void attributeChanged(AttributeChangedEvent evt) {
        if (debugEvent)
            displayEvent(this, evt);
    }

    /**
     * Enumerate children resource identifiers.
     *
     * @param all Should all resources be enumerated ? Resources are often
     *            created on demand only, this flag allows the caller to tell the
     *            container about wether it is interested only in already created
     *            resources, or in all resources (even the one that have not yet been
     *            created).
     * @return An String enumeration, one element per child.
     */

    abstract public Enumeration<String> enumerateResourceIdentifiers(boolean all);

    public Enumeration<String> enumerateResourceIdentifiers() {
        return enumerateResourceIdentifiers(true);
    }

    /**
     * Ask our frames to update default child attributes.
     *
     * @param attrs A hashtable.
     */
    protected ResourceContext updateDefaultChildAttributes(Map<String, Object> attrs) {
        ResourceFrame frames[] = getFrames();
        if (frames != null) {
            for (ResourceFrame rf : frames) {
                if (rf != null) {
                    rf.updateDefaultChildAttributes(attrs);
                }
            }
        }
        return (ResourceContext) attrs.get(co);
    }

    /**
     * Lookup a children in the container.
     *
     * @param name The name of the children to lookup.
     *             the resource from its store.
     */

    abstract public ResourceReference lookup(String name);

    /**
     * Remove a child resource from that container.
     *
     * @param name The name of the child to remove.
     * @throws MultipleLockException If someone else
     *                               has locked the resource.
     */

    abstract public void delete(String name)
            throws MultipleLockException;

    /**
     * Create a default child resource in that container.
     * This method is called by the editor to add a default resource
     * in the container under the given name. The meaning of <em>default</em>
     * is left up to the container here.
     *
     * @param name The identifier for the new resource.
     */
    abstract public ResourceReference createDefaultResource(String name);

    /**
     * Initialize and register the given resource within that container.
     *
     * @param name     The identifier for the resource.
     * @param resource An unitialized resource instance.
     * @param defs     A default set of init attribute values (may be
     *                 <strong>null</strong>).
     * @throws InvalidResourceException If an error occurs during the
     *                                  registration.
     */

    abstract public void registerResource(String name,
                                          Resource resource,
                                          Map<String, Object> defs)
            throws InvalidResourceException;
}