AddArtifactsTransformation.java

package org.bundlemaker.core.internal.transformation;

import java.util.Collections;
import java.util.LinkedList;
import java.util.List;

import org.bundlemaker.core.analysis.IArtifactSelector;
import org.bundlemaker.core.analysis.IBundleMakerArtifact;
import org.bundlemaker.core.analysis.IGroupAndModuleContainer;
import org.bundlemaker.core.analysis.IModuleArtifact;
import org.bundlemaker.core.analysis.IPackageArtifact;
import org.bundlemaker.core.internal.api.resource.IModifiableModularizedSystem;
import org.bundlemaker.core.internal.gson.GsonHelper;
import org.bundlemaker.core.internal.transformation.add.AddArtifactToGroupAndModuleContainer;
import org.bundlemaker.core.internal.transformation.add.AddMovableUnitsToModule;
import org.bundlemaker.core.internal.transformation.add.IAddArtifactAction;
import org.bundlemaker.core.internal.transformation.add.ModelNotificationSuppressor;
import org.bundlemaker.core.resource.ITransformationAddArtifacts;
import org.bundlemaker.core.spi.analysis.AbstractArtifactContainer;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;

import com.google.gson.JsonElement;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;

/**
 * <p>
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public class AddArtifactsTransformation extends
    AbstractConfigurableTransformation<AddArtifactsTransformation.Configuration> implements ITransformationAddArtifacts {

  /** - */
  private List<IAddArtifactAction<?>> _actions;

  /** The artifact the selected artifacts have been added to */
  private String                      _target;

  private List<String>                _artifactsAdded;

  /**
   * <p>
   * Creates a new instance of type {@link AddArtifactsTransformation}.
   * </p>
   * 
   * @param configuration
   */
  public AddArtifactsTransformation(IBundleMakerArtifact parent, IArtifactSelector artifactSelector) {
    super(new Configuration(parent, artifactSelector).toJsonTree());

    //
    _actions = new LinkedList<IAddArtifactAction<?>>();
  }

  /**
   * <p>
   * Creates a new instance of type {@link AddArtifactsTransformation}.
   * </p>
   * 
   * @param configuration
   */
  public AddArtifactsTransformation(JsonElement configuration) {
    super(configuration);

    //
    _actions = new LinkedList<IAddArtifactAction<?>>();
  }

  @Override
  public void undo() {

    //
    ModelNotificationSuppressor.performWithoutNotification(getModularizedSystem(), new Runnable() {

      /**
       * {@inheritDoc}
       */
      @Override
      public void run() {
        for (IAddArtifactAction<?> action : _actions) {
          action.undo();
        }
      }
    });
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected Class<Configuration> getConfigurationType() {
    return Configuration.class;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected void assertConfiguration(JsonElement element) {
    //
  }

  /**
   * Returns the target that the selected artifacts have been added to.
   * 
   * 
   * @return the target or null if the transformation has not been run yet
   */
  public String getTarget() {
    return _target;
  }

  public List<String> getArtifactsAdded() {
    return Collections.unmodifiableList(_artifactsAdded);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected void onApply(final Configuration config, IModifiableModularizedSystem modularizedSystem,
      IProgressMonitor progressMonitor) {

    final List<String> artifactsAdded = new LinkedList<String>();

    //
    ModelNotificationSuppressor.performWithoutNotification(modularizedSystem, new Runnable() {

      /**
       * {@inheritDoc}
       */
      @Override
      public void run() {

        //
        List<? extends IBundleMakerArtifact> artifacts = config.getArtifactSelector().getBundleMakerArtifacts();

        // add the artifacts
        IBundleMakerArtifact target = config.getParent();

        for (IBundleMakerArtifact artifact : config.getArtifactSelector().getBundleMakerArtifacts()) {
          ((AbstractArtifactContainer) target).assertCanAdd(artifact);
        }

        for (IBundleMakerArtifact artifactToAdd : artifacts) {

          // add to root or group artifact
          if (target instanceof IGroupAndModuleContainer) {
            IAddArtifactAction<IGroupAndModuleContainer> addAction = new AddArtifactToGroupAndModuleContainer();
            addAction.addChildToParent((IGroupAndModuleContainer) target, artifactToAdd);
            _actions.add(addAction);
          }
          // add to module artifact
          else if (target instanceof IModuleArtifact || target instanceof IPackageArtifact) {
            IAddArtifactAction<IBundleMakerArtifact> addAction = new AddMovableUnitsToModule();
            addAction.addChildToParent(target, artifactToAdd);
            _actions.add(addAction);
          }
          //
          else {
            throw new RuntimeException("Unsupported add operation");
          }

          artifactsAdded.add(artifactToAdd.getName());
        }

        // remember name of target for later access
        _target = target.getName();
      }
    });

    // order
    Collections.sort(artifactsAdded);
    _artifactsAdded = artifactsAdded;

  }

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

    /** - */
    @Expose
    @SerializedName("parent")
    private IBundleMakerArtifact _parent;

    /** - */
    @Expose
    @SerializedName("selector")
    private IArtifactSelector    _artifactSelector;

    /**
     * <p>
     * Creates a new instance of type {@link Configuration}.
     * </p>
     * 
     * @param parent
     * @param artifactSelector
     */
    public Configuration(IBundleMakerArtifact parent, IArtifactSelector artifactSelector) {

      Assert.isNotNull(parent);
      Assert.isNotNull(artifactSelector);

      //
      _parent = parent;
      _artifactSelector = artifactSelector;
    }

    /**
     * <p>
     * </p>
     * 
     * @return
     */
    public IBundleMakerArtifact getParent() {
      return _parent;
    }

    /**
     * <p>
     * </p>
     * 
     * @return
     */
    public IArtifactSelector getArtifactSelector() {
      return _artifactSelector;
    }

    /**
     * <p>
     * </p>
     * 
     * @return
     */
    public JsonElement toJsonTree() {
      return GsonHelper.gson(_parent.getModularizedSystem()).toJsonTree(this);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
      final int prime = 31;
      int result = 1;
      result = prime * result + ((_artifactSelector == null) ? 0 : _artifactSelector.hashCode());
      result = prime * result + ((_parent == null) ? 0 : _parent.hashCode());
      return result;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object obj) {
      if (this == obj)
        return true;
      if (obj == null)
        return false;
      if (getClass() != obj.getClass())
        return false;
      Configuration other = (Configuration) obj;
      if (_artifactSelector == null) {
        if (other._artifactSelector != null)
          return false;
      } else if (!_artifactSelector.equals(other._artifactSelector))
        return false;
      if (_parent == null) {
        if (other._parent != null)
          return false;
      } else if (!_parent.equals(other._parent))
        return false;
      return true;
    }
  }
}