org.apache.poi.openxml4j.opc.PackagePartCollection Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

package org.apache.poi.openxml4j.opc;

import java.io.Serializable;
import java.util.*;

import org.apache.poi.openxml4j.exceptions.InvalidOperationException;

/**
 * A package part collection.
 *
 * @author Julien Chable
 * @version 0.1
 */
public final class PackagePartCollection implements Serializable {

	private static final long serialVersionUID = 2515031135957635517L;

	/**
	 * HashSet use to store this collection part names as string for rule
	 * M1.11 optimized checking.
	 */
	private HashSet registerPartNameStr = new HashSet();


	private final HashMap packagePartLookup = new HashMap();


	/**
	 * Check rule [M1.11]: a package implementer shall neither create nor
	 * recognize a part with a part name derived from another part name by
	 * appending segments to it.
	 *
	 * @exception InvalidOperationException
	 *                Throws if you try to add a part with a name derived from
	 *                another part name.
	 */
	public PackagePart put(PackagePartName partName, PackagePart part) {
		String[] segments = partName.getURI().toASCIIString().split(
				PackagingURIHelper.FORWARD_SLASH_STRING);
		StringBuilder concatSeg = new StringBuilder();
		for (String seg : segments) {
			if (!seg.equals(""))
				concatSeg.append(PackagingURIHelper.FORWARD_SLASH_CHAR);
			concatSeg.append(seg);
			if (this.registerPartNameStr.contains(concatSeg.toString())) {
				throw new InvalidOperationException(
						"You can't add a part with a part name derived from another part ! [M1.11]");
			}
		}
		this.registerPartNameStr.add(partName.getName());
		return packagePartLookup.put(partName, part);
	}

	public PackagePart remove(PackagePartName key) {
		this.registerPartNameStr.remove(key.getName());
		return packagePartLookup.remove(key);
	}


	/**
	 * The values themselves should be returned in sorted order. Doing it here
	 * avoids paying the high cost of Natural Ordering per insertion.
	 */
	public Collection sortedValues() {
		ArrayList packageParts = new ArrayList(packagePartLookup.values());
		Collections.sort(packageParts);
		return packageParts;

	}

	public boolean containsKey(PackagePartName partName) {
		return packagePartLookup.containsKey(partName);
	}

	public PackagePart get(PackagePartName partName) {
		return packagePartLookup.get(partName);
	}

	public int size() {
		return packagePartLookup.size();
	}
}