org.verapdf.features.FeatureExtractionResult Maven / Gradle / Ivy

Go to download
/**
 * This file is part of veraPDF Library core, a module of the veraPDF project.
 * Copyright (c) 2015, veraPDF Consortium 
 * All rights reserved.
 *
 * veraPDF Library core is free software: you can redistribute it and/or modify
 * it under the terms of either:
 *
 * The GNU General public license GPLv3+.
 * You should have received a copy of the GNU General Public License
 * along with veraPDF Library core as the LICENSE.GPL file in the root of the source
 * tree.  If not, see http://www.gnu.org/licenses/ or
 * https://www.gnu.org/licenses/gpl-3.0.en.html.
 *
 * The Mozilla Public License MPLv2+.
 * You should have received a copy of the Mozilla Public License along with
 * veraPDF Library core as the LICENSE.MPL file in the root of the source tree.
 * If a copy of the MPL was not distributed with this file, you can obtain one at
 * http://mozilla.org/MPL/2.0/.
 */
package org.verapdf.features;

import java.util.*;

import org.verapdf.features.tools.FeatureTreeNode;

/**
 * Features Collection
 *
 * @author Maksim Bezrukov
 */
public final class FeatureExtractionResult {

	private final Map collection;

	/**
	 * Constructs new object
	 */
	public FeatureExtractionResult() {
		this.collection = new EnumMap<>(FeatureObjectType.class);
	}

	/**
	 * Add new feature tree for a type
	 *
	 * @param type type of feature object
	 * @param root root element of a feature tree
	 */
	public void addNewFeatureTree(FeatureObjectType type, FeatureTreeNode root) {
		FeaturesStructure list = this.collection.get(type);

		if (list == null) {
			list = new FeaturesStructure();
			this.collection.put(type, list);
		}
		if (list.list == null) {
			list.list = new ArrayList<>();
		}
		list.list.add(root);
	}

	/**
	 * Gets list of feature trees for the type
	 *
	 * @param type type of the feature object
	 * @return list of feature trees for the given type
	 */
	public List getFeatureTreesForType(FeatureObjectType type) {
		FeaturesStructure list = this.collection.get(type);
		return (list == null || list.list == null) ? Collections.emptyList() : list.list;
	}

	/**
	 * Add new error to feature type
	 *
	 * @param type    type of feature object
	 * @param errorID errorID
	 */
	public void addNewError(FeatureObjectType type, String errorID) {
		FeaturesStructure list = this.collection.get(type);

		if (list == null) {
			list = new FeaturesStructure();
			this.collection.put(type, list);
		}
		if (list.errors == null) {
			list.errors = new ArrayList<>();
		}
		list.errors.add(errorID);
	}

	/**
	 * Gets list of feature trees for the type
	 *
	 * @param type type of the feature object
	 * @return list of errorss for the given type
	 */
	public List getErrorsForType(FeatureObjectType type) {
		FeaturesStructure list = this.collection.get(type);
		return (list == null || list.errors == null) ? Collections.emptyList() : list.errors;
	}

	private static class FeaturesStructure {
		List list;
		List errors;

		public FeaturesStructure() {
			this.list = null;
			this.errors = null;
		}

		@Override
		public boolean equals(Object o) {
			if (this == o) return true;
			if (!(o instanceof FeaturesStructure)) return false;

			FeaturesStructure that = (FeaturesStructure) o;

			if (!Objects.equals(list, that.list)) return false;
			return Objects.equals(errors, that.errors);

		}

		@Override
		public int hashCode() {
			int result = list != null ? list.hashCode() : 0;
			result = 31 * result + (errors != null ? errors.hashCode() : 0);
			return result;
		}
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) return true;
		if (!(o instanceof FeatureExtractionResult)) return false;

		FeatureExtractionResult that = (FeatureExtractionResult) o;

		return Objects.equals(collection, that.collection);

	}

	@Override
	public int hashCode() {
		return collection != null ? collection.hashCode() : 0;
	}
}