CpPackCollection.java

/*******************************************************************************
 * Copyright (c) 2015 ARM Ltd. and others
 * 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:
 * ARM Ltd and ARM Germany GmbH - Initial API and implementation
 *******************************************************************************/

package com.arm.cmsis.pack.data;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;

import com.arm.cmsis.pack.common.CmsisConstants;
import com.arm.cmsis.pack.data.ICpPack.PackState;
import com.arm.cmsis.pack.generic.IAttributes;
import com.arm.cmsis.pack.utils.AlnumComparator;

/**
 *  Class to collect pack families
 */
public class CpPackCollection extends CpItem implements ICpPackCollection {

	// fChildren from CpItem class is not used
	protected Map<String, ICpPackFamily> fPackFamilies = null;
	protected Set<String> fLatestPackIDs = null;

	public CpPackCollection() {
		super(null, CmsisConstants.PACKAGES_TAG);
	}

	public CpPackCollection(String name) {
		super(null, name);
	}

	@Override
	public ICpPack getPack(String packId) {
		if(fPackFamilies != null) {
			String familyId = CpPack.familyFromId(packId);
			ICpPackFamily f = fPackFamilies.get(familyId);
			if(f != null) {
				String version = CpPack.versionFromId(packId);
				if(version == null || version.isEmpty()) {
					return f.getPack();
				}
				return f.getPack(version);
			}
		}
		return null;
	}

	@Override
	public ICpPack getPack(IAttributes attributes) {
		if(fPackFamilies != null) {
			String familyId = attributes.getAttribute(CmsisConstants.VENDOR) +
					"." + attributes.getAttribute(CmsisConstants.NAME); //$NON-NLS-1$
			ICpPackFamily f = fPackFamilies.get(familyId);
			if(f != null) {
				String versionRange = attributes.getAttribute(CmsisConstants.VERSION);
				if(versionRange == null || versionRange.isEmpty()) {
					return null;
				}
				return f.getPack(attributes);
			}
		}
		return null;
	}

	@Override
	public Collection<? extends ICpItem> getChildren() {
		if(fPackFamilies != null) {
			return fPackFamilies.values();
		}
		return null;
	}


	@Override
	public boolean hasChildren() {
		return fPackFamilies != null && !fPackFamilies.isEmpty();
	}

	@Override
	public ICpItem getFirstChild(String packId) {
		return getPack(packId);
	}


	@Override
	public void addChild(ICpItem item) {
		if(item == null) {
			return;
		}
		if(!(item instanceof ICpPack)) {
			return;
		}
		cachedChildArray = null;
		ICpPack pack = (ICpPack)item;
		if(fPackFamilies == null) {
			fPackFamilies = new TreeMap<String, ICpPackFamily>(new AlnumComparator(false, false));
		}

		String familyId = pack.getPackFamilyId();

		ICpPackFamily family = fPackFamilies.get(familyId);
		if(family == null) {
			family = new CpPackFamily(this, familyId);
			fPackFamilies.put(familyId, family);
		}
		family.addChild(item);
	}


	@Override
	public Collection<ICpPack> getPacks() {
		Set<ICpPack> packs = new TreeSet<ICpPack>(new CpPackComparator());
		for(ICpPackFamily f : fPackFamilies.values()) {
			Collection<ICpPack> familyPacks = f.getPacks();
			if(familyPacks == null) {
				continue;
			}
			for(ICpPack pack : familyPacks) {
				if (pack.getPackState() == PackState.INSTALLED ||
						pack.isLatest()) {
					packs.add(pack);
				}
			}
		}
		return packs;
	}

	@Override
	public Collection<ICpPack> getFilteredPacks(ICpPackFilter packFilter) {
		if(packFilter == null || packFilter.isUseAllLatestPacks()) {
			return getLatestPacks();
		}

		Set<ICpPack> packs = new TreeSet<ICpPack>(new CpPackComparator());
		for(ICpPackFamily f : fPackFamilies.values()) {
			Collection<? extends ICpItem> children = f.getChildren();
			if(children == null) {
				continue;
			}
			if(packFilter != null) {
				String familyId = f.getPackFamilyId();
				if(packFilter.isExcluded(familyId)) {
					continue; // skip entire family
				} else if(packFilter.isUseLatest(familyId)) {
					ICpPack pack = f.getPack();
					if (pack != null) {
						packs.add(pack);
					}
					continue;
				}
			}

			for(ICpItem item : children) {
				if(item == null || !(item instanceof ICpPack)) {
					continue;
				}
				ICpPack pack = (ICpPack)item;
				if(packFilter == null || packFilter.passes(pack)) {
					packs.add(pack);
				}
			}
		}
		return packs;
	}

	@Override
	public Collection<ICpPack> getLatestPacks() {
		Set<ICpPack> latestPacks = new TreeSet<ICpPack>(new CpPackComparator());
		if (fPackFamilies == null) {
			return latestPacks;
		}
		for(ICpPackFamily f : fPackFamilies.values()) {
			ICpPack pack = f.getPack();
			if (pack == null) {
				continue;
			} else if (pack.getPackState() == PackState.INSTALLED) {
				latestPacks.add(pack);
				continue;
			}
			for (ICpItem item : f.getChildren()) {
				if (!(item instanceof ICpPack)) {
					continue;
				}
				ICpPack p = (ICpPack) item;
				if(p.getPackState() == PackState.INSTALLED) {
					latestPacks.add(p);
					break;
				}
			}
		}
		return latestPacks;
	}


	@Override
	public synchronized Set<String> getLatestPackIDs() {
		if(fLatestPackIDs == null) {
			fLatestPackIDs = new TreeSet<String>(new CpPackIdComparator());
			if (fPackFamilies != null) {
				for(ICpPackFamily f : fPackFamilies.values()) {
					String packId = f.getPackId();
					if(packId != null && !packId.isEmpty()) {
						fLatestPackIDs.add(packId);
					}
				}
			}
		}
		return fLatestPackIDs;
	}


	@Override
	public ICpPack getPackByFilename(String pdscFile) {
		if(fPackFamilies != null) {
			for(ICpPackFamily f : fPackFamilies.values()){
				ICpPack pack = f.getPackByFilename(pdscFile);
				if(pack != null) {
					return pack;
				}
			}
		}
		return null;
	}


	@Override
	public Collection<ICpPack> getPacksByPackFamilyId(String packFamilyId) {
		if (fPackFamilies == null) {
			return null;
		}
		ICpPackFamily family = fPackFamilies.get(packFamilyId);
		if (family == null) {
			return null;
		}
		return family.getPacks();
	}

}