`gws.plugin.alkis.action`¶

Backend for the Flurstückssuche (cadaster parlcels search) form.

Source code: gws.plugin.alkis.action

Module Contents¶

class gws.plugin.alkis.action.EigentuemerConfig(*args, **kwargs)¶

Bases: gws.ConfigWithAccess

Access to the Eigentümer (owner) information

controlMode: bool = False¶: restricted mode enabled

controlRules: list[str] | None¶: regular expression for the restricted input control

logTable: str = ''¶: data access protocol table name

class gws.plugin.alkis.action.EigentuemerOptions¶

Bases: gws.Node

Configurable GWS object.

controlMode: bool¶

controlRules: list[str]¶

logTableName: str¶

logTable: gws.lib.sa.Table | None¶

configure()¶: Configuration hook.

class gws.plugin.alkis.action.BuchungConfig(*args, **kwargs)¶

Bases: gws.ConfigWithAccess

Access to the Grundbuch (register) information

class gws.plugin.alkis.action.BuchungOptions¶

Bases: gws.Node

Configurable GWS object.

class gws.plugin.alkis.action.GemarkungListMode¶

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

none = 'none'¶: do not show the list

plain = 'plain'¶: only “gemarkung

combined = 'combined'¶: “gemarkung (gemeinde)

tree = 'tree'¶: a tree with level 1 = gemeinde and level 2 = gemarkung

class gws.plugin.alkis.action.StrasseListMode¶

Bases: gws.Enum

Enumeration type.

Despite being declared as extending Enum (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn’t provide any Enum-specific utilities.

The rationale behind this is that we need Enum members (e.g. Color.RED) to be scalars, and not complex objects as in the standard Enum.

plain = 'plain'¶: just strasse

withGemeinde = 'withGemeinde'¶: strasse (gemeinde)

withGemarkung = 'withGemarkung'¶: strasse (gemarkung)

withGemeindeIfRepeated = 'withGemeindeIfRepeated'¶: strasse (gemeinde), when needed for disambiguation

withGemarkungIfRepeated = 'withGemarkungIfRepeated'¶: strasse (gemarkung), when needed for disambiguation

class gws.plugin.alkis.action.Ui(*args, **kwargs)¶

Bases: gws.Config

Flurstückssuche UI configuration.

useExport: bool = False¶: export function enabled

useSelect: bool = False¶: select mode enabled

usePick: bool = False¶: pick mode enabled

useHistory: bool = False¶: history controls enabled

searchSelection: bool = False¶: search in selection enabled

searchSpatial: bool = False¶: spatial search enabled

gemarkungListMode: GemarkungListMode = 'combined'¶: gemarkung list mode

strasseListMode: StrasseListMode = 'plain'¶: strasse list entry format

autoSpatialSearch: bool = False¶: activate spatial search after submit

class gws.plugin.alkis.action.Config(*args, **kwargs)¶

Bases: gws.ConfigWithAccess

Flurstückssuche action

dbUid: str = ''¶: database provider ID

crs: gws.CrsName¶: CRS for the ALKIS data

dataSchema: str = 'public'¶: schema where ALKIS tables are stored

indexSchema: str = 'gws8'¶: schema to store GWS internal indexes

excludeGemarkung: list[str] | None¶: Gemarkung (Administrative Unit) IDs to exclude from search

eigentuemer: EigentuemerConfig | None¶: access to the Eigentümer (owner) information

buchung: BuchungConfig | None¶: access to the Grundbuch (register) information

limit: int = 100¶: search results limit

templates: list[gws.ext.config.template] | None¶: templates for Flurstueck details

printers: list[gws.base.printer.Config] | None¶: print configurations

ui: Ui | None¶: ui options

strasseSearchOptions: gws.TextSearchOptions | None¶

nameSearchOptions: gws.TextSearchOptions | None¶

buchungsblattSearchOptions: gws.TextSearchOptions | None¶

storage: gws.base.storage.Config | None¶: storage configuration

export: Config.export | None¶: csv export configuration

class gws.plugin.alkis.action.ExportGroupProps(*args, **kwargs)¶

Bases: gws.Props

Object properties.

index: int¶

title: str¶

class gws.plugin.alkis.action.Props(*args, **kwargs)¶

Bases: gws.base.action.Props

Object properties.

exportGroups: list[ExportGroupProps]¶

limit: int¶

printer: gws.base.printer.Props | None¶

ui: Ui¶

storage: gws.base.storage.Props | None¶

withBuchung: bool¶

withEigentuemer: bool¶

withEigentuemerControl: bool¶

withFlurnummer: bool¶

class gws.plugin.alkis.action.GetToponymsRequest(*args, **kwargs)¶

Bases: gws.Request

Command request.

class gws.plugin.alkis.action.GetToponymsResponse(*args, **kwargs)¶

Bases: gws.Response

Command response.

gemeinde: list[list[str]]¶

gemarkung: list[list[str]]¶

strasse: list[list[str]]¶

class gws.plugin.alkis.action.FindFlurstueckRequest(*args, **kwargs)¶

Bases: gws.Request

Command request.

flurnummer: str | None¶

flurstuecksfolge: str | None¶

zaehler: str | None¶

nenner: str | None¶

fsnummer: str | None¶

flaecheBis: float | None¶

flaecheVon: float | None¶

gemarkung: str | None¶

gemarkungCode: str | None¶

gemeinde: str | None¶

gemeindeCode: str | None¶

kreis: str | None¶

kreisCode: str | None¶

land: str | None¶

landCode: str | None¶

regierungsbezirk: str | None¶

regierungsbezirkCode: str | None¶

strasse: str | None¶

hausnummer: str | None¶

bblatt: str | None¶

personName: str | None¶

personVorname: str | None¶

combinedFlurstueckCode: str | None¶

shapes: list[gws.base.shape.Props] | None¶

uids: list[str] | None¶

crs: gws.CrsName | None¶

eigentuemerControlInput: str | None¶

limit: int | None¶

wantEigentuemer: bool | None¶

wantHistorySearch: bool | None¶

wantHistoryDisplay: bool | None¶

displayThemes: list[gws.plugin.alkis.data.types.DisplayTheme] | None¶

class gws.plugin.alkis.action.FindFlurstueckResponse(*args, **kwargs)¶

Bases: gws.Response

Command response.

features: list[gws.FeatureProps]¶

total: int¶

class gws.plugin.alkis.action.FindFlurstueckResult(*args, **kwargs)¶

Bases: gws.Data

Basic data object.

This object can be instantiated by passing one or or dict arguments and/or keyword args. All dicts keys and keywords become attributes of the object.

Accessing an undefined attribute returns None and no error is raised, unless the attribute name starts with an underscore.

flurstueckList: list[gws.plugin.alkis.data.types.Flurstueck]¶

total: int¶

query: gws.plugin.alkis.data.types.FlurstueckQuery¶

class gws.plugin.alkis.action.FindAdresseRequest(*args, **kwargs)¶

Bases: gws.Request

Command request.

crs: gws.Crs | None¶

gemarkung: str | None¶

gemarkungCode: str | None¶

gemeinde: str | None¶

gemeindeCode: str | None¶

kreis: str | None¶

kreisCode: str | None¶

land: str | None¶

landCode: str | None¶

regierungsbezirk: str | None¶

regierungsbezirkCode: str | None¶

strasse: str | None¶

hausnummer: str | None¶

bisHausnummer: str | None¶

hausnummerNotNull: bool | None¶

wantHistorySearch: bool | None¶

combinedAdresseCode: str | None¶

class gws.plugin.alkis.action.FindAdresseResponse(*args, **kwargs)¶

Bases: gws.Response

Command response.

features: list[gws.FeatureProps]¶

total: int¶

class gws.plugin.alkis.action.PrintFlurstueckRequest(*args, **kwargs)¶

Bases: gws.Request

Command request.

findRequest: FindFlurstueckRequest¶

printRequest: gws.PrintRequest¶

featureStyle: gws.StyleProps¶

class gws.plugin.alkis.action.ExportFlurstueckRequest(*args, **kwargs)¶

Bases: gws.Request

Command request.

findRequest: FindFlurstueckRequest¶

groupIndexes: list[int]¶

class gws.plugin.alkis.action.ExportFlurstueckResponse(*args, **kwargs)¶

Bases: gws.Response

Command response.

content: str¶

mime: str¶

class gws.plugin.alkis.action.Model¶

Bases: gws.base.model.dynamic_model.Object

Data Model.

configure()¶: Configuration hook.

class gws.plugin.alkis.action.Object¶

Bases: gws.base.action.Object

Generic action object, the parent of all action objects.

ix: gws.plugin.alkis.data.index.Object¶

ixStatus: gws.plugin.alkis.data.index.Status¶

buchung: BuchungOptions¶

eigentuemer: EigentuemerOptions¶

dataSchema: str¶

excludeGemarkung: set[str]¶

model: gws.Model¶

ui: Ui¶

limit: int¶

templates: list[gws.Template]¶

printers: list[gws.Printer]¶

export: Object.export | None¶

strasseSearchOptions: gws.TextSearchOptions¶

nameSearchOptions: gws.TextSearchOptions¶

buchungsblattSearchOptions: gws.TextSearchOptions¶

storage: gws.base.storage.Object | None¶

FLURSTUECK_QUERY_FIELDS = ['flurnummer', 'flurstuecksfolge', 'zaehler', 'nenner', 'flurstueckskennzeichen', 'flaecheBis',...¶

ADRESSE_QUERY_FIELDS = ['gemarkung', 'gemarkungCode', 'gemeinde', 'gemeindeCode', 'kreis', 'kreisCode', 'land',...¶

COMBINED_FLURSTUECK_FIELDS = ['landCode', 'gemarkungCode', 'flurnummer', 'zaehler', 'nenner', 'flurstuecksfolge']¶

COMBINED_ADRESSE_FIELDS = ['strasse', 'hausnummer', 'plz', 'gemeinde', 'bisHausnummer']¶

configure()¶: Configuration hook.

activate()¶: Activation hook.

props(user)¶

Generate a Props struct for this object.

Parameters:: user – The user for which the props should be generated.

get_toponyms(req: gws.WebRequester, p: GetToponymsRequest) → GetToponymsResponse¶: Return all Toponyms (Gemeinde/Gemarkung/Strasse) in the area