lib.readers.municipality

Module Contents

Classes

MunicipalityReader(self,dotted_source_class_path,**params) The central reader for municipalities. It is directly bound to a so called source
class MunicipalityReader(dotted_source_class_path, **params)

The central reader for municipalities. It is directly bound to a so called source which is defined by a pythonic dotted string to the class definition of this source. An instance of the passed source will be created on instantiation of this reader class by passing through the parameter kwargs.

__init__(dotted_source_class_path, **params)

Args: dotted_source_class_path

(str or pyramid_oereb.lib.sources.municipality.MunicipalityBaseSource): The path to the class which represents the source used by this reader. This class must implement basic source behaviour of the api-pyramid_oereb-lib-sources-municipality-municipalitybasesource.
(kwargs): kwargs, which are necessary as configuration parameter for the above by
dotted name defined class.
read()

The central read accessor method to get all desired records from configured source.

Note

If you subclass this class your implementation needs to offer this method in the same signature. Means the parameters must be the same and the return must be a list of api-pyramid_oereb-lib-records-municipality-municipalityrecord. Otherwise the API like way the server works would be broken.

Returns:
list of pyramid_oereb.lib.records.municipality.MunicipalityRecord: The list of all found records. Since these are not filtered by any criteria the list simply contains all records delivered by the source.