xappy.indexerconnection.SynonymIter

Package xappy :: Module indexerconnection :: Class SynonymIter |
[frames] | no frames]

# Class SynonymIter

source code

    object --+
             |
            SynonymIter

Iterate through a list of synonyms.

Instance Methods
__init__(self, index, field_mappings, prefix) Initialise the synonym iterator. | source code
__iter__(self) | source code
next(self) Get the next synonym. | source code
Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Properties
Inherited from `object`: `__class__`

Method Details

### __init__(self, index, field_mappings, prefix) (Constructor) | source code
Initialise the synonym iterator. `index` is the index to get the synonyms from. `field_mappings` is the FieldMappings object for the iterator. `prefix` is the prefix to restrict the returned synonyms to. Overrides: object.__init__