com.tactfactory.harmony.meta.FieldMetadata.java Source code

Introduction

Here is the source code for com.tactfactory.harmony.meta.FieldMetadata.java

Source

/**
 * This file is part of the Harmony package.
 *
 * (c) Mickael Gaillard <mickael.gaillard@tactfactory.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
package com.tactfactory.harmony.meta;

import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

import com.google.common.base.CaseFormat;
import com.tactfactory.harmony.annotation.Column.Type;
import com.tactfactory.harmony.annotation.GeneratedValue.Strategy;
import com.tactfactory.harmony.generator.TagConstant;
import com.tactfactory.harmony.meta.TranslationMetadata.Group;
import com.tactfactory.harmony.platform.IAdapter;
import com.tactfactory.harmony.platform.SqliteAdapter;

/** Entity field metadata. */
public final class FieldMetadata extends BaseMetadata {
    /** Owner. */
    private ClassMetadata owner;

    /** Field harmony type. */
    private String harmonyType;

    /** Column name. */
    private String columnName;

    /** Field database type. */
    private String columnDefinition;

    /** Relation mapped to this field. */
    private RelationMetadata relation;

    /** DefaultValue. */
    private String defaultValue;

    /** Field nullability. */
    private Boolean nullable;
    /** Field unicity. */
    private Boolean unique;
    /** Field locality. */
    private Boolean isLocale;

    /** Field length. */
    private Integer length;
    /** Field precision. */
    private Integer precision;
    /** Field scale. */
    private Integer scale;

    /** Is Field hidden ? */
    private boolean hidden;
    /** Is Field a primitive ? */
    private boolean primitive;
    /** Is field ID ? */
    private boolean id;

    /** Is field internal ? */
    private boolean internal = false;

    /** Is field static ? */
    private boolean isStatic = false;

    /** Is field a column result ? */
    private boolean columnResult = false;

    /** Is field a writable field ? */
    private boolean writable = true;

    /** ID Strategy. */
    private Strategy strategy;

    /** Enum type metadata. */
    private EnumTypeMetadata enumMeta;

    /**
     * Constructor.
     * @param owner ClassMetadata owning this field.
     */
    public FieldMetadata(final ClassMetadata owner) {
        super();
        this.owner = owner;
    }

    /** Add Component String of field.
     * @param componentName The component name
     */
    public final void makeString(final String componentName) {
        if (!this.hidden && !this.internal && (this.owner instanceof EntityMetadata)
                && (!((EntityMetadata) this.owner).isCreateAction() || ((EntityMetadata) this.owner).isShowAction()
                        || ((EntityMetadata) this.owner).isEditAction())
                && !((EntityMetadata) this.owner).isInternal()) {
            final String key = this.owner.getName().toLowerCase() + "_" + this.getName().toLowerCase();

            if (this.harmonyType != null) {
                final boolean isDate = this.harmonyType.equals(Type.DATE.getValue());
                final boolean isTime = this.harmonyType.equals(Type.TIME.getValue());
                final boolean isDateTime = this.harmonyType.equals(Type.DATETIME.getValue());

                if (isDate || isDateTime || isTime) {
                    final String formatKey = "%s_%s_title";
                    final String formatTitle = "Select %s %s";
                    if (isDate || isDateTime) {
                        TranslationMetadata.addDefaultTranslation(
                                String.format(formatKey, key, Type.DATE.getValue()),
                                String.format(formatTitle, this.getName(), Type.DATE.getValue()), Group.MODEL);
                    }

                    if (isTime || isDateTime) {
                        TranslationMetadata.addDefaultTranslation(
                                String.format(formatKey, key, Type.TIME.getValue()),
                                String.format(formatTitle, this.getName(), Type.TIME.getValue()), Group.MODEL);
                    }
                }
            }

            TranslationMetadata.addDefaultTranslation(key + "_" + componentName.toLowerCase(Locale.ENGLISH),
                    CaseFormat.LOWER_CAMEL.to(CaseFormat.UPPER_CAMEL, this.getName()), Group.MODEL);

            if (!this.nullable && !this.harmonyType.equalsIgnoreCase("boolean")
                    && !this.harmonyType.equalsIgnoreCase(Type.ENUM.getValue()) && !this.columnResult) {
                TranslationMetadata.addDefaultTranslation(key + "_invalid_field_error", "Field "
                        + CaseFormat.LOWER_CAMEL.to(CaseFormat.UPPER_CAMEL, this.getName()) + " is invalid.",
                        Group.MODEL);
            }
        }
    }

    /**
     * Transform the field to a map of strings and a relation map.
     * @param adapter The adapter to use.
     * @return the map
     */
    @Override
    public final Map<String, Object> toMap(final IAdapter adapter) {
        final Map<String, Object> model = new HashMap<String, Object>();

        model.put(TagConstant.NAME, this.getName());
        //model.put(TagConstant.TYPE,       this.type);
        model.put(TagConstant.HARMONY_TYPE, this.harmonyType);
        model.put(TagConstant.FIELD_NAME, this.columnName);
        model.put(TagConstant.FIELD_DEF, this.columnDefinition);
        model.put(TagConstant.HIDDEN, this.hidden);
        model.put(TagConstant.PRIMITIVE, this.primitive);
        model.put(TagConstant.UNIQUE, this.unique);
        model.put(TagConstant.ID, this.id);
        model.put(TagConstant.OWNER, this.owner.getName());

        model.put(TagConstant.SCHEMA, SqliteAdapter.generateStructure(this));
        model.put(TagConstant.INTERNAL, this.internal);
        model.put(TagConstant.IS_LOCALE, this.isLocale);
        model.put(TagConstant.NULLABLE, this.nullable);
        model.put(TagConstant.STATIC, this.isStatic);
        model.put(TagConstant.COLUMN_RESULT, this.columnResult);
        model.put(TagConstant.WRITABLE, this.writable);
        if (this.strategy != null) {
            model.put(TagConstant.STRATEGY, this.strategy.getValue());
        } else {
            model.put(TagConstant.STRATEGY, Strategy.MODE_NONE);
        }

        if (this.relation != null) {
            model.put(TagConstant.RELATION, this.relation.toMap(adapter));
        }

        if (this.defaultValue != null) {
            model.put(TagConstant.DEFAULT_VALUE, this.defaultValue);
        }

        if (this.enumMeta != null) {
            model.put(TagConstant.ENUM, this.enumMeta.toMap(adapter));
        }

        final HashMap<String, Object> optionsModel = new HashMap<String, Object>();
        for (final Metadata bm : this.getOptions().values()) {
            optionsModel.put(bm.getName(), bm.toMap(adapter));
        }
        model.put(TagConstant.OPTIONS, optionsModel);

        return model;
    }

    /**
     * @return the owner
     */
    public final ClassMetadata getOwner() {
        return owner;
    }

    /**
     * @param owner the owner to set
     */
    public final void setOwner(final ClassMetadata owner) {
        this.owner = owner;
    }

    /**
     * @return the columnName
     */
    public final String getColumnName() {
        return columnName;
    }

    /**
     * @param columnName the columnName to set
     */
    public final void setColumnName(final String columnName) {
        this.columnName = columnName;
    }

    /**
     * @return the columnDefinition
     */
    public final String getColumnDefinition() {
        return columnDefinition;
    }

    /**
     * @param columnDefinition the columnDefinition to set
     */
    public final void setColumnDefinition(final String columnDefinition) {
        this.columnDefinition = columnDefinition;
    }

    /**
     * @return the relation
     */
    public final RelationMetadata getRelation() {
        return relation;
    }

    /**
     * @param relation the relation to set
     */
    public final void setRelation(final RelationMetadata relation) {
        this.relation = relation;
    }

    /**
     * @return the nullable
     */
    public final Boolean isNullable() {
        return nullable;
    }

    /**
     * @param nullable the nullable to set
     */
    public final void setNullable(final Boolean nullable) {
        this.nullable = nullable;
    }

    /**
     * @return the unique
     */
    public final Boolean isUnique() {
        return unique;
    }

    /**
     * @param unique the unique to set
     */
    public final void setUnique(final Boolean unique) {
        this.unique = unique;
    }

    /**
     * @return the isLocale
     */
    public final Boolean isLocale() {
        return isLocale;
    }

    /**
     * @param isLocale the isLocale to set
     */
    public final void setIsLocale(final Boolean isLocale) {
        this.isLocale = isLocale;
    }

    /**
     * @return the length
     */
    public final Integer getLength() {
        return length;
    }

    /**
     * @param length the length to set
     */
    public final void setLength(final Integer length) {
        this.length = length;
    }

    /**
     * @return the precision
     */
    public final Integer getPrecision() {
        return precision;
    }

    /**
     * @param precision the precision to set
     */
    public final void setPrecision(final Integer precision) {
        this.precision = precision;
    }

    /**
     * @return the scale
     */
    public final Integer getScale() {
        return scale;
    }

    /**
     * @param scale the scale to set
     */
    public final void setScale(final Integer scale) {
        this.scale = scale;
    }

    /**
     * @return the hidden
     */
    public final boolean isHidden() {
        return hidden;
    }

    /**
     * @param hidden the hidden to set
     */
    public final void setHidden(final boolean hidden) {
        this.hidden = hidden;
    }

    /**
     * @return the id
     */
    public final boolean isId() {
        return id;
    }

    /**
     * @param id the id to set
     */
    public final void setId(final boolean id) {
        this.id = id;
    }

    /**
     * @return the internal
     */
    public final boolean isInternal() {
        return internal;
    }

    /**
     * @param internal the internal to set
     */
    public final void setInternal(final boolean internal) {
        this.internal = internal;
    }

    /**
     * @return the harmonyType
     */
    public final String getHarmonyType() {
        return harmonyType;
    }

    /**
     * @param harmonyType the harmonyType to set
     */
    public final void setHarmonyType(final String harmonyType) {
        this.harmonyType = harmonyType;
    }

    /**
     * @return the defaultValue
     */
    public final String getDefaultValue() {
        return defaultValue;
    }

    /**
     * @param defaultValue the defaultValue to set
     */
    public final void setDefaultValue(final String defaultValue) {
        this.defaultValue = defaultValue;
    }

    /**
     * @param isStatic Is static ?
     */
    public final void setStatic(final boolean isStatic) {
        this.isStatic = isStatic;
    }

    /**
     * @param columnResult Is this field a column result ?
     */
    public final void setColumnResult(final boolean columnResult) {
        this.columnResult = columnResult;
        if (columnResult) {
            this.setWritable(false);
        }
    }

    /**
     * @param writable Is this field writable ?
     */
    public final void setWritable(final boolean writable) {
        this.writable = writable;
    }

    @Override
    public String toString() {
        return String.format("FieldMetadata : %s", this.getName());
    }

    /**
     * @return the strategy
     */
    public final Strategy getStrategy() {
        return strategy;
    }

    /**
     * @param strategy the strategy to set
     */
    public final void setStrategy(Strategy strategy) {
        this.strategy = strategy;
    }

    /**
     * @return the enumMeta
     */
    public final EnumTypeMetadata getEnumMeta() {
        return enumMeta;
    }

    /**
     * @param enumMeta the enumMeta to set
     */
    public final void setEnumMeta(final EnumTypeMetadata enumMeta) {
        this.enumMeta = enumMeta;
    }

    /**
     * @return the primitive
     */
    public final boolean isPrimitive() {
        return primitive;
    }

    /**
     * @param primitive the primitive to set
     */
    public final void setPrimitive(boolean primitive) {
        this.primitive = primitive;
    }
}