Back to index

plone3  3.1.7
Public Member Functions
PortalTransforms.interfaces.itransform Class Reference
Inheritance diagram for PortalTransforms.interfaces.itransform:
Inheritance graph
[legend]
Collaboration diagram for PortalTransforms.interfaces.itransform:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def name
def convert

Detailed Description

A transformation plugin -- tranform data somehow
must be threadsafe and stateless

Definition at line 41 of file interfaces.py.


Member Function Documentation

def PortalTransforms.interfaces.itransform.convert (   data,
  idata,
  filename = None,
  kwargs 
)
convert the data, store the result in idata and return that

optional argument filename may give the original file name of received data

additional arguments given to engine's convert, convertTo or __call__ are
passed back to the transform

The object on which the translation was invoked is available as context
(default: None)

Definition at line 58 of file interfaces.py.

00058 
00059     def convert(data, idata, filename=None, **kwargs):
00060         """convert the data, store the result in idata and return that
00061 
00062         optional argument filename may give the original file name of received data
00063 
00064         additional arguments given to engine's convert, convertTo or __call__ are
00065         passed back to the transform
00066         
00067         The object on which the translation was invoked is available as context
00068         (default: None)
00069         """
00070 

Here is the caller graph for this function:

A transformation plugin -- tranform data somehow
must be threadsafe and stateless
return the name of the transform instance

Definition at line 55 of file interfaces.py.

00055 
00056     def name(self):
00057         """return the name of the transform instance"""

Here is the caller graph for this function:


The documentation for this class was generated from the following file: