com.jaxio.celerio.configuration.entity.ManyToManyConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of celerio-engine Show documentation
Celerio Core Generation Engine
There is a newer version: 4.0.23
/*
 * Copyright 2015 JAXIO http://www.jaxio.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.jaxio.celerio.configuration.entity;

import com.jaxio.celerio.configuration.MetaAttribute;
import lombok.Setter;

import java.util.List;

import static org.apache.commons.lang.StringUtils.isNotBlank;
import static org.springframework.util.StringUtils.hasLength;

/*
 * The ManyToManyConfig allows you to fine tune your @ManyToMany association. The ManyToManyConfig element must be a child of a columnConfig element referencing
 * (i.e foreignkey) the entity that is the target of this @ManyToMany association. The columnConfig necessarily belongs to a 'join entity'.
 */
@Setter
public class ManyToManyConfig implements CascadeGetter, CacheConfigGetter, FetchTypeGetter, OrderByGetter, AssociationActionGetter, LabelGetter {
    private String var;
    private String elementVar;
    private FetchType fetch;
    private String orderBy;
    private Integer displayOrder;
    private String targetEntityName;
    private List labels;
    private List cascades;
    private CacheConfig cacheConfig;
    private AssociationAction associationAction;
    private List metaAttributes;

    /*
     * The variable name for the collection. It should be plural, for example: 'children'. Please configure also the elementVar as the singular of this var.
     */
    public String getVar() {
        return var;
    }

    public boolean hasVar() {
        return hasLength(getVar());
    }

    /*
     * The variable name for an element of the collection. For example, if the variable name for the collection is 'children', the elementVar should be child.
     * This elementVar will be used to generate convenient methods for the collection, such as an adder method addChild(YourType child).
     */
    public String getElementVar() {
        return elementVar;
    }

    public boolean hasElementVar() {
        return hasLength(elementVar);
    }

    /*
     * The JPA fetch type for this association. Use NONE if you do not want any fetchType to be set.
     */
    public FetchType getFetch() {
        return fetch;
    }

    /*
     * Specifies the ordering of the elements. If not null, the JPA @OrderBy annotation is used.
     * Example: orderBy="birthdate DESC" will generate @OrderBy("birthdate DESC").
     */
    public String getOrderBy() {
        return orderBy;
    }

    /*
     * The order of appearance of this many to many in forms, from top to bottom or from left to right. It defaults to alphabetical order.
     */
    public Integer getDisplayOrder() {
        return displayOrder;
    }

    /*
     * If the target entity is part of a SINGLE_TABLE inheritance hierarchy, you must set name of the target entity as Celerio cannot guess it.
     */
    public String getTargetEntityName() {
        return targetEntityName;
    }

    public boolean hasTargetEntityName() {
        return isNotBlank(targetEntityName);
    }

    /*
     * The labels for this association.
     */
    public List getLabels() {
        return labels;
    }

    /*
     * The list of JPA cascade types for the this association.
     */
    public List getCascades() {
        return cascades;
    }

    /*
     * Convenient for hbm2celerio to avoid dead tags.
     */
    public void forceCascadesToNullIfEmpty() {
        if (cascades != null && cascades.isEmpty()) {
            cascades = null;
        }
    }

    /*
     * The 2d level cache configuration for this association.
     */
    public CacheConfig getCacheConfig() {
        return cacheConfig;
    }

    /*
     * Configure which actions should or should not be generated for this association in the front end layer.
     */
    public AssociationAction getAssociationAction() {
        return associationAction;
    }

    /**
     * Meta attributes are free form key value pairs.
     */
    public List getMetaAttributes() {
        return metaAttributes;
    }


    public boolean hasMetaAttributes() {
        return metaAttributes != null && !metaAttributes.isEmpty();
    }
}