source: trunk/grails-app/domain/dbnp/studycapturing/TemplateField.groovy @ 556

package dbnp.studycapturing

import dbnp.data.Ontology

/**
 * This is the class for template fields. These should be part of one or more templates via Template.fields
 *
 * Revision information:
 * $Rev: 556 $
 * $Author: roberth $
 * $Date: 2010-06-10 14:45:53 +0000 (do, 10 jun 2010) $
 */
class TemplateField implements Serializable {
        String name
        TemplateFieldType type
    Class entity
        String unit
        String comment // help string for the user interface
        List listEntries
        boolean required
        boolean preferredIdentifier

        static hasMany = [
                listEntries: TemplateFieldListItem,     // to store the entries to choose from when the type is 'item from predefined list'
                ontologies: Ontology                                    // to store the ontologies to choose from when the type is 'ontology term'
        ]

        static constraints = {
                // TODO: verify that TemplateField names are unique within templates of each super entity
                name(nullable: false, blank: false)
                type(nullable: false, blank: false)
                entity(nullable: false, blank: false)
                unit(nullable: true, blank: true)
                comment(nullable: true, blank: true)
                required(default: false)
                preferredIdentifier(default: false)
        }

        static mapping = {
                // TODO: this doesn't seem to work in Postgres
                comment type: 'text'
        }

        String toString() {
                return name
        }

        /**
         * return an escaped name which can be used in business logic
         * @return String
         */
        def String escapedName() {
                return name.toLowerCase().replaceAll("([^a-z0-9])", "_")
        }

        /**
         * overloading the findAllByEntity method to make it function as expected
         * @param Class entity (for example: dbnp.studycapturing.Subject)
         * @return ArrayList
         */
        public static findAllByEntity(java.lang.Class entity) {
                def results = []
                // 'this' should not work in static context, so taking Template instead of this
                TemplateField.findAll().each() {
                        if (entity.equals(it.entity)) {
                                results[results.size()] = it
                        }
                }

                return results
        }

        /**
         * Checks whether this template field is used in a template
         *
         * @returns             true iff this template field is used in a template (even if the template is never used), false otherwise
         */
        def inUse() {
                return numUses() > 0;
        }

        /**
         * The number of templates that use this template
         *
         * @returns             the number of templates that use this template.
         */
        def numUses() {
                def templates = Template.findAll();
                def elements;
                if( templates && templates.size() > 0 ) {
                        elements = templates.findAll { template -> template.fields.contains( this ) };
                } else {
                        return 0;
                }

                return elements.size();
        }


}