jhipster-rasha-core/lib/core/jdl_field.js

JHipster's own domain language and core objects

'use strict';

const merge = require('../utils/object_utils').merge,
  isNilOrEmpty = require('../utils/string_utils').isNilOrEmpty,
  buildException = require('../exceptions/exception_factory').buildException,
  exceptions = require('../exceptions/exception_factory').exceptions,
  JDLValidation = require('./jdl_validation');

class JDLField {
  constructor(args) {
    const merged = merge(defaults(), args);
    if (isNilOrEmpty(merged.name) || isNilOrEmpty(merged.type)) {
      throw new buildException(
        exceptions.NullPointer,
        'The field name and type are mandatory.');
    }
    this.name = merged.name;
    this.type = merged.type;
    this.comment = merged.comment;

    /**
     * key: the validation's name, value: the validation object
     */
    this.validations = merged.validations;
  }

  addValidation(validation) {
    if (!JDLValidation.isValid(validation)) {
      throw new buildException(exceptions.InvalidObject, 'The passed validation must be valid.');
    }
    this.validations[validation.name] = validation;
  }

  static isValid(field) {
    if (field == null || isNilOrEmpty(field.name) || isNilOrEmpty(field.type)) {
      return false;
    }
    if ('validations' in field) {
      for (let i = 0; i < field.validations.length; i++) {
        if (!JDLValidation.isValid(field.validations[i])) {
          return false;
        }
      }
    }
    return true;
  }

  toString() {
    let string = '';
    if (this.comment) {
      string += '/**\n' + this.comment.split('\n').map(line => ` * ${line}\n`).join('') + ` */\n`;
    }
    string += `${this.name} ${this.type}`;
    for (let validationName in this.validations) {
      if (this.validations.hasOwnProperty(validationName)) {
        string += ` ${this.validations[validationName].toString()}`;
      }
    }
    return string;
  }
}

module.exports = JDLField;

function defaults() {
  return {
    validations: {}
  };
}