BundleMakerProjectDescription.java

/*******************************************************************************
 * Copyright (c) 2011 Gerd Wuetherich (gerd@gerd-wuetherich.de).
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Gerd Wuetherich (gerd@gerd-wuetherich.de) - initial API and implementation
 ******************************************************************************/
package org.bundlemaker.core.project.internal;

import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.bundlemaker.core.internal.BundleMakerProject;
import org.bundlemaker.core.internal.modules.jdk.JdkContentProvider;
import org.bundlemaker.core.project.BundleMakerProjectContentChangedEvent;
import org.bundlemaker.core.project.BundleMakerProjectDescriptionChangedEvent;
import org.bundlemaker.core.project.IModifiableProjectDescription;
import org.bundlemaker.core.project.IProjectContentEntry;
import org.bundlemaker.core.project.IProjectContentProvider;
import org.bundlemaker.core.project.IProjectContentResource;
import org.bundlemaker.core.project.IProjectDescriptionAwareBundleMakerProject;
import org.bundlemaker.core.project.spi.AbstractProjectContentProvider;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;

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

/**
 * <p>
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public class BundleMakerProjectDescription implements IModifiableProjectDescription, IInternalProjectDescription {

  /** - */
  private static NumberFormat                        FORMATTER  = new DecimalFormat("000000");

  /** the current identifier */
  @Expose
  @SerializedName("current-id")
  private int                                        _currentId = 0;

  /** - */
  @Expose
  @SerializedName("project-content-providers")
  private List<IProjectContentProvider>              _projectContentProviders;

  /** - */
  @Expose
  @SerializedName("jre")
  private String                                     _jre;

  /** - */
  private Object                                     _identifierLock;

  /** - */
  private List<IProjectContentEntry>                 _projectContentEntries;

  /** - */
  private Map<String, IProjectContentEntry>          _projectContentEntriesMap;

  /** the resource list */
  private List<IResourceStandinNEW>                  _sourceResources;

  /** the resource list */
  private List<IResourceStandinNEW>                  _binaryResources;

  /** - */
  private boolean                                    _initialized;

  /** - */
  private IProjectDescriptionAwareBundleMakerProject _bundleMakerProject;

  /** - */
  private JdkContentProvider                         _jdkContentProvider;

  /**
   * <p>
   * Creates a new instance of type {@link BundleMakerProjectDescription}.
   * </p>
   * 
   * @param bundleMakerProject
   */
  public BundleMakerProjectDescription(IProjectDescriptionAwareBundleMakerProject bundleMakerProject) {

    //
    _bundleMakerProject = bundleMakerProject;

    //
    _projectContentEntries = new ArrayList<IProjectContentEntry>();
    _projectContentProviders = new ArrayList<IProjectContentProvider>();
    _projectContentEntriesMap = new HashMap<String, IProjectContentEntry>();
    _sourceResources = new ArrayList<IResourceStandinNEW>();
    _binaryResources = new ArrayList<IResourceStandinNEW>();
    _identifierLock = new Object();
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public IProjectDescriptionAwareBundleMakerProject getBundleMakerProject() {
    return _bundleMakerProject;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public List<? extends IProjectContentProvider> getContentProviders() {
    return Collections.unmodifiableList(_projectContentProviders);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public List<IProjectContentEntry> getContent() {
    return Collections.unmodifiableList(_projectContentEntries);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public IProjectContentEntry getProjectContentEntry(String identifier) {
    Assert.isNotNull(identifier);

    return _projectContentEntriesMap.get(identifier);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void addContentProvider(IProjectContentProvider contentProvider) {
    Assert.isNotNull(contentProvider);
    Assert.isTrue(contentProvider instanceof AbstractProjectContentProvider, String.format(
        "IProjectContentProvider must be instance of %s.", AbstractProjectContentProvider.class.getName()));

    if (!_projectContentProviders.contains(contentProvider)) {

      //
      _projectContentProviders.add(contentProvider);

      //
      if (true) {
        ((AbstractProjectContentProvider) contentProvider).setId(getNextContentProviderId());
      }

      // contentProvider should always be AbstractContentProvider...
      ((AbstractProjectContentProvider) contentProvider).setProject(_bundleMakerProject);

      //
      fireProjectDescriptionChangedEvent();
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void removeContentProvider(IProjectContentProvider contentProvider) {
    Assert.isNotNull(contentProvider);

    //
    _projectContentProviders.remove(contentProvider);

    // notify listeners
    fireProjectDescriptionChangedEvent();

  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void moveUpContentProviders(List<? extends IProjectContentProvider> selectedItems) {

    // assert selected items are not null
    Assert.isNotNull(selectedItems);

    // return if empty
    if (selectedItems.isEmpty()) {
      return;
    }

    // order the selected items
    List<IProjectContentProvider> orderSelectedItems = new LinkedList<IProjectContentProvider>(selectedItems);
    Collections.sort(orderSelectedItems, new Comparator<IProjectContentProvider>() {
      @Override
      public int compare(IProjectContentProvider o1, IProjectContentProvider o2) {
        return _projectContentProviders.indexOf(o1) - _projectContentProviders.indexOf(o2);
      }
    });

    try {
      // move the items up
      for (IProjectContentProvider provider : orderSelectedItems) {

        //
        int index = _projectContentProviders.indexOf(provider);
        if (index == 0) {
          return;
        }

        //
        _projectContentProviders.remove(provider);
        _projectContentProviders.add(index - 1, provider);
      }
    } finally {
      fireProjectDescriptionChangedEvent();
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void moveDownContentProviders(List<? extends IProjectContentProvider> selectedItems) {

    // assert selected items are not null
    Assert.isNotNull(selectedItems);

    // return if empty
    if (selectedItems.isEmpty()) {
      return;
    }

    // order the selected items
    List<IProjectContentProvider> orderSelectedItems = new LinkedList<IProjectContentProvider>(selectedItems);
    Collections.sort(orderSelectedItems, new Comparator<IProjectContentProvider>() {
      @Override
      public int compare(IProjectContentProvider o1, IProjectContentProvider o2) {
        return _projectContentProviders.indexOf(o2) - _projectContentProviders.indexOf(o1);
      }
    });

    // move the items up
    try {
      for (IProjectContentProvider provider : orderSelectedItems) {

        //
        int index = _projectContentProviders.indexOf(provider);
        if (index == _projectContentProviders.size() - 1) {
          return;
        }

        //
        _projectContentProviders.remove(provider);
        _projectContentProviders.add(index + 1, provider);
      }
    } finally {
      fireProjectDescriptionChangedEvent();
    }
  }

  @Override
  public void removeContentProvider(String id) {
    for (Iterator<IProjectContentEntry> iterator = _projectContentEntries.iterator(); iterator.hasNext();) {

      ProjectContentEntry content = (ProjectContentEntry) iterator.next();

      if (content.getId().equals(id)) {
        iterator.remove();

        fireProjectDescriptionChangedEvent();

        return;
      }
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void clear() {
    synchronized (_identifierLock) {
      _projectContentEntries.clear();
      _projectContentProviders.clear();
      _projectContentEntriesMap.clear();
      _currentId = 0;
      _initialized = false;
      _jre = null;
    }

    fireProjectDescriptionChangedEvent();
  }

  public String getNextContentProviderId() {
    synchronized (_identifierLock) {
      return FORMATTER.format(_currentId++);
    }
  }

  /**
   * <p>
   * </p>
   * 
   * @param bundlemakerProject
   * @throws CoreException
   */
  public void initialize(IProgressMonitor progressMonitor, IProjectDescriptionAwareBundleMakerProject bundlemakerProject)
      throws CoreException {

    //
    if (_initialized) {
      return;
    }

    // clear the project content list
    _projectContentEntries.clear();

    // // TODO
    // if (isValid()) {
    // throw new RuntimeException("Invalid description");
    // }

    //
    _jdkContentProvider = new JdkContentProvider();
    _jdkContentProvider.setProject(_bundleMakerProject);
    _jdkContentProvider.initializeProjectContent(null);
    _projectContentEntries.addAll(_jdkContentProvider.getBundleMakerProjectContent());

    //
    for (IProjectContentProvider contentProvider : _projectContentProviders) {

      //
      ((AbstractProjectContentProvider) contentProvider).initializeProjectContent(null);

      //
      List<IProjectContentEntry> projectContents = contentProvider
          .getBundleMakerProjectContent();

      //
      _projectContentEntries.addAll(projectContents);
    }

    //
    for (IProjectContentEntry entry : _projectContentEntries) {
      _projectContentEntriesMap.put(entry.getId(), entry);
    }

    //
    _initialized = true;
  }

  /**
   * <p>
   * </p>
   * 
   * @return
   */
  public boolean isValid() {
    return _jre == null;
  }

  /**
   * <p>
   * </p>
   * 
   * @return
   */
  public String getJRE() {
    return _jre;
  }

  public boolean isInitialized() {
    return _initialized;
  }

  @SuppressWarnings("unchecked")
  public final List<IProjectContentResource> getSourceResources() {
    List<? extends IProjectContentResource> result = Collections.unmodifiableList(_sourceResources);
    return (List<IProjectContentResource>) result;
  }

  @SuppressWarnings("unchecked")
  public final List<IProjectContentResource> getBinaryResources() {
    List<? extends IProjectContentResource> result = Collections.unmodifiableList(_binaryResources);
    return (List<IProjectContentResource>) result;
  }

  /**
   * <p>
   * </p>
   * 
   * @param resource
   */
  @Override
  public void addSourceResource(IResourceStandinNEW resourceStandin) {
    _sourceResources.add(resourceStandin);
  }

  @Override
  public void addBinaryResource(IResourceStandinNEW resourceStandin) {
    _binaryResources.add(resourceStandin);
  }

  @Override
  public void removeBinaryResource(IResourceStandinNEW resource) {
    _binaryResources.remove(resource);
  }

  @Override
  public void removeSourceResource(IResourceStandinNEW resource) {
    _binaryResources.remove(resource);
  }

  /**
   * <p>
   * </p>
   * 
   * @return
   */
  public int getCurrentId() {
    synchronized (_identifierLock) {
      return _currentId;
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void setJre(String jre) {
    setJreInternal(jre);

    fireProjectDescriptionChangedEvent();
  }

  void setJreInternal(String jre) {
    _jre = jre;

    // internal method. Do NOT fire BundleMakerProjectChangedEvent
  }

  /**
   * <p>
   * </p>
   * 
   * @param currentId
   */
  public void setCurrentId(int currentId) {
    synchronized (_identifierLock) {
      _currentId = currentId;
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void save() throws CoreException {

    ProjectDescriptionStore.saveProjectDescription(_bundleMakerProject.getProject(), this);

    // notify listeners
    // TODO MOVE TO BundleMakerProject
    if (_bundleMakerProject != null && _bundleMakerProject instanceof BundleMakerProject) {
      ((BundleMakerProject) _bundleMakerProject)
          .fireDescriptionChangedEvent(new BundleMakerProjectDescriptionChangedEvent(getBundleMakerProject(),
              BundleMakerProjectDescriptionChangedEvent.Type.PROJECT_DESCRIPTION_SAVED));
    }
  }

  /**
   * Notifies the BundleMakerProjectChangedListeners that the description has been changed
   */
  // TODO MOVE TO BundleMakerProject
  public void fireProjectDescriptionChangedEvent() {

    // Create the Event
    BundleMakerProjectDescriptionChangedEvent event = new BundleMakerProjectDescriptionChangedEvent(
        getBundleMakerProject(),
        BundleMakerProjectDescriptionChangedEvent.Type.PROJECT_DESCRIPTION_MODIFIED);

    // notify listeners
    if (_bundleMakerProject != null && _bundleMakerProject instanceof BundleMakerProject) {
      ((BundleMakerProject) _bundleMakerProject).fireDescriptionChangedEvent(event);
    }
  }

  /**
   * <p>
   * </p>
   */
  // TODO MOVE TO BundleMakerProject
  public void fireProjectDescriptionRecomputedEvent() {

    // Create the Event
    BundleMakerProjectDescriptionChangedEvent event = new BundleMakerProjectDescriptionChangedEvent(
        getBundleMakerProject(),
        BundleMakerProjectDescriptionChangedEvent.Type.PROJECT_DESCRIPTION_RECOMPUTED);

    // notify listeners
    if (_bundleMakerProject != null && _bundleMakerProject instanceof BundleMakerProject) {
      ((BundleMakerProject) _bundleMakerProject).fireDescriptionChangedEvent(event);
    }
  }

  // TODO MOVE TO BundleMakerProject
  public void fireProjectContentChangedEvent(BundleMakerProjectContentChangedEvent contentChangedEvent) {

    //
    Assert.isNotNull(contentChangedEvent);

    // notify listeners
    if (_bundleMakerProject != null && _bundleMakerProject instanceof BundleMakerProject) {
      ((BundleMakerProject) _bundleMakerProject).fireContentChangedEvent(contentChangedEvent);
    }
  }
}