de.tsl2.nano.bean.def.ValueGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tsl2.nano.descriptor Show documentation
TSL2 Framework Descriptor (currency-handling, generic formatter, descriptors for beans, collections, actions and values)
There is a newer version: 2.5.1
Show newest version
/*
 * File: $HeadURL$
 * Id  : $Id$
 * 
 * created by: Thomas Schneider
 * created on: Jul 10, 2012
 * 
 * Copyright: (c) Thomas Schneider 2012, all rights reserved
 */
package de.tsl2.nano.bean.def;

import java.util.LinkedHashMap;

import org.simpleframework.xml.ElementMap;

import de.tsl2.nano.action.IActivable;
import de.tsl2.nano.core.cls.IAttribute;

/**
 * description of a value group inside a bean. usable to create sub panel informations. you can define a full set of
 * child attribute names or only the first and the last one. normally, the order of attributes is constrained, so the
 * attributes between the first and the last are defined by order.
 * 
 * @author Thomas Schneider
 * @version $Revision$
 */
public class ValueGroup extends Presentable {
    /** serialVersionUID */
    private static final long serialVersionUID = -6371693652730976950L;

    /** attributes of this group.attribute name to show details for - useful for sub-panels */
    @ElementMap(inline = true, attribute=true, entry = "attribute", key = "name", keyType = String.class, value = "details", valueType = Boolean.class, required=false)
    LinkedHashMap attributes;

    /**
     * constructor to be serializable
     */
    protected ValueGroup() {
        this("", true);
    }

    public ValueGroup(String label, Boolean open, String... attributeNames) {
        this.label = label;
        this.description = label;
        attributes = new LinkedHashMap();
        for (int i = 0; i < attributeNames.length; i++) {
            add(attributeNames[i]);
        }
        if (!open) {
            setEnabler(IActivable.INACTIVE);
        }
        type = TYPE_FORM;
    }

    /**
     * setAttributeNames
     * 
     * @param attributeNames
     */
    public void setAttributes(LinkedHashMap attributes) {
        this.attributes = attributes;
    }

    /**
     * getAttributeNames
     * 
     * @return child attributes
     */
    public LinkedHashMap getAttributes() {
        return attributes;
    }

    /**
     * adds the given attribute
     * 
     * @param name attribute name
     */
    public void add(String name) {
        add(name, false);
    }

    /**
     * adds the given attribute
     * 
     * @param name attribute name
     */
    public void add(String name, boolean showDetails) {
        attributes.put(name, showDetails);
    }

    /**
     * isDetail
     * 
     * @param attributeName name to look for
     * @return true, if this attribute name should be showed with details (sub-panel).
     */
    public boolean isDetail(String attributeName) {
        Boolean isDetail = false;
        return (isDetail = attributes.get(attributeName)) != null && isDetail;
    }

    public void addNesting(BeanValue attributeNestingBean) {
        addNesting(attributeNestingBean.getInstance(), attributeNestingBean);
    }

    /**
     * adds all bean attributes of the given attribute, that has to be an instance of another bean.
     * 
     * @param nestingBean nesting attribute bean
     */
    public void addNesting(Object instance, IAttribute attributeNestingBean) {
        Object value = attributeNestingBean.getValue(instance);
        if (value != null) {
            BeanDefinition beanDefinition = BeanDefinition.getBeanDefinition(value.getClass());
            String bname = beanDefinition.getName();
            for (String attr : beanDefinition.getAttributeNames()) {
                attributes.put(bname + "." + attr, false);
            }
        }
    }
}