Skip to main content

Killing SSJS - Passing a parameter using Expression Language - Part 1

Expression Language is a powerful and useful tool, but it doesn't handle parameterized methods (other than Map.get(Object) and DataObject.getValue(Object)). That means if you need to do anything more complicated than simple data retrieval, you have to jump through some hoops. I'm going help you get started here.

I've posted this code before, but here is one simple trick:

public class BaseDataModel implements DataObject, Serializable {
    private static final long serialVersionUID = 1L;

    private Map<Object, Object> values;

    public Class<?> getType(Object key) {
        Object o = getValue(key);
        return o == null ? null : o.getClass();
    }

    public final Object getValue(Object key) {
        try {
            return customGetter(key);
        }
        catch (NoSuchMethodException e) {
            return getMapValue(key);
        }
    }

    protected Object customGetter(Object keyObj) throws NoSuchMethodException {
        if (keyObj instanceof String) {
            String key = (String) keyObj;
            if (key.startsWith("isReadOnly") && key.length() > "isReadOnly".length()) {
                String property = key.substring("isReadOnly".length());
                property = property.substring(0, 1).toLowerCase() + property.substring(1);
                }
                return isReadOnly(property);
            }
        }
        throw new NoSuchMethodException();
    }

    public final void setValue(Object key, Object value) {
        if (isReadOnly(key)) return;
        try {
            customSetter(key, value);
        }
        catch (NoSuchMethodException e) {
            setMapValue(key, value);
        }
    }

    protected void customSetter(Object key, Object value) throws NoSuchMethodException {
        throw new NoSuchMethodException();
    }

    public boolean isReadOnly(Object key) {
        return false;
    }

    protected Map<Object, Object> getValues() {
        if (values == null) {
            values = new HashMap<Object, Object>();
        }
        return values;
    }

    public final Object getMapValue(Object key) {
        return getValues().get(key);
    }

    public final void setMapValue(Object key, Object value) {
        getValues().put(key, value);
    }

    private Set<Object> getKeys() {
        return this.getValues() == null ? null : this.getValues().keySet();
    }
}


This allows you to use an EL expresssion like "#{bean.isReadOnlyFirstName}". This is extendable so you can extend the customGetter() to support prefixes like hasPermissionEdit or getRelatedData. The customGetter intercepts the getValue method and if any patterns are matched, it supplies the result, otherwise the value from the Map is returned. I have been using this for great effect for months since I worked it out.

However, there are some big limitations to this technique:

1) You can't compute any part of the expression. You can't really use this technique in a custom control where you have to use a passed value. You can't really do something like #{getNameFromDoc(DocumentId)}. Caveat: There is a hack I've seen that allows you to do something like ${javascript:'#{isReadOnly'+compositeData.fieldName+'}'"}, but now we're using SSJS to compute EL and that seems to make things worse rather than better.

2) You can't use a hierarchical EL expression like {bean.getFullName.getUserDirectory.getFolderMyDocuments}.

In Part 2: a better solution.

Comments

Popular posts from this blog

Rows per page selection: Part 1

I was asked to create a control that would allow users to select the number of rows per page in a view/repeat control (the application uses both). It seemed simple at first, but I ran into a few issues that I thought I'd share the solutions to. First, lets start at the beginning. I went through the relevant design elements and set row="#{viewScope.tableRows}" , and I created an xp:comboBox with value="#{viewScope.tableRows}" and added items for 20, 30, 50, and 100, and I assigned it an onChange event handler that did a partial execution and partial refresh of a div containing the combo box, pager and the table. Then I started fixing all the problems. Problem 1: The combobox value was a string, but the rows parameter requires an integer. This was causing IllegalArgumentException / java.lang.String incompatible with java.lang.Integer. I added a NumberConverter, but this only slightly changed the exception message to java.lang.Long incompatible with java.lang....

Pass data between XPages and existing LS scripts

I'm working on modernizing a fairly hefty application with a lot of existing script libraries which we want to leverage within the XPages environment. Here is a technique that works very well. First, create an in-memory document in SSJS. We can set any input values needed for the back end. Then we pass that document to a LS Agent which can work it's magic using the values set in SSJS and use the same document to return values back to the XPage. Here is how it works in detail:

XPages Application Framework (Part 1?)

Note: I changed projects and priorities after my last POI article, resulting in a long hiatus. I anticipate using that framework on my current project and will likely refine and complete my related article series. For the past several months, I've been fortunate enough to lead a project overhaul from traditional Domino Webapp to XPages. I had a few goals in mind, but the top three were integrating Bootstrap, embracing MVC principles, and eliminating all SSJS . I imagine the motivation for Bootstrap integration is self-explanatory. There is an OpenNTF project out there called Bootstrap4XPages. I didn't use that for a number of reasons - the main being a policy in the current environment. But you may ask yourself (if you didn't follow that link), why so much hatred for SSJS? I have a litany of reasons. It impacts readability of the XPage source; it hurts maintainability when logic is scattered across dozens of XPages, custom controls, and script libraries; it mixes log...