jpaoletti.jpm.core.VisualizationWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpm-core Show documentation

Core module for jpm

The newest version!

package jpaoletti.jpm.core;

import java.util.Map;

/**This class provides a way to add read only fields to any operation of an entity. A programmer can subclass 
 * this class to add visualization functionality such as balances, counters or any complex or simple function
 * that requires more than a getter.

 * 
 * Not yet implemented
 *    
 * @author jpaoletti 
 *  
 * */
public abstract class VisualizationWrapper {

    /** A map with the calculated values of the field*/
    private Map values;

    /**
     * This abstract method must be defined for each implementation and must
     * fill the values map.
     * @param ctx The context
     * @param object The entity instance to get any data required for calculation*/
    public abstract void load(PMContext ctx, Object object);

    /**This function is automatically invoked to get the values configured in the entity 
     * configuration file
     * 
     * @param name The name of the requested value 
     * @return The value for the given field name
     * */
    public Object get(String name) {
        return values.get(name);
    }
}