ebean/src/main/java/com/avaje/ebeaninternal/server/el/ElPropertyValue.java

package com.avaje.ebeaninternal.server.el;

import com.avaje.ebean.bean.EntityBean;
import com.avaje.ebean.text.StringFormatter;
import com.avaje.ebean.text.StringParser;

/**
 * The expression language object that can get values.
 * <p>
 * This can be used for local sorting and filtering.
 * </p>
 */
public interface ElPropertyValue extends ElPropertyDeploy {

    /**
     * Return the Id values for the given bean value.
     */
    public Object[] getAssocOneIdValues(EntityBean bean);

    /**
     * Return the Id expression string.
     * <p>
     * Typically used to produce id = ? expression strings.
     * </p>
     */
    public String getAssocOneIdExpr(String prefix, String operator);

    /**
     * Return the logical id value expression taking into account embedded id's.
     */
    public String getAssocIdInValueExpr(int size);
        
    /**
     * Return the logical id in expression taking into account embedded id's.
     */
    public String getAssocIdInExpr(String prefix);
    
    /**
     * Return true if this is an ManyToOne or OneToOne associated bean property.
     */
    public boolean isAssocId();

    /**
     * Return true if any path of this path contains a Associated One or Many.
     */
    public boolean isAssocProperty();

    /**
     * Return true if the property is encrypted via Java.
     */
    public boolean isLocalEncrypted();
    
    /**
     * Return true if the property is encrypted in the DB.
     */
    public boolean isDbEncrypted();

    /**
     * Return the deploy order for the property.
     */
    public int getDeployOrder();
    
    /**
     * Return the default StringParser for the scalar property.
     */
    public StringParser getStringParser();

    /**
     * Return the default StringFormatter for the scalar property.
     */
    public StringFormatter getStringFormatter();

    /**
     * Return true if the last type is "DateTime capable" - can support
     * {@link #parseDateTime(long)}.
     */
    public boolean isDateTimeCapable();

    /**
     * Return the underlying JDBC type or 0 if this is not a scalar type.
     */
    public int getJdbcType();
    
    /**
     * For DateTime capable scalar types convert the long systemTimeMillis into
     * an appropriate java time (Date,Timestamp,Time,Calendar, JODA type etc).
     */
    public Object parseDateTime(long systemTimeMillis);

    /**
     * Return the value from a given entity bean.
     */
    public Object elGetValue(EntityBean bean);

    /**
     * Return the value ensuring objects prior to the top scalar property are
     * automatically populated.
     */
    public Object elGetReference(EntityBean bean);

    /**
     * Set a value given a root level bean.
     * <p>
     * If populate then
     * </p>
     */
    public void elSetValue(EntityBean bean, Object value, boolean populate);

    /**
     * Convert the value to the expected type.
     * <p>
     * Typically useful for converting strings to the appropriate number type
     * etc.
     * </p>
     */
    public Object elConvertType(Object value);
}