freemarker.ext.jython

Class JythonModel

Implemented Interfaces:
AdapterTemplateModel, TemplateBooleanModel, TemplateHashModel, TemplateMethodModel, TemplateMethodModelEx, TemplateModel, TemplateScalarModel, WrapperTemplateModel
Known Direct Subclasses:
JythonHashModel, JythonNumberModel, JythonSequenceModel

public class JythonModel
extends java.lang.Object
implements TemplateBooleanModel, TemplateScalarModel, TemplateHashModel, TemplateMethodModelEx, AdapterTemplateModel, WrapperTemplateModel

Generic model for arbitrary Jython objects.
Version:
$Id: JythonModel.java,v 1.14 2005/06/12 19:03:06 szegedia Exp $
Author:
Attila Szegedi

Field Summary

protected PyObject
object
protected JythonWrapper
wrapper

Fields inherited from interface freemarker.template.TemplateBooleanModel

FALSE, TRUE

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Fields inherited from interface freemarker.template.TemplateScalarModel

EMPTY_STRING

Constructor Summary

JythonModel(PyObject object, JythonWrapper wrapper)

Method Summary

Object
exec(List arguments)
TemplateModel
get(String key)
Calls PyObject.__findattr__(java.lang.String), then if it returns null calls PyObject.__finditem__(java.lang.String).
Object
getAdaptedObject(Class hint)
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
boolean
getAsBoolean()
Returns the value of PyObject.__nonzero__().
String
getAsString()
Returns the value of Object.toString().
Object
getWrappedObject()
Retrieves the object wrapped by this model.
boolean
isEmpty()
Returns PyObject.__len__() == 0.

Field Details

object

protected final PyObject object

wrapper

protected final JythonWrapper wrapper

Constructor Details

JythonModel

public JythonModel(PyObject object,
                   JythonWrapper wrapper)

Method Details

exec

public Object exec(List arguments)
            throws TemplateModelException
Specified by:
exec in interface TemplateMethodModel

get

public TemplateModel get(String key)
            throws TemplateModelException
Calls PyObject.__findattr__(java.lang.String), then if it returns null calls PyObject.__finditem__(java.lang.String). If JythonWrapper.setAttributesShadowItems(boolean) was called with false, the order of calls is reversed (that is, item lookup takes precedence over attribute lookup).
Specified by:
get in interface TemplateHashModel

getAdaptedObject

public Object getAdaptedObject(Class hint)
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
Specified by:
getAdaptedObject in interface AdapterTemplateModel
Parameters:
hint - the desired class of the returned value. An implementation should make reasonable effort to retrieve an object of the requested class, but if that is impossible, it must at least return the underlying object as-is. As a minimal requirement, an implementation must always return the exact underlying object when hint.isInstance(underlyingObject) == true holds. When called with java.lang.Object.class, it should return a generic Java object (i.e. if the model is wrapping a scripting lanugage object that is further wrapping a Java object, the deepest underlying Java object should be returned).
Returns:
the underlying object, or its value accommodated for the hint class.

getAsBoolean

public boolean getAsBoolean()
            throws TemplateModelException
Returns the value of PyObject.__nonzero__().
Specified by:
getAsBoolean in interface TemplateBooleanModel

getAsString

public String getAsString()
            throws TemplateModelException
Returns the value of Object.toString().
Specified by:
getAsString in interface TemplateScalarModel

getWrappedObject

public Object getWrappedObject()
Retrieves the object wrapped by this model.
Specified by:
getWrappedObject in interface WrapperTemplateModel

isEmpty

public boolean isEmpty()
            throws TemplateModelException
Returns PyObject.__len__() == 0.
Specified by:
isEmpty in interface TemplateHashModel