/*
    * This file is a part of CAST project.
    * (c) Copyright 2007, AGH University of Science & Technology
    * https://caribou.iisg.agh.edu.pl/trac/cast
    *
    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
    * You may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * http://www.eclipse.org/legal/epl-v10.html
   */
  /*
   * File: AbstractPersistenceProvider.java
   * Created: 2009-07-27
   * Author: tmilos
   * $Id$
   */
  
  package pl.edu.agh.cast.data.persistence;
  
  import java.util.Collection;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Map;
  import java.util.UUID;
  
  import org.eclipse.core.runtime.IProgressMonitor;
  import org.eclipse.osgi.util.NLS;
  
  import pl.edu.agh.cast.data.model.DataSetDescriptor;
  import pl.edu.agh.cast.data.model.IDataSet;
  import pl.edu.agh.cast.data.model.IElement;
  import pl.edu.agh.cast.data.model.Type;
  import pl.edu.agh.cast.data.model.domain.DomainDataSetDescriptor;
  import pl.edu.agh.cast.data.model.presentation.IPresentationDataSet;
  import pl.edu.agh.cast.data.model.presentation.IPresentationElement;
  import pl.edu.agh.cast.data.model.presentation.PresentationDataSetDescriptor;
  import pl.edu.agh.cast.data.model.visual.IVisualDataSet;
  import pl.edu.agh.cast.data.model.visual.VisualDataSetDescriptor;
  import pl.edu.agh.cast.util.Messages;
  
  /**
   * Abstract implementation of {@link IPersistenceProvider} interface. Provides common implementations of utility
   * methods.
   *
   * @author AGH CAST Team
   */
  public abstract class AbstractPersistenceProvider implements IPersistenceProvider {
  
  	private String config;
  
  	// BEGIN Descriptors
  
  	/**
  	 * {@inheritDoc}
  	 *
  	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#getDataSetDescriptors(pl.edu.agh.cast.data.model.Type)
  	 */
  	@Override
  	public List<DataSetDescriptor> getDataSetDescriptors(Type dsType) {
  		LinkedList<DataSetDescriptor> descriptors = new LinkedList<DataSetDescriptor>();
  
  		for (DataSetDescriptor dsd : getDataSetDescriptors()) {
  			if (dsd != null && dsd.getType() != null && dsd.getType().isSubtypeOf(dsType)) {
  				descriptors.add(dsd);
  			}
  		}
  
  		return Collections.unmodifiableList(descriptors);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 *
  	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#getDomainDataSetDescriptors()
  	 */
  	@Override
  	public List<DomainDataSetDescriptor> getDomainDataSetDescriptors() {
  		return filterDescriptors(getDataSetDescriptors(), DomainDataSetDescriptor.class);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 *
  	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#getPresentationDataSetDescriptors()
  	 */
  	@Override
  	public List<PresentationDataSetDescriptor> getPresentationDataSetDescriptors() {
  		return filterDescriptors(getDataSetDescriptors(), PresentationDataSetDescriptor.class);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 *
  	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#getVisualDataSetDescriptors()
  	 */
  	@Override
  	public List<VisualDataSetDescriptor> getVisualDataSetDescriptors() {
 		return filterDescriptors(getDataSetDescriptors(), VisualDataSetDescriptor.class);
 	}
 
 	private static <T extends DataSetDescriptor> List<T> filterDescriptors(List<DataSetDescriptor> dsdList,
 	        Class<T> descClass) {
 		List<T> fList = new LinkedList<T>();
 
 		for (DataSetDescriptor dsd : dsdList) {
 			if (descClass.isInstance(dsd)) {
 				fList.add(descClass.cast(dsd));
 			}
 		}
 
 		return fList;
 	}
 
 	// END Descriptors
 
 	// BEGIN Retrieve DataSet
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider
 	 *      #getDataSet(pl.edu.agh.cast.data.model.DataSetDescriptor)
 	 */
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T extends IDataSet<? extends IElement>> T getDataSet(DataSetDescriptor descriptor) {
 		return (T)this.getDataSet(descriptor.getId());
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#getDataSets(java.util.Collection)
 	 */
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T extends IDataSet<? extends IElement>> Map<UUID, T> getDataSets(Collection<DataSetDescriptor> descs) {
 		Map<UUID, T> dsMap = new HashMap<UUID, T>(descs.size());
 		for (DataSetDescriptor dsd : descs) {
 			dsMap.put(dsd.getId(), (T)getDataSet(dsd));
 		}
 		return dsMap;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#getDataSetsById(java.util.Collection)
 	 */
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T extends IDataSet<? extends IElement>> Map<UUID, T> getDataSetsById(Collection<UUID> ids) {
 		Map<UUID, T> dsMap = new HashMap<UUID, T>(ids.size());
 		for (UUID id : ids) {
 			dsMap.put(id, (T)getDataSet(id));
 		}
 		return dsMap;
 	}
 
 	// END Retrieve DataSet
 
 	// BEGIN Save DataSet
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#saveDataSet(pl.edu.agh.cast.data.model.IDataSet,
 	 *      org.eclipse.core.runtime.IProgressMonitor)
 	 */
 	@Override
 	public UUID saveDataSet(IDataSet<? extends IElement> dataSet, IProgressMonitor monitor) {
 		monitor.beginTask(NLS.bind(Messages.AbstractPersistenceProvider_SaveSingleDS_ProgressTitle, dataSet.getName()),
 		        IProgressMonitor.UNKNOWN);
 		UUID id = saveDataSet(dataSet);
 		monitor.done();
 		return id;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#saveDataSets(java.util.Collection)
 	 */
 	@Override
 	public Map<UUID, UUID> saveDataSets(Collection<IDataSet<? extends IElement>> dataSets) {
 		Map<UUID, UUID> idMap = new HashMap<UUID, UUID>(dataSets.size());
 		for (IDataSet<? extends IElement> dataSet : dataSets) {
 			idMap.put(dataSet.getId(), saveDataSet(dataSet));
 		}
 		return idMap;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#saveDataSets(java.util.Collection,
 	 *      org.eclipse.core.runtime.IProgressMonitor)
 	 */
 	@Override
 	public Map<UUID, UUID> saveDataSets(Collection<IDataSet<? extends IElement>> dataSets, IProgressMonitor monitor) {
 		monitor.beginTask(NLS.bind(Messages.AbstractPersistenceProvider_SaveMultiDS_ProgressTitle, dataSets.size()),
 		        IProgressMonitor.UNKNOWN);
 		Map<UUID, UUID> idMap = saveDataSets(dataSets);
 		monitor.done();
 		return idMap;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider
 	 *      #saveDiagram(pl.edu.agh.cast.data.model.presentation.IPresentationDataSet)
 	 */
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T extends IPresentationDataSet<? extends IPresentationElement<? extends IElement>>> T saveDiagram(
 	        T presentationDataSet) {
 		T savedPDS = null;
 
 		List<IDataSet<? extends IElement>> dataSets = new LinkedList<IDataSet<? extends IElement>>();
 		dataSets.add(presentationDataSet);
 		if (presentationDataSet.hasAssociatedVisualDataSet()) {
 			dataSets.add(presentationDataSet.getVisualDataSet());
 		}
 
 		Map<UUID, UUID> idMap = saveDataSets(dataSets);
 
 		Map<UUID, IDataSet<? extends IElement>> savedDataSets = getDataSetsById(idMap.values());
 
 		savedPDS = (T)savedDataSets.get(idMap.get(presentationDataSet.getId()));
 
 		if (presentationDataSet.getVisualDataSet() != null) {
 			savedPDS.setVisualDataSet((IVisualDataSet)savedDataSets.get(idMap.get(presentationDataSet
 			        .getVisualDataSet().getId())));
 		}
 
 		return savedPDS;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider
 	 *      #saveDiagram(pl.edu.agh.cast.data.model.presentation.IPresentationDataSet,
 	 *      org.eclipse.core.runtime.IProgressMonitor)
 	 */
 	@Override
 	public <T extends IPresentationDataSet<? extends IPresentationElement<? extends IElement>>> T saveDiagram(
 	        T presentationDataSet, IProgressMonitor monitor) {
 		monitor.beginTask(NLS.bind(Messages.AbstractPersistenceProvider_SaveMultiDS_ProgressTitle, 2),
 		        IProgressMonitor.UNKNOWN);
 		T savedPDS = saveDiagram(presentationDataSet);
 		monitor.done();
 		return savedPDS;
 	}
 
 	// END Save DataSet
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#setConfig(java.lang.String)
 	 */
 	@Override
 	public void setConfig(String filePath) {
 		this.config = filePath;
 	}
 
 	public String getConfig() {
 		return this.config;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 *
 	 * @see pl.edu.agh.cast.data.persistence.IPersistenceProvider#renameDataSet(java.util.UUID, java.lang.String)
 	 */
 	@Override
 	public UUID renameDataSet(UUID id, String newName) {
 		IDataSet<IElement> ds = getDataSet(id);
 		if (ds != null) {
 			ds.setName(newName);
 			return saveDataSet(ds);
 		}
 		return null;
 	}
 
 }