de.tsl2.nano.bean.def.GroupingPresentable 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: Tom
 * created on: 10.03.2017
 * 
 * Copyright: (c) Thomas Schneider 2017, all rights reserved
 */
package de.tsl2.nano.bean.def;

import java.util.Collection;
import java.util.LinkedList;

import org.simpleframework.xml.Attribute;
import org.simpleframework.xml.ElementList;

/**
 * Presentable extension to define group-by statements similar to sql group-by/having
 *  
 * @author Tom
 * @version $Revision$ 
 */
public class GroupingPresentable extends Presentable {
    /** serialVersionUID */
    private static final long serialVersionUID = -3479452140340072920L;
    
    /** optional grouping informations */
    @ElementList(inline = true, entry = "groupby", type = GroupBy.class, required = false)
    protected Collection groups;
    @Attribute(required=false)
    protected int gridWidth;
    @Attribute(required=false)
    protected int gridHeight;
    
    /**
     * constructor
     */
    public GroupingPresentable() {
        super();
    }
        
    public GroupingPresentable(AttributeDefinition attr) {
        super(attr);
    }

    /**
     * @return Returns the groups.
     */
    public Collection getGroups() {
        return groups;
    }

    /**
     * adds a GroupBy group for the given attribute with a having expression
     * @param title
     * @param attribute
     * @param having
     * @return true, if successfull added to the GroupBy collection
     */
    public boolean addGroup(String title, String attribute, String having) {
        if (groups == null)
            groups = new LinkedList();
        return groups.add(new GroupBy(title, attribute, having));
    }
    
    /**
     * @param groups The groups to set.
     */
    public void setGroups(Collection groups) {
        this.groups = groups;
    }

    /**
     * getGroupByFor
     * @param instance instance to check for GroupBy expressions
     * @return GroupBy or null
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    public GroupBy getGroupByFor(BeanCollector collector, Object instance) {
        String colText;
        if (groups != null) {
            for (GroupBy g : groups) {
                colText = collector.getColumnText(instance, collector.getAttribute(g.getAttribute()));
                if (colText.matches(g.getHaving()))
                    return g;
            }
        }
        return null;
    }

    /**
     * @return Returns the gridWidth.
     */
    public int getGridWidth() {
        return gridWidth;
    }

    /**
     * @param gridWidth The gridWidth to set.
     */
    public void setGridWidth(int gridWidth) {
        this.gridWidth = gridWidth;
    }

    /**
     * @return Returns the gridHeight.
     */
    public int getGridHeight() {
        return gridHeight;
    }

    /**
     * @param gridHeight The gridHeight to set.
     */
    public void setGridHeight(int gridHeight) {
        this.gridHeight = gridHeight;
    }

    /**
     * @return Returns the serialversionuid.
     */
    public static long getSerialversionuid() {
        return serialVersionUID;
    }

}