Back to index

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

List of all members.

Public Member Functions

def registerTransform
def unregisterTransform
def convertTo
def convert
def __call__

Detailed Description

Definition at line 77 of file interfaces.py.


Member Function Documentation

def PortalTransforms.interfaces.iengine.__call__ (   name,
  orig,
  data = None,
  context = None,
  kwargs 
)
run a transform by its name, returning the raw data product

* name is the name of a registered transform.

return an encoded string.
see convert docstring for more info on additional arguments.

Definition at line 118 of file interfaces.py.

00118 
00119     def __call__(name, orig, data=None, context=None, **kwargs):
00120         """run a transform by its name, returning the raw data product
00121 
00122         * name is the name of a registered transform.
00123 
00124         return an encoded string.
00125         see convert docstring for more info on additional arguments.
00126         """

Here is the caller graph for this function:

def PortalTransforms.interfaces.iengine.convert (   name,
  orig,
  data = None,
  context = None,
  kwargs 
)
run a tranform of a given name on data

* name is the name of a registered transform

see convertTo docstring for more info

Definition at line 110 of file interfaces.py.

00110 
00111     def convert(name, orig, data=None, context=None, **kwargs):
00112         """run a tranform of a given name on data
00113 
00114         * name is the name of a registered transform
00115 
00116         see convertTo docstring for more info
00117         """

Here is the caller graph for this function:

def PortalTransforms.interfaces.iengine.convertTo (   mimetype,
  orig,
  data = None,
  object = None,
  context = None,
  kwargs 
)
Convert orig to a given mimetype

* orig is an encoded string

* data an optional idatastream object. If None a new datastream will be
created and returned

* optional object argument is the object on which is bound the data.
If present that object will be used by the engine to bound cached data.

* optional context argument is the object on which the transformation
  was called.

* additional arguments (kwargs) will be passed to the transformations.

return an object implementing idatastream or None if no path has been
found.

Definition at line 90 of file interfaces.py.

00090 
00091     def convertTo(mimetype, orig, data=None, object=None, context=None, **kwargs):
00092         """Convert orig to a given mimetype
00093 
00094         * orig is an encoded string
00095 
00096         * data an optional idatastream object. If None a new datastream will be
00097         created and returned
00098 
00099         * optional object argument is the object on which is bound the data.
00100         If present that object will be used by the engine to bound cached data.
00101         
00102         * optional context argument is the object on which the transformation
00103           was called.
00104 
00105         * additional arguments (kwargs) will be passed to the transformations.
00106 
00107         return an object implementing idatastream or None if no path has been
00108         found.
00109         """

Here is the caller graph for this function:

register a transform

transform must implements itransform

Definition at line 79 of file interfaces.py.

00079 
00080     def registerTransform(transform):
00081         """register a transform
00082 
00083         transform must implements itransform
00084         """

unregister a transform
name is the name of a registered transform

Definition at line 85 of file interfaces.py.

00085 
00086     def unregisterTransform(name):
00087         """ unregister a transform
00088         name is the name of a registered transform
00089         """


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