org.technologybrewery.fermenter.mda.metamodel.element.Entity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fermenter-mda Show documentation
The newest version!
package org.technologybrewery.fermenter.mda.metamodel.element;

import java.util.List;

import org.apache.commons.lang3.StringUtils;

import com.fasterxml.jackson.annotation.JsonValue;

/**
 * Defines the contract for a entity that contains fields and associations.
 */
public interface Entity extends NamespacedMetamodel {

    /**
     * Returns service-level documentation.
     * 
     * @return service documentation
     */
    String getDocumentation();

    /**
     * Returns the name of the table mapped to this entity.
     * 
     * @return table name
     */
    String getTable();

    /**
     * Returns the lock strategy for the table. (e.g., optimistic, pessimistic, none)
     * 
     * @return lock strategy
     */
    LockStrategy getLockStrategy();

    /**
     * Determines whether this is a persistent or transient object. By default, all entities as persistent.
     * 
     * @return transient nature of this instance
     */
    Boolean isTransient();

    /**
     * Returns whether this entity has been marked as the parent of any other entity and the defined inheritance
     * strategy indicates that this parent entity is non-persistent. 

     * 

     * NOTE: While somewhat similar, this models a different concept than {@link Entity#isTransient()}. Transient
     * entities have *no* persistent state, while non-persistent parent entities may have persistent fields declared
     * within them, but the parent entities are not directly persisted (their concrete child subclasses are).
     * 
     * @return
     */
    Boolean isNonPersistentParentEntity();

    /**
     * Returns true when parent is marked as non persistent
     * 
     * @return
     */
    Boolean isChildOfNonPersistentParentEntity();

    /**
     * Returns information about a parent entity.
     * 
     * @return parent entity info
     */
    Parent getParent();

    /**
     * Returns the identifier for this instance. If you want to use a multi-part key, we recommend treating those values
     * as a business keys and maintain a single programmatic key. This makes generation substantially more
     * straightforward in these situations.
     * 
     * @return identifier
     */
    Field getIdentifier();

    /**
     * Returns fields for this instance.
     * 
     * @return list of fields
     */
    List getFields();

    /**
     * Returns references for this instance.
     * 
     * @return list of references
     */
    List getReferences();

    /**
     * Returns relations for this instance.
     * 
     * @return list of relations
     */
    List getRelations();

    Relation getRelation(String type);

    /**
     * Returns the entities that have specified this entity as a relation
     * 
     * @param type
     * @return
     */
    List getInverseRelations();

    /**
     * Enumerated values representing allowed lock strategies.
     */
    public enum LockStrategy {
        OPTIMISTIC("optimistic"), NONE("none");

        private String value;

        private LockStrategy(String value) {
            this.value = value;
        }

        /**
         * Returns the instance for the passed strategy value (ignoring case).
         * 
         * @param value
         *            string representation
         * @return instance
         */
        public static LockStrategy fromString(String value) {
            LockStrategy matchedStrategy = null;
            for (LockStrategy strategy : LockStrategy.values()) {
                if (StringUtils.equalsIgnoreCase(strategy.value, value)) {
                    matchedStrategy = strategy;
                    break;
                }
            }

            return matchedStrategy;
        }

        /**
         * {@inheritDoc}
         */
        @JsonValue
        @Override
        public String toString() {
            return value;
        }

        /**
         * A comma-separated list of valid options.
         * 
         * @return valid options
         */
        public static String options() {
            StringBuilder sb = new StringBuilder();
            boolean isFirst = true;
            for (LockStrategy strategy : values()) {
                if (!isFirst) {
                    sb.append(", ");
                }

                sb.append(strategy.toString());

                isFirst = false;
            }

            return sb.toString();
        }

    }

}