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

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:

Quick tip: Convert a number to String in EL

I just had a need to do this and a Google search didn't immediately turn up a solution. So I thought for a couple of minutes and came up with this: value="0#{numberVar}" This takes advantage of the way Java auto-converts objects to strings when doing a concatenation. So if your number is 13, Java EL turns this into new String("0"+13), which becomes "013". You can then strip off the leading zero or just parse the string back into a number.

Project in Review - Part 3: What didn't work

Of course, not everything was an unmitigated success. I tried many things that didn't work out. Much of which I've removed and forgotten about, but a few things remain - either scarred into my psyche or woven too deeply to fix. What didn't work Storing my entire configuration in application.properties Using properties files is great. It let me get configuration out of a profile document and into something much easier to edit - particularly configuration that users will never see or maintain (and thus there is no need for an interface for). But I took it too far. The paths to the other databases are there, and that's good. But view aliases are also there, and that was a mistake. I already have a ViewDefinition enum that describes each view and all the information I need to know about it. I could have set view names there, but instead I'm reading them from the application config. I can change where a view is pointing without having to go into my code. Except of co