Skip to main content

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

In part 1, I showed how you can expand the DataObject implementation to allow you to pass a parameter to a method and return the result. It's not a perfectly elegant solution, and it has some limitations, but it's a very solid technique and not at all difficult to implement or maintain. But I kept running into roadblocks. What if I have to compute part of the expression? What if I have to get a value based on another parameterized getter? You can't compute part of an EL expression in your EL.

So after some research and experimentation, I created the GetMap. This isn't a new concept - it was developed for JSF 1.1 (which is what XPages is built on) but the rest of the world has moved on to JSF 2.0 and so some of these older techniques can be a little tricky to unearth since this hasn't been an issue in the JSF world for years.
A GetMap works on the concept that JSF knows how to talk to Map objects. CompositeData is a Map, and EL can do #{compositeData.dataSource[compositeData.fieldName]}. With that in mind, let me show you the GetMap:

public abstract class GetMap<V> implements Map<String, V> {
public abstract V get(Object key);
}

Pretty simple, isn't it? The Map will require you to implement a number of other methods, but just have them return null or throw an UnsupportedOperationException. We aren't using any of them.

And here is how we implement it in a bean:

public class MyBean implements Serializable {
private static final long serialVersionUID = 1L;

transient private GetMap<Boolean> readOnlyGetter = new GetMap<Boolean>() {
@Override
public Boolean get(final Object key) {
if(null==unid || !(unid instanceof String)){
throw new IllegalArgumentException();
}
return isReadOnly(key);
};

public GetMap<Boolean> getReadOnly() {
return readOnlyGetter;
}
}

And here is the expression language:
isRendered="#{myBean.readOnly['firstName']"

And one thing you'll notice is that you can compute the value passed to the map. Like so:
isRendered="#{myBean.readOnly[compositeData.fieldName]}"

The way this works:
  1. EL translates myBean.readOnly into myBean.getReadOnly()
  2. getReadOnly() returns a Map, which EL recognises and understands.
  3. ['firstName'] is seen as a property of the map, so EL calls ((Map) myBean.getReadOnly()).get('firstName').
  4. Instead of being an actual map implementation, our GetMap simply runs some code when get is called, returning an object based on the parameter it receives.
This concept can be expanded further by returning a GetMap, enabling EL such as:

value="#{myBean.supportDoc['lineItems'].quantity['capitalItems']}"

Let me know what you think!

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