freemarker.ext.jython
Class JythonModel

java.lang.Object
  extended byfreemarker.ext.jython.JythonModel
All Implemented Interfaces:
TemplateBooleanModel, TemplateHashModel, TemplateMethodModel, TemplateMethodModelEx, TemplateModel, TemplateScalarModel, WrapperTemplateModel
Direct Known Subclasses:
JythonHashModel, JythonNumberModel, JythonSequenceModel

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

Generic model for arbitrary Jython objects.

Version:
$Id: JythonModel.java,v 1.12 2003/09/22 23:56:53 revusky Exp $
Author:
Attila Szegedi

Field Summary
protected  org.python.core.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(org.python.core.PyObject object, JythonWrapper wrapper)
           
 
Method Summary
 java.lang.Object exec(java.util.List arguments)
          Executes a method call.
 TemplateModel get(java.lang.String key)
          Calls PyObject.__findattr__(java.lang.String), then if it returns null calls PyObject.__finditem__(java.lang.String).
 boolean getAsBoolean()
          Returns the value of PyObject.__nonzero__().
 java.lang.String getAsString()
          Returns the value of Object.toString().
 java.lang.Object getWrappedObject()
          Retrieves the object wrapped by this model.
 boolean isEmpty()
          Returns PyObject.__len__() == 0.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

object

protected final org.python.core.PyObject object

wrapper

protected final JythonWrapper wrapper
Constructor Detail

JythonModel

public JythonModel(org.python.core.PyObject object,
                   JythonWrapper wrapper)
Method Detail

getAsBoolean

public boolean getAsBoolean()
                     throws TemplateModelException
Returns the value of PyObject.__nonzero__().

Specified by:
getAsBoolean in interface TemplateBooleanModel
Returns:
whether to interpret this object as true or false in a boolean context
Throws:
TemplateModelException

getAsString

public java.lang.String getAsString()
                             throws TemplateModelException
Returns the value of Object.toString().

Specified by:
getAsString in interface TemplateScalarModel
Throws:
TemplateModelException

get

public TemplateModel get(java.lang.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
Parameters:
key - the name by which the TemplateModel is identified in the template.
Returns:
the TemplateModel referred to by the key, or null if not found.
Throws:
TemplateModelException

isEmpty

public boolean isEmpty()
                throws TemplateModelException
Returns PyObject.__len__() == 0.

Specified by:
isEmpty in interface TemplateHashModel
Throws:
TemplateModelException

exec

public java.lang.Object exec(java.util.List arguments)
                      throws TemplateModelException
Description copied from interface: TemplateMethodModel
Executes a method call. All arguments passed to the method call are treated as TemplateScalarModels, and evaluated to Strings before being passed. If some of the passed arguments is not a scalar, an exception will occur and the method will not be called. If your method would like to act on actual data model objects instead of on their String representations, implement the TemplateMethodModelEx instead.

Specified by:
exec in interface TemplateMethodModel
Parameters:
arguments - a List of String objects containing the values of the arguments passed to the method.
Returns:
the TemplateModel produced by the method, or null.
Throws:
TemplateModelException
See Also:
TemplateMethodModel.exec(List)

getWrappedObject

public java.lang.Object getWrappedObject()
Description copied from interface: WrapperTemplateModel
Retrieves the object wrapped by this model.

Specified by:
getWrappedObject in interface WrapperTemplateModel