package de.intevation.artifacts;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

/**
 * Interface of an artifact producing factory.
 *
 * @author Sascha L. Teichmann (sascha.teichmann@intevation.de)
 */
public interface ArtifactFactory
{
    /**
     * The short name of this factory.
     * @return the name of this factory.
     */
    String getName();

    /**
     * Description of this factory.
     * @return description of the factory.
     */
    String getDescription();

    /**
     * Create a new artifact of certain type, given a general purpose context and
     * an identifier.
     * @param context a context from the ArtifactDatabase.
     * @param identifier unique identifer for the new artifact
     * @return a new {@linkplain de.intevation.artifacts.Artifact Artifact}
     */
    Artifact createArtifact(String identifier, Object context);

    /**
     * Setup the factory with a given configuration
     * @param config the configuration
     * @param factoryNode the ConfigurationNode of this Factory
     */
    void setup(Document config, Node factoryNode);
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8: