xappy.datastructures.UnprocessedDocument

Package xappy :: Module datastructures :: Class UnprocessedDocument |
[frames] | no frames]

# Class UnprocessedDocument

source code

    object --+
             |
            UnprocessedDocument

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).

Instance Methods
__init__(self, id=None, fields=None) x.__init__(...) initializes x; see x.__class__.__doc__ for signature | source code
__repr__(self) repr(x) | source code
Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__str__`

Properties
| fields
| id
Inherited from `object`: `__class__`

Method Details

### __init__(self, id=None, fields=None) (Constructor) | source code
x.__init__(...) initializes x; see x.__class__.__doc__ for signature Overrides: object.__init__ (inherited documentation)

### __repr__(self) (Representation operator) | source code
repr(x) Overrides: object.__repr__ (inherited documentation)