giis.tdrules.model.ITdEntityExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tdrules-model Show documentation
Models of the FPC Rules, SQL Mutants and the data store schema
The newest version!
package giis.tdrules.model;

import static giis.tdrules.model.ModelUtil.safe;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import com.fasterxml.jackson.annotation.JsonIgnore;

import giis.tdrules.openapi.model.TdAttribute;
import giis.tdrules.openapi.model.TdEntity;

/**
 * Extends the OpenApi generated TdEntity model using default implementations in this interface
 * (the name of this interface must be defined as the x-implements vendor extension)
 */
public interface ITdEntityExtension {

	// Methods from the generated model that are used here

	public List getAttributes();
	public String getEntitytype();
	public void setEntitytype(String type);

	// Default implementations to extend the generated model

	/**
	 * Gets all attributes that are an rid to another attribute
	 */
	@JsonIgnore
	default List getRids() {
		List rids=new ArrayList<>();
		for (TdAttribute attribute : safe(getAttributes()))
			if (!"".equals(attribute.getRid()))
				rids.add(attribute);
		return rids;
	}

	/**
	 * Gets all unique values of rid properties
	 */
	@JsonIgnore
	default List getUniqueRids() {
		Set rids = new LinkedHashSet<>();
		for (TdAttribute attribute : safe(getAttributes()))
			if (!"".equals(attribute.getRid()))
				rids.add(attribute.getRid());
		return new ArrayList<>(rids);
	}

	/**
	 * Gets all unique names of rid properties
	 */
	@JsonIgnore
	default List getUniqueRidNames() {
		Set rids = new LinkedHashSet<>();
		for (TdAttribute attribute : safe(getAttributes()))
			if (!"".equals(attribute.getRidname()))
				rids.add(attribute.getRidname());
		return new ArrayList<>(rids);
	}

	/**
	 * Gets the attribute that is uid of a TdEntity (null if there are no rids),
	 * if there more than one uid, returns the first one
	 */
	@JsonIgnore
	default TdAttribute getUid() {
		for (TdAttribute attribute : safe(getAttributes()))
			if (attribute.isUid())
				return attribute;
		return null;
	}
	
	/**
	 * Gets an attribute by name (case insensitive), null if not found
	 */
	@JsonIgnore
	default TdAttribute getAttribute(String name) {
		for (TdAttribute attribute : safe(getAttributes()))
			if (attribute.getName().equalsIgnoreCase(name))
				return attribute;
		return null;
	}
	
	// Convenience functions to set and check entity types
	
	@JsonIgnore
	default boolean isObject() {
		return EntityTypes.DT_TABLE.equalsIgnoreCase(getEntitytype());
	}

	@JsonIgnore
	default boolean isType() {
		return EntityTypes.DT_TYPE.equalsIgnoreCase(getEntitytype());
	}

	@JsonIgnore
	default boolean isArray() {
		return EntityTypes.DT_ARRAY.equalsIgnoreCase(getEntitytype());
	}

	@JsonIgnore
	default TdEntity setObject() {
		setEntitytype(EntityTypes.DT_TABLE);
		return (TdEntity) this;
	}

	@JsonIgnore
	default TdEntity setType() {
		setEntitytype(EntityTypes.DT_TYPE);
		return (TdEntity) this;
	}

	@JsonIgnore
	default TdEntity setArray() {
		setEntitytype(EntityTypes.DT_ARRAY);
		return (TdEntity) this;
	}

}