Cheshire3 Objects: Document Group (OBSELETE)

Description

DocumentGroups are now obselete, having been replaced by DocumentFactories. The documentation is maintained for posterity (and possibly for those who still use it under the "if it ain't broke, don't fix it!" idiom)

One or more Documents may be present in a DocumentGroup. This allows for users to upload a zip file of several documents and the system can process everything from there. Equally, a DocumentGroup might just be a single flat text file, an SQL database dump, or a search on a remote system.

Implementations

API

FunctionParametersReturnsDescription
__init__data The constructer takes the data which should be used to construct the documentGroup from. This is implementation dependant.
get_documentsession, indexDocumentReturn the index'th document in the group
get_lengthsessionintegerReturn the number of documents in the group