EntityTypeMetadata.java

package org.molgenis.data.meta.model;

import org.molgenis.data.Sort;
import org.molgenis.data.meta.SystemEntityType;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Set;

import static java.lang.Boolean.FALSE;
import static java.util.Collections.singleton;
import static java.util.Objects.requireNonNull;
import static org.molgenis.data.meta.AttributeType.*;
import static org.molgenis.data.meta.model.AttributeMetadata.SEQUENCE_NR;
import static org.molgenis.data.meta.model.EntityType.AttributeRole.*;
import static org.molgenis.data.meta.model.MetaPackage.PACKAGE_META;
import static org.molgenis.data.meta.model.Package.PACKAGE_SEPARATOR;

@Component
public class EntityTypeMetadata extends SystemEntityType
{
	private static final String SIMPLE_NAME_ = "EntityType";
	public static final String ENTITY_TYPE_META_DATA = PACKAGE_META + PACKAGE_SEPARATOR + SIMPLE_NAME_;

	private AttributeMetadata attributeMetadata;
	private PackageMetadata packageMetadata;
	private TagMetadata tagMetadata;

	public static final String FULL_NAME = "fullName";
	public static final String SIMPLE_NAME = "simpleName";
	public static final String PACKAGE = "package";
	public static final String LABEL = "label";
	public static final String DESCRIPTION = "description";
	public static final String ATTRIBUTES = "attributes";
	public static final String IS_ABSTRACT = "isAbstract";
	public static final String EXTENDS = "extends";
	public static final String TAGS = "tags";
	public static final String BACKEND = "backend";

	private List<String> backendEnumOptions;
	private String defaultBackend;

	EntityTypeMetadata()
	{
		super(SIMPLE_NAME_, PACKAGE_META);
	}

	public void init()
	{
		requireNonNull(backendEnumOptions, "backend enum options not set!");

		setLabel("Entity");
		setDescription("Meta data for entity classes");

		addAttribute(FULL_NAME, ROLE_ID).setVisible(false).setLabel("Qualified name");
		addAttribute(SIMPLE_NAME, ROLE_LABEL).setNillable(false).setReadOnly(true).setLabel("Name");
		addAttribute(PACKAGE).setDataType(XREF).setRefEntity(packageMetadata).setLabel("Package").setReadOnly(true);
		addAttribute(LABEL, ROLE_LOOKUP).setNillable(false).setLabel("Label");
		addAttribute(DESCRIPTION).setDataType(TEXT).setLabel("Description");
		Attribute refAttr = attributeMetadata.getAttribute(AttributeMetadata.ENTITY);
		addAttribute(ATTRIBUTES).setDataType(ONE_TO_MANY).setRefEntity(attributeMetadata).setMappedBy(refAttr)
				.setOrderBy(new Sort(SEQUENCE_NR)).setNillable(true).setLabel("Attributes");
		addAttribute(IS_ABSTRACT).setDataType(BOOL).setNillable(false).setReadOnly(true).setLabel("Abstract")
				.setReadOnly(true).setDefaultValue(FALSE.toString());
		// TODO replace with autowired self-reference after update to Spring 4.3
		addAttribute(EXTENDS).setDataType(XREF).setRefEntity(this).setReadOnly(true).setLabel("Extends");
		addAttribute(TAGS).setDataType(MREF).setRefEntity(tagMetadata).setLabel("Tags");
		addAttribute(BACKEND).setDataType(ENUM).setEnumOptions(backendEnumOptions).setNillable(false).setReadOnly(true)
				.setDefaultValue(defaultBackend).setLabel("Backend").setDescription("Backend data store");
	}

	/**
	 * Used during bootstrapping to set the enum options for the backend field. Circumvents unresolvable circular
	 * dependencies when autowiring RepositoryCollectionRegistry into this bean.
	 *
	 * @param repositoryCollectionNames list of RepositoryCollection names
	 */
	public void setBackendEnumOptions(List<String> repositoryCollectionNames)
	{
		this.backendEnumOptions = requireNonNull(repositoryCollectionNames);
	}

	/**
	 * Used during bootstrapping to set the default value of the backend field.
	 *
	 * @param repositoryCollectionName list of RepositoryCollection names
	 */
	public void setDefaultBackend(String repositoryCollectionName)
	{
		this.defaultBackend = requireNonNull(repositoryCollectionName);
	}

	// setter injection instead of constructor injection to avoid unresolvable circular dependencies
	@Autowired
	public void setAttributeMetadata(AttributeMetadata attributeMetadata)
	{
		this.attributeMetadata = requireNonNull(attributeMetadata);
	}

	@Autowired
	public void setPackageMetadata(PackageMetadata packageMetadata)
	{
		this.packageMetadata = requireNonNull(packageMetadata);
	}

	@Autowired
	public void setTagMetadata(TagMetadata tagMetadata)
	{
		this.tagMetadata = requireNonNull(tagMetadata);
	}

	@Override
	public Set<SystemEntityType> getDependencies()
	{
		return singleton(attributeMetadata);
	}
}