org.molgenis.data.importer.IntermediateParseResults Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of molgenis-data-import Show documentation
Entity importer framework and EMX importer.
The newest version!
package org.molgenis.data.importer;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.molgenis.data.AttributeMetaData;
import org.molgenis.data.EditableEntityMetaData;
import org.molgenis.data.Entity;
import org.molgenis.data.EntityMetaData;
import org.molgenis.data.i18n.I18nStringMetaData;
import org.molgenis.data.i18n.LanguageMetaData;
import org.molgenis.data.importer.EmxMetaDataParser.EmxAttribute;
import org.molgenis.data.meta.PackageImpl;
import org.molgenis.data.semantic.LabeledResource;
import org.molgenis.data.semantic.Tag;
import org.molgenis.data.semantic.TagImpl;
import org.molgenis.data.support.DefaultEntityMetaData;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSetMultimap;
import com.google.common.collect.LinkedHashMultimap;
import com.google.common.collect.SetMultimap;

/**
 * Mutable bean to store intermediate parse results. Uses lookup tables to map simple names to the parsed objects. Is
 * used by the {@link EmxMetaDataParser}
 */
public final class IntermediateParseResults
{
	/**
	 * Maps full name to EntityMetaData
	 */
	private final Map entities;
	/**
	 * Maps full name to PackageImpl (with tags)
	 */
	private final Map packages;
	/**
	 * Contains all Attribute tags
	 */
	private final SetMultimap> attributeTags;
	/**
	 * Contains all Entity tags
	 */
	private final List> entityTags;
	/**
	 * Contains all tag entities from the tag sheet
	 */
	private final Map tags;
	/**
	 * Contains all language enities from the languages sheet
	 */
	private final Map languages;
	/**
	 * Contains all i18nString entities from the i18nstrings sheet
	 */
	private final Map i18nStrings;

	public IntermediateParseResults()
	{
		this.tags = new LinkedHashMap<>();
		this.entities = new LinkedHashMap<>();
		this.packages = new LinkedHashMap<>();
		this.attributeTags = LinkedHashMultimap.create();
		this.entityTags = new ArrayList<>();
		this.languages = new LinkedHashMap<>();
		this.i18nStrings = new LinkedHashMap<>();
	}

	public void addEntityMetaData(DefaultEntityMetaData entityMetaData)
	{
		entities.put(entityMetaData.getName(), entityMetaData);
	}

	public void addTagEntity(String identifier, Entity tagEntity)
	{
		tags.put(identifier, tagEntity);
	}

	public void addAttributes(String entityName, List emxAttrs)
	{
		EditableEntityMetaData entityMeta = getEntityMetaData(entityName);
		if (entityMeta == null) entityMeta = addEntityMetaData(entityName);

		for (EmxAttribute emxAttr : emxAttrs)
		{
			AttributeMetaData attr = emxAttr.getAttr();
			entityMeta.addAttributeMetaData(attr);

			// set attribute roles
			if (emxAttr.isIdAttr())
			{
				entityMeta.setIdAttribute(attr);
			}
			if (emxAttr.isLabelAttr())
			{
				entityMeta.setLabelAttribute(attr);
			}
			if (emxAttr.isLookupAttr())
			{
				entityMeta.addLookupAttribute(attr);
			}
		}
	}

	public EditableEntityMetaData addEntityMetaData(String name)
	{
		String simpleName = name;
		for (String packageName : packages.keySet())
		{
			if (name.toLowerCase().startsWith(packageName.toLowerCase()))
			{
				simpleName = name.substring(packageName.length() + 1);// package_entity
			}
		}

		DefaultEntityMetaData emd = new DefaultEntityMetaData(simpleName);
		entities.put(name, emd);

		return emd;
	}

	public EditableEntityMetaData getEntityMetaData(String name)
	{
		return entities.get(name);
	}

	public void addLanguage(Entity language)
	{
		languages.put(language.getString(LanguageMetaData.CODE), language);
	}

	public void addI18nString(Entity i18nString)
	{
		i18nStrings.put(i18nString.getString(I18nStringMetaData.MSGID), i18nString);
	}

	/**
	 * Checks if it knows entity with given simple name.
	 * 
	 * @param name
	 *            simple name of the entity
	 * @return true if entity with simple name name is known, false otherwise
	 */
	public boolean knowsEntity(String name)
	{
		return entities.containsKey(name);
	}

	public void addPackage(String name, PackageImpl p)
	{
		packages.put(name, p);
	}

	public ImmutableMap getEntityMap()
	{
		return ImmutableMap. copyOf(entities);
	}

	public ImmutableList getEntities()
	{
		return ImmutableList. copyOf(entities.values());
	}

	public ImmutableMap getPackages()
	{
		return ImmutableMap.copyOf(packages);
	}

	public ImmutableSetMultimap> getAttributeTags()
	{
		return ImmutableSetMultimap.copyOf(attributeTags);
	}

	public ImmutableList> getEntityTags()
	{
		return ImmutableList.copyOf(entityTags);
	}

	public ImmutableMap getLanguages()
	{
		return ImmutableMap.copyOf(languages);
	}

	public ImmutableMap getI18nStrings()
	{
		return ImmutableMap.copyOf(i18nStrings);
	}

	@Override
	public String toString()
	{
		return "IntermediateParseResults [entities=" + entities + ", packages=" + packages + ", attributeTags="
				+ attributeTags + ", entityTags=" + entityTags + ", tags=" + tags + ", languages=" + languages
				+ ", i18nStrings=" + i18nStrings + "]";
	}

	@Override
	public int hashCode()
	{
		final int prime = 31;
		int result = 1;
		result = prime * result + ((attributeTags == null) ? 0 : attributeTags.hashCode());
		result = prime * result + ((entities == null) ? 0 : entities.hashCode());
		result = prime * result + ((entityTags == null) ? 0 : entityTags.hashCode());
		result = prime * result + ((i18nStrings == null) ? 0 : i18nStrings.hashCode());
		result = prime * result + ((languages == null) ? 0 : languages.hashCode());
		result = prime * result + ((packages == null) ? 0 : packages.hashCode());
		result = prime * result + ((tags == null) ? 0 : tags.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj)
	{
		if (this == obj) return true;
		if (obj == null) return false;
		if (getClass() != obj.getClass()) return false;
		IntermediateParseResults other = (IntermediateParseResults) obj;
		if (attributeTags == null)
		{
			if (other.attributeTags != null) return false;
		}
		else if (!attributeTags.equals(other.attributeTags)) return false;
		if (entities == null)
		{
			if (other.entities != null) return false;
		}
		else if (!entities.equals(other.entities)) return false;
		if (entityTags == null)
		{
			if (other.entityTags != null) return false;
		}
		else if (!entityTags.equals(other.entityTags)) return false;
		if (i18nStrings == null)
		{
			if (other.i18nStrings != null) return false;
		}
		else if (!i18nStrings.equals(other.i18nStrings)) return false;
		if (languages == null)
		{
			if (other.languages != null) return false;
		}
		else if (!languages.equals(other.languages)) return false;
		if (packages == null)
		{
			if (other.packages != null) return false;
		}
		else if (!packages.equals(other.packages)) return false;
		if (tags == null)
		{
			if (other.tags != null) return false;
		}
		else if (!tags.equals(other.tags)) return false;
		return true;
	}

	/**
	 * Gets a specific package
	 * 
	 * @param name
	 *            the name of the package
	 * @return
	 */
	public PackageImpl getPackage(String name)
	{
		return getPackages().get(name);
	}

	public Entity getTagEntity(String tagIdentifier)
	{
		return tags.get(tagIdentifier);
	}

	public void addEntityTag(TagImpl tag)
	{
		entityTags.add(tag);
	}

	public void addAttributeTag(String entityName, TagImpl tag)
	{
		attributeTags.put(entityName, tag);
	}

}