Examples of org.apache.tapestry5.ValueEncoder

org.apache.tapestry5.ValueEncoder
A ValueEncoder is used to convert server side objects to unique client-side strings (typically IDs) and back. This mechanism is widely used in Tapestry to allow you to work more seamlessly with objects rather than manually managing the encoding and decoding process throughout your application. Tapestry uses a ValueEncoder when generating an {@link org.apache.tapestry5.EventContext} as part of a URL, and whencomponents (such as {@link org.apache.tapestry5.corelib.components.Select}) need to generate unique client-side strings to be rendered within form elements.
Tapestry can automatically generate ValueEncoders for enums as well as Collections of any object types for which a coercion can be found from a formatted String, such as primitives, primitive wrappers, Dates, Calendars, "name=value" strings, and any types for which a custom coercion has been contributed.
Custom ValueEncoder implementations will need to be supplied for entity type objects. In such cases the {@link #toClient(Object)} method typically returnsan object's database primary key, and the {@link #toValue(String)}re-acquires the corresponding entity object, perhaps by doing a database lookup by that ID.
Some optional modules, such as Tapestry's own Hibernate and JPA modules, can automatically create a ValueEncoder for each of your entity types and then configure Tapestry to use them whenever a ValueEncoder is needed for those types. If you don't use one of those modules, you can still configure Tapestry to automatically use your custom ValueEncoder implementations by having your ValueEncoder implement the {@link org.apache.tapestry5.services.ValueEncoderFactory} interface and thencontributing a ValueEncoderSource that adds your encoder, like this, in your application's module class:
```
 public static void contributeValueEncoderSource( MappedConfiguration<Class<Color>, ValueEncoderFactory<Color>> configuration) { configuration.addInstance(Color.class, ColorEncoder.class); } 
```
@see SelectModel @see org.apache.tapestry5.services.ValueEncoderSource @see org.apache.tapestry5.services.ValueEncoderFactory @see org.apache.tapestry5.annotations.PageActivationContext

                                "The value for query parameter '%s' was blank, but a non-blank value is needed.",
                                parameterName));


                    Class parameterType = classCache.forName(parameterTypeName);


                    ValueEncoder valueEncoder = valueEncoderSource.getValueEncoder(parameterType);


                    Object value = valueEncoder.toValue(parameterValue);


                    if (parameterType.isPrimitive() && value == null)
                        throw new RuntimeException(
                                String.format(
                                        "Query parameter '%s' evaluates to null, but the event method parameter is type %s, a primitive.",

View Full Code Here

                    if (isArray)
                    {
                        parameterType = parameterType.getComponentType();
                    }


                    ValueEncoder valueEncoder = valueEncoderSource.getValueEncoder(parameterType);


                    String parameterValue = request.getParameter(parameterName);


                    if (!allowBlank && InternalUtils.isBlank(parameterValue))
                        throw new RuntimeException(String.format(
                                "The value for query parameter '%s' was blank, but a non-blank value is needed.",
                                parameterName));


                    Object value;


                    if (!isArray)
                    {
                        value = coerce(parameterName, parameterType, parameterValue, valueEncoder, allowBlank);
                    } else
                    {
                        String[] parameterValues = request.getParameters(parameterName);
                        Object[] array = (Object[]) Array.newInstance(parameterType, parameterValues.length);
                        for (int i = 0; i < parameterValues.length; i++)
                        {
                            array[i] = coerce(parameterName, parameterType, parameterValues[i], valueEncoder, allowBlank);
                        }
                        value = array;
                    }


                    return value;
                } catch (Exception ex)
                {
                    throw new RuntimeException(
                            String.format(
                                    "Unable process query parameter '%s' as parameter #%d of event handler method %s: %s",
                                    parameterName, parameterIndex + 1, methodIdentifier,
                                    ExceptionUtils.toMessage(ex)), ex);
                }
            }


            private Object coerce(final String parameterName, Class parameterType,
                                  String parameterValue, ValueEncoder valueEncoder, boolean allowBlank)
            {


                if (!allowBlank && InternalUtils.isBlank(parameterValue))
                {
                    throw new RuntimeException(String.format(
                            "The value for query parameter '%s' was blank, but a non-blank value is needed.",
                            parameterName));
                }


                Object value = valueEncoder.toValue(parameterValue);


                if (parameterType.isPrimitive() && value == null)
                    throw new RuntimeException(
                            String.format(
                                    "Query parameter '%s' evaluates to null, but the event method parameter is type %s, a primitive.",

View Full Code Here

        // Assumption: the field type is not one that's loaded by the component class loader, so it's safe
        // to convert to a hard type during class transformation.


        Class fieldType = classCache.forName(field.getTypeName());


        ValueEncoder encoder = valueEncoderSource.getValueEncoder(fieldType);


        FieldHandle handle = field.getHandle();


        String fieldName = String.format("%s.%s", field.getPlasticClass().getClassName(), field.getName());

View Full Code Here

                                "The value for query parameter '%s' was blank, but a non-blank value is needed.",
                                parameterName));


                    Class parameterType = classCache.forName(parameterTypeName);


                    ValueEncoder valueEncoder = valueEncoderSource.getValueEncoder(parameterType);


                    Object value = valueEncoder.toValue(parameterValue);


                    if (parameterType.isPrimitive() && value == null)
                        throw new RuntimeException(
                                String.format(
                                        "Query parameter '%s' evaluates to null, but the event method parameter is type %s, a primitive.",

View Full Code Here

                                "The value for query parameter '%s' was blank, but a non-blank value is needed.",
                                parameterName));


                    Class parameterType = classCache.forName(parameterTypeName);


                    ValueEncoder valueEncoder = valueEncoderSource.getValueEncoder(parameterType);


                    Object value = valueEncoder.toValue(parameterValue);


                    if (parameterType.isPrimitive() && value == null)
                        throw new RuntimeException(
                                String.format(
                                        "Query parameter '%s' evaluates to null, but the event method parameter is type %s, a primitive.",

View Full Code Here

        // Assumption: the field type is not one that's loaded by the component class loader, so it's safe
        // to convert to a hard type during class transformation.


        Class fieldType = classCache.forName(field.getType());


        ValueEncoder encoder = valueEncoderSource.getValueEncoder(fieldType);


        FieldAccess access = field.getAccess();


        setValueFromInitializeEventHandler(transformation, access, parameterName, encoder);
        decorateLinks(transformation, access, parameterName, encoder);

View Full Code Here

            final ClassPropertyAdapter classPropertyAdapter = this.propertyAccess
                    .getAdapter(object);


            final PropertyAdapter propertyAdapter = classPropertyAdapter.getPropertyAdapter(labelProperty);


            final ValueEncoder encoder = this.valueEncoderSource.getValueEncoder(propertyAdapter.getType());


            final Object label = propertyAdapter.get(object);


            options.add(new OptionModelImpl(encoder.toClient(label), object));


        }


        return new SelectModelImpl(null, options);
    }

View Full Code Here


    public String toClient(Object value)
    {
        assert value != null;


        ValueEncoder encoder = valueEncoderSource.getValueEncoder(value.getClass());


        return encoder.toClient(value);
    }

View Full Code Here

                message += " You should ensure that the getKeyType() method returns the correct Class.";


            throw new RuntimeException(message);
        }


        return new ValueEncoder()
        {
            public String toClient(Object value)
            {
                Object key = input.toKey(value);

View Full Code Here


        expect(pke.toValue(primaryKey)).andReturn(value);


        replay();


        ValueEncoder ve = coercion.coerce(pke);


        assertEquals(ve.toClient(value), "99");
        assertEquals(ve.toValue("99"), value);


        verify();
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.tapestry5.ValueEncoder

domain.Blog

manager.BlogManager

org.apache.tapestry5.Asset

org.apache.tapestry5.BooleanHook

org.apache.tapestry5.ContentType

org.apache.tapestry5.corelib.components.Form

org.apache.tapestry5.corelib.components.Palette

org.apache.tapestry5.corelib.components.Select

org.apache.tapestry5.corelib.components.Tree

org.apache.tapestry5.corelib.internal.FormSupportImpl

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.