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:

Fixing FontAwesome for Windows 10

I ran into an issue with FontAwesome a few months back, where a NoCache header was being injected at the server and FA was broken for any partial refresh. I convinced the admin to reverse that setting and all was well until last week... We had some users who were not getting any icons to appear. Ever. We tracked it down to a new Windows 10 setting for IE11 which disallows untrusted fonts. Since we do not set security protocols for our users, and there is no chance of ever convincing those admins to change this policy that they explicitly turned on, I had to find a new solution. I did some searching and it turned out to not be too difficult. First, here is the original implementation. The theme: <control> <name>Icon.Search</name> <property mode="override"> <name>tagName</name> <value>i</value> </property> <property mode="concat"> <name>styleClass</name> <value>fa fa-search...

XPages Application Framework (Part 2 of ?)

In my last post, I offered a very rough overview of the framework I've been building and adapting. Full credit where it's due, I've been borrowing and adapting from Jesse Gallagher's XPages Scaffolding - an awesome project that I've learned a great deal dissecting. This is one of those projects that, if you make the effort to truly understand it, will give you entirely new tools and approaches for problems. As usual, I've learned the most changin g things and breaking them. My project differ s f rom Jesse's mostly in that it supports 8.5.3 and doesn't require any relaxed security permissions - bec ause I'm on 8.5.3 and because the admins h ere will not grant any relaxed permissions.