Back to index

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

List of all members.

Public Member Functions

def setData
def getData
def setSubObjects
def getSubObjects
def getMetadata
def isCacheable
def setCachable

Detailed Description

data stream, is the result of a transform

Definition at line 4 of file interfaces.py.


Member Function Documentation

provide access to the transformed data object, i.e. usually a string.
This data may references subobjects.

Definition at line 10 of file interfaces.py.

00010 
00011     def getData():
00012         """provide access to the transformed data object, i.e. usually a string.
00013         This data may references subobjects.
00014         """

Here is the caller graph for this function:

return a dict-like object with any optional metadata from
the transform
You can modify the returned dictionnary to add/change metadata

Definition at line 25 of file interfaces.py.

00025 
00026     def getMetadata():
00027         """return a dict-like object with any optional metadata from
00028         the transform
00029         You can modify the returned dictionnary to add/change metadata
00030         """
        
return a dict-like object with any optional subobjects associated
with the data

Definition at line 21 of file interfaces.py.

00021 
00022     def getSubObjects():
00023         """return a dict-like object with any optional subobjects associated
00024         with the data"""

Return a bool which indicates wether the result should be cached

Default is true

Definition at line 31 of file interfaces.py.

00031 
00032     def isCacheable():
00033         """Return a bool which indicates wether the result should be cached
00034         
00035         Default is true
00036         """
        

Here is the caller graph for this function:

Set cacheable flag to yes or no

Definition at line 37 of file interfaces.py.

00037 
00038     def setCachable(value):
00039         """Set cacheable flag to yes or no
00040         """

data stream, is the result of a transform
set the main data produced by a transform, i.e. usually a string

Definition at line 7 of file interfaces.py.

00007 
00008     def setData(value):
00009         """set the main data produced by a transform, i.e. usually a string"""

set a dict-like object containing subobjects.
keys should be object's identifier (e.g. usually a filename) and
values object's content.

Definition at line 15 of file interfaces.py.

00015 
00016     def setSubObjects(objects):
00017         """set a dict-like object containing subobjects.
00018         keys should be object's identifier (e.g. usually a filename) and
00019         values object's content.
00020         """


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