IRootArtifact.java

package org.bundlemaker.core.analysis;

import java.util.concurrent.Callable;

import org.bundlemaker.core.internal.modules.Group;
import org.bundlemaker.core.resource.IModularizedSystem;
import org.bundlemaker.core.resource.IModule;
import org.bundlemaker.core.resource.IModuleResource;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;

import com.tinkerpop.blueprints.Graph;

/**
 * <p>
 * Defines the root {@link IBundleMakerArtifact} that holds the {@link IModularizedSystem} instance.
 * </p>
 * <p>
 * An {@link IRootArtifact} can contain {@link IGroupArtifact IGroupArtifacts} and {@link IModuleArtifact
 * IModuleArtifacts} and therefore extends the interface {@link IGroupAndModuleContainer}.
 * </p>
 * 
 * @author Nils Hartmann (nils@nilshartmann.net)
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface IRootArtifact extends IBundleMakerArtifact, IGroupAndModuleContainer, Graph {

  /**
   * <p>
   * Resets all transformations that has been applied to this
   * </p>
   */
  void resetTransformations();

  /**
   * <p>
   * Adds the specified {@link IAnalysisModelModifiedListener} to the artifact tree.
   * </p>
   * 
   * @param listener
   *          the listener to add (must not be null)
   */
  void addAnalysisModelModifiedListener(IAnalysisModelModifiedListener listener);

  /**
   * <p>
   * Removes the specified {@link IAnalysisModelModifiedListener} from the artifact tree.
   * </p>
   * 
   * @param listener
   *          the listener to remove (must not be null)
   */
  void removeAnalysisModelModifiedListener(IAnalysisModelModifiedListener listener);

  /**
   * <p>
   * </p>
   * 
   * @param isDisabled
   */
  void disableModelModifiedNotification(boolean isDisabled);

  /**
   * <p>
   * </p>
   * 
   * @return
   */
  boolean isModelModifiedNotificationDisabled();

  /**
   * <p>
   * </p>
   * 
   * @return
   */
  boolean areCachesInitialized();

  /**
   * <p>
   * </p>
   * 
   * @param progressMonitor
   */
  void initializeCaches(IProgressMonitor progressMonitor);

  /**
   * <p>
   * Returns the {@link IGroupArtifact} for the given {@link IGroup}.
   * </p>
   * 
   * @param group
   *          (must not be null)
   * @return the {@link IGroupArtifact} for the given {@link IGroup} (maybe null)
   */
  IGroupArtifact getGroupArtifact(Group group);

  /**
   * <p>
   * Returns the {@link IModuleArtifact} for the given {@link IModule}.
   * </p>
   * 
   * @param module
   *          (must not be null)
   * @return the {@link IModuleArtifact} for the given {@link IModule} (maybe null)
   */
  IModuleArtifact getModuleArtifact(IModule module);

  /**
   * <p>
   * Returns the {@link IResourceArtifact} for the given {@link IModuleResource}.
   * </p>
   * 
   * @param resource
   *          (must not be null)
   * @return the {@link IResourceArtifact} for the given {@link IModuleResource} (maybe null)
   */
  IResourceArtifact getResourceArtifact(IModuleResource resource);

  Graph getBlueprintGraph();

  /**
   * <p>
   * </p>
   * 
   * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
   */
  public static class Factory {

    /**
     * <p>
     * </p>
     * 
     * @param callable
     * @throws Exception
     */
    public static <T> T executeWithoutNotification(IRootArtifact rootArtifact, Callable<T> callable) throws Exception {

      //
      Assert.isNotNull(rootArtifact);
      Assert.isNotNull(callable);

      //
      boolean modelModifiedNotificationDisabled = rootArtifact.isModelModifiedNotificationDisabled();

      // Run the script
      try {

        //
        rootArtifact.disableModelModifiedNotification(true);

        //
        return callable.call();
      }

      //
      finally {
        rootArtifact.disableModelModifiedNotification(modelModifiedNotificationDisabled);
      }
    }
  }
}