Back to index

moin  1.9.0~rc2
Public Member Functions | Public Attributes | Static Private Attributes
MoinMoin.support.xappy.datastructures.UnprocessedDocument Class Reference
Collaboration diagram for MoinMoin.support.xappy.datastructures.UnprocessedDocument:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def __repr__

Public Attributes

 id
 fields

Static Private Attributes

string __slots__ = 'id'

Detailed Description

A unprocessed document to be passed to the indexer.

This represents an item to be processed and stored in the search engine.
Each document will be processed by the indexer to generate a
ProcessedDocument, which can then be stored in the search engine index.

Note that some information in an UnprocessedDocument will not be
represented in the ProcessedDocument: therefore, it is not possible to
retrieve an UnprocessedDocument from the search engine index.

An unprocessed document is a simple container with two attributes:

 - `fields` is a list of Field objects, or an iterator returning Field
   objects.
 - `id` is a string holding a unique identifier for the document (or
   None to get the database to allocate a unique identifier automatically
   when the document is added).

Definition at line 40 of file datastructures.py.


Constructor & Destructor Documentation

def MoinMoin.support.xappy.datastructures.UnprocessedDocument.__init__ (   self,
  id = None,
  fields = None 
)

Definition at line 62 of file datastructures.py.

00062 
00063     def __init__(self, id=None, fields=None):
00064         self.id = id
00065         if fields is None:
00066             self.fields = []
00067         else:
00068             self.fields = fields


Member Function Documentation

Definition at line 69 of file datastructures.py.

00069 
00070     def __repr__(self):
00071         return 'UnprocessedDocument(%r, %r)' % (self.id, self.fields)


Member Data Documentation

Definition at line 61 of file datastructures.py.

Definition at line 65 of file datastructures.py.

Definition at line 63 of file datastructures.py.


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