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.BuchungConfig(*args, **kwargs)

Bases: gws.ConfigWithAccess

Access to the Grundbuch (register) information

class gws.plugin.alkis.action.BuchungOptions

Bases: gws.Node

GWS object tree node.

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

Bases: gws.ConfigWithAccess

Flurstückssuche action configuration.

buchung: BuchungConfig | None

Access to the Grundbuch (register) information.

buchungsblattSearchOptions: gws.TextSearchOptions | None

Search options for book and page numbers.

crs: gws.CrsName

CRS for the ALKIS data.

dataSchema: str = 'public'

Schema where ALKIS tables are stored.

dbUid: str = ''

Database provider ID.

eigentuemer: EigentuemerConfig | None

Access to the Eigentümer (owner) information.

excludeGemarkung: list[str] | None

Gemarkung (Administrative Unit) IDs to exclude from indexing.

export: gws.plugin.alkis.data.exporter.Config | None

Export configuration.

gemarkungFilter: list[str] | None

Restrict search to Gemarkung (Administrative Unit) IDs.

indexSchema: str = 'gws8'

Schema to store GWS internal indexes.

limit: int = 100

Search results limit.

nameSearchOptions: gws.TextSearchOptions | None

Search options for person names.

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

Print configurations.

storage: gws.base.storage.Config | None

Storage configuration.

strasseSearchOptions: gws.TextSearchOptions | None

Search options for street names.

templates: list[gws.ext.config.template] | None

Templates for Flurstueck details.

ui: Ui | None

Ui options.

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

GWS object tree node.

controlMode: bool

controlRules: list[str]

logTable: gws.lib.sa.Table | None

logTableName: str

configure()

Configuration hook.

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.ExportGroupProps(*args, **kwargs)

Bases: gws.Props

Object properties.

index: int

title: str

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

Bases: gws.Request

Command request.

bisHausnummer: str | None

combinedAdresseCode: str | None

crs: gws.CrsName | None

gemarkung: str | None

gemarkungCode: str | None

gemeinde: str | None

gemeindeCode: str | None

hausnummer: str | None

hausnummerNotNull: bool | None

kreis: str | None

kreisCode: str | None

land: str | None

landCode: str | None

regierungsbezirk: str | None

regierungsbezirkCode: str | None

strasse: str | None

wantHistorySearch: bool | 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.FindFlurstueckRequest(*args, **kwargs)

Bases: gws.Request

Command request.

bblatt: str | None

combinedFlurstueckCode: str | None

crs: gws.CrsName | None

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

eigentuemerControlInput: str | None

flaecheBis: float | None

flaecheVon: float | None

flurnummer: str | None

flurstuecksfolge: str | None

fsnummer: str | None

gemarkung: str | None

gemarkungCode: str | None

gemeinde: str | None

gemeindeCode: str | None

hausnummer: str | None

kreis: str | None

kreisCode: str | None

land: str | None

landCode: str | None

limit: int | None

nenner: str | None

personName: str | None

personVorname: str | None

regierungsbezirk: str | None

regierungsbezirkCode: str | None

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

strasse: str | None

uids: list[str] | None

wantEigentuemer: bool | None

wantHistoryDisplay: bool | None

wantHistorySearch: bool | None

zaehler: str | 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]

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

total: int

class gws.plugin.alkis.action.GemarkungListMode(*args, **kwds)

Bases: gws.Enum

Gemarkung (Administrative Unit) list mode.

combined = 'combined'

Show gemarkung(gemeinde).

none = 'none'

Do not show the list.

plain = 'plain'

Show only gemarkung.

tree = 'tree'

A tree with level 1 = gemeinde and level 2 = gemarkung.

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.

gemarkung: list[list[str]]

gemeinde: list[list[str]]

strasse: list[list[str]]

class gws.plugin.alkis.action.Model

Bases: gws.base.model.default_model.Object

configure()

class gws.plugin.alkis.action.Object

Bases: gws.base.action.Object

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

buchung: BuchungOptions

buchungsblattSearchOptions: gws.TextSearchOptions

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

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

dataSchema: str

db: gws.DatabaseProvider

eigentuemer: EigentuemerOptions

exp: gws.plugin.alkis.data.exporter.Object | None

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

indexSchema: str

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

ixStatus: gws.plugin.alkis.data.types.IndexStatus

limit: int

model: gws.Model

nameSearchOptions: gws.TextSearchOptions

printers: list[gws.Printer]

storage: gws.base.storage.Object | None

strasseSearchOptions: gws.TextSearchOptions

templates: list[gws.Template]

ui: Ui

activate()

configure()

export_flurstueck(req: gws.WebRequester, p: ExportFlurstueckRequest) → ExportFlurstueckResponse

find_adresse(req: gws.WebRequester, p: FindAdresseRequest) → FindAdresseResponse

Perform an Adresse search.

find_adresse_objects(req: gws.WebRequester, p: FindAdresseRequest) → tuple[list[gws.plugin.alkis.data.types.Adresse], gws.plugin.alkis.data.types.AdresseQuery]

find_flurstueck(req: gws.WebRequester, p: FindFlurstueckRequest) → FindFlurstueckResponse

Perform a Flurstueck search

find_flurstueck_objects(req: gws.WebRequester, p: FindFlurstueckRequest) → tuple[list[gws.plugin.alkis.data.types.Flurstueck], gws.plugin.alkis.data.types.FlurstueckQuery]

get_toponyms(req: gws.WebRequester, p: GetToponymsRequest) → GetToponymsResponse

Return all Toponyms (Gemeinde/Gemarkung/Strasse) in the area

handle_storage(req: gws.WebRequester, p: gws.base.storage.Request) → gws.base.storage.Response

print_flurstueck(req: gws.WebRequester, p: PrintFlurstueckRequest) → gws.JobStatusResponse

Print Flurstueck features

props(user)

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

Bases: gws.Request

Command request.

featureStyle: gws.StyleProps

findRequest: FindFlurstueckRequest

printRequest: gws.PrintRequest

class gws.plugin.alkis.action.Props

Bases: gws.base.action.Props

buchungsblattSearchOptions: gws.TextSearchOptions | None

exportGroups: list[ExportGroupProps]

limit: int

nameSearchOptions: gws.TextSearchOptions | None

printer: gws.base.printer.Props | None

storage: gws.base.storage.Props | None

strasseSearchOptions: gws.TextSearchOptions | None

ui: Ui

withBuchung: bool

withEigentuemer: bool

withEigentuemerControl: bool

withFlurnummer: bool

class gws.plugin.alkis.action.StrasseListMode(*args, **kwds)

Bases: gws.Enum

Strasse (street) list entry format.

plain = 'plain'

Just strasse.

withGemarkung = 'withGemarkung'

Strasse (gemarkung).

withGemarkungIfRepeated = 'withGemarkungIfRepeated'

Strasse (gemarkung), when needed for disambiguation.

withGemeinde = 'withGemeinde'

Strasse (gemeinde).

withGemeindeIfRepeated = 'withGemeindeIfRepeated'

Strasse (gemeinde), when needed for disambiguation.

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

Bases: gws.Config

Flurstückssuche UI configuration.

autoSpatialSearch: bool = False

Activate spatial search after submit.

gemarkungListMode: GemarkungListMode

Gemarkung list mode.

searchSelection: bool = False

Search in selection enabled.

searchSpatial: bool = False

Spatial search enabled.

strasseListMode: StrasseListMode

Strasse list entry format.

useExport: bool = False

Export function enabled.

useHistory: bool = False

History controls enabled.

usePick: bool = False

Pick mode enabled.

useSelect: bool = False

Select mode enabled.