gws.plugin.alkis.data.types

Source code: gws.plugin.alkis.data.types

Module Contents

class gws.plugin.alkis.data.types.Adresse(**kwargs)

Bases: Object

gemarkung: EnumPair

gemeinde: EnumPair

hausnummer: str

kreis: EnumPair

land: EnumPair

regierungsbezirk: EnumPair

shape: gws.Shape

strasse: str

x: float

y: float

class gws.plugin.alkis.data.types.AdresseQuery(*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.

bisHausnummer: str

gemarkung: str

gemarkungCode: str

gemeinde: str

gemeindeCode: str

hausnummer: str

hausnummerNotNull: bool

kreis: str

kreisCode: str

land: str

landCode: str

options: AdresseQueryOptions | None

regierungsbezirk: str

regierungsbezirkCode: str

strasse: str

class gws.plugin.alkis.data.types.AdresseQueryOptions(*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.

limit: int

offset: int

pageSize: int

sort: list[gws.SortOptions] | None

strasseSearchOptions: gws.TextSearchOptions

withHistorySearch: bool

class gws.plugin.alkis.data.types.Anschrift(**kwargs)

Bases: Entity

recs: list[AnschriftRecord]

class gws.plugin.alkis.data.types.AnschriftRecord(**kwargs)

Bases: Record

hausnummer: str

ort: str

plz: str

strasse: str

telefon: str

class gws.plugin.alkis.data.types.Buchung(**kwargs)

Bases: Entity

buchungsblatt: Buchungsblatt

buchungsblattUid: str

recs: list[BuchungsstelleReference]

gws.plugin.alkis.data.types.BuchungAccessRequired = ['buchungsblattkennzeichenList']

class gws.plugin.alkis.data.types.Buchungsblatt(**kwargs)

Bases: Entity

buchungsblattkennzeichen: str

buchungsstelleList: list[Buchungsstelle]

namensnummerList: list[Namensnummer]

recs: list[BuchungsblattRecord]

class gws.plugin.alkis.data.types.BuchungsblattRecord(**kwargs)

Bases: Record

blattart: EnumPair

buchungsart: str

buchungsblattbezirk: EnumPair

buchungsblattkennzeichen: str

buchungsblattnummerMitBuchstabenerweiterung: str

class gws.plugin.alkis.data.types.Buchungsstelle(**kwargs)

Bases: Entity

buchungsblattkennzeichenList: list[str]

buchungsblattUids: list[str]

childUids: list[str]

flurstueckskennzeichenList: list[str]

fsUids: list[str]

laufendeNummer: str

parentkennzeichenList: list[str]

parentUids: list[str]

recs: list[BuchungsstelleRecord]

class gws.plugin.alkis.data.types.BuchungsstelleRecord(**kwargs)

Bases: Record

anteil: str

beschreibungDesSondereigentums: str

beschreibungDesUmfangsDerBuchung: str

buchungsart: EnumPair

buchungstext: str

laufendeNummer: str

class gws.plugin.alkis.data.types.BuchungsstelleReference(**kwargs)

Bases: Object

buchungsstelle: Buchungsstelle

class gws.plugin.alkis.data.types.DisplayTheme(*args, **kwds)

Bases: gws.Enum

Display themes for ALKIS data.

bewertung = 'bewertung'

Bewertung” theme, showing valuation information.

buchung = 'buchung'

Buchung” theme, showing booking information.

eigentuemer = 'eigentuemer'

Eigentümer” theme, showing owner information.

festlegung = 'festlegung'

Festlegung” theme, showing legal and other determinations.

gebaeude = 'gebaeude'

Gebäude” theme, showing building information.

lage = 'lage'

Lage” theme, showing the location of the property.

nutzung = 'nutzung'

Nutzung” theme, showing land use information.

gws.plugin.alkis.data.types.EigentuemerAccessRequired = ['personName', 'personVorname']

class gws.plugin.alkis.data.types.Entity(**kwargs)

Bases: Object

recs: list[Record]

class gws.plugin.alkis.data.types.EnumPair(code, text)

code

text

class gws.plugin.alkis.data.types.Flurstueck(**kwargs)

Bases: Entity

bewertungList: list[Part]

buchungList: list[Buchung]

festlegungList: list[Part]

flurstueckskennzeichen: str

fsnummer: str

gebaeudeAmtlicheFlaeche: float

gebaeudeGeomFlaeche: float

gebaeudeList: list[Gebaeude]

geom: Any

lageList: list[Lage]

nutzungList: list[Part]

recs: list[FlurstueckRecord]

shape: gws.Shape

x: float

y: float

class gws.plugin.alkis.data.types.FlurstueckQuery(*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.

buchungsblattkennzeichenList: list[str]

flaecheBis: float

flaecheVon: float

flurnummer: str

flurstuecksfolge: str

flurstueckskennzeichen: str

gemarkung: str

gemarkungCode: str

gemeinde: str

gemeindeCode: str

hausnummer: str

kreis: str

kreisCode: str

land: str

landCode: str

nenner: str

options: FlurstueckQueryOptions | None

personName: str

personVorname: str

regierungsbezirk: str

regierungsbezirkCode: str

shape: gws.Shape

strasse: str

uids: list[str]

zaehler: str

class gws.plugin.alkis.data.types.FlurstueckQueryOptions(*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.

buchungsblattSearchOptions: gws.TextSearchOptions

displayThemes: list[DisplayTheme]

limit: int

nameSearchOptions: gws.TextSearchOptions

offset: int

pageSize: int

sort: list[gws.SortOptions] | None

strasseSearchOptions: gws.TextSearchOptions

withBuchung: bool

withEigentuemer: bool

withHistoryDisplay: bool

withHistorySearch: bool

class gws.plugin.alkis.data.types.FlurstueckRecord(**kwargs)

Bases: Record

abweichenderRechtszustand: bool

amtlicheFlaeche: float

flurnummer: str

flurstuecksfolge: str

flurstueckskennzeichen: str

gemarkung: EnumPair

gemeinde: EnumPair

geom: str

geomFlaeche: float

kreis: EnumPair

land: EnumPair

nachfolgerFlurstueckskennzeichen: list[str]

nenner: str

rechtsbehelfsverfahren: bool

regierungsbezirk: EnumPair

vorgaengerFlurstueckskennzeichen: list[str]

x: float

y: float

zaehler: str

zeitpunktDerEntstehung: str

zustaendigeStelle: list[EnumPair]

zweifelhafterFlurstuecksnachweis: bool

class gws.plugin.alkis.data.types.Gebaeude(**kwargs)

Bases: Entity

recs: list[GebaeudeRecord]

class gws.plugin.alkis.data.types.GebaeudeProps(**kwargs)

Bases: Object

anzahlDerOberirdischenGeschosse: int

anzahlDerUnterirdischenGeschosse: int

art: EnumPair

bauart: EnumPair

baujahr: list[int]

bauweise: EnumPair

beschaffenheit: list[EnumPair]

dachart: str

dachform: EnumPair

dachgeschossausbau: EnumPair

durchfahrtshoehe: int

gebaeudefunktion: EnumPair

gebaeudekennzeichen: str

geschossflaeche: float

grundflaeche: float

hochhaus: bool

lageZurErdoberflaeche: EnumPair

name: list[str]

objekthoehe: int

punktkennung: str

sonstigeEigenschaft: list[str]

umbauterRaum: float

weitereGebaeudefunktion: list[EnumPair]

zustand: EnumPair

class gws.plugin.alkis.data.types.GebaeudeRecord(**kwargs)

Bases: Record

amtlicheFlaeche: float

gebaeudekennzeichen: int

geom: str

geomFlaeche: float

props: GebaeudeProps

class gws.plugin.alkis.data.types.IndexStatus(*args, **kwargs)

Bases: gws.Data

Index status

basic: bool

buchung: bool

complete: bool

eigentuemer: bool

missing: bool

class gws.plugin.alkis.data.types.Lage(**kwargs)

Bases: Entity

gebaeudeList: list[Gebaeude]

recs: list[LageRecord]

x: float

y: float

class gws.plugin.alkis.data.types.LageRecord(**kwargs)

Bases: Record

hausnummer: str

laufendeNummer: str

ortsteil: str

pseudonummer: str

strasse: str

class gws.plugin.alkis.data.types.Namensnummer(**kwargs)

Bases: Entity

buchungsblattkennzeichenList: list[str]

buchungsblattUids: list[str]

laufendeNummer: str

personList: list[Person]

recs: list[NamensnummerRecord]

class gws.plugin.alkis.data.types.NamensnummerRecord(**kwargs)

Bases: Record

anteil: str

artDerRechtsgemeinschaft: EnumPair

beschriebDerRechtsgemeinschaft: str

eigentuemerart: EnumPair

laufendeNummerNachDIN1421: str

nummer: str

strichblattnummer: int

class gws.plugin.alkis.data.types.Object(**kwargs)

isHistoric: bool

uid: str

class gws.plugin.alkis.data.types.Part(**kwargs)

Bases: Entity

amtlicheFlaeche: float

fs: str

geom: str

geomFlaeche: float

KIND

kind: int

name: EnumPair

recs: list[PartRecord]

gws.plugin.alkis.data.types.PART_BEWERTUNG = 2

gws.plugin.alkis.data.types.PART_FESTLEGUNG = 3

gws.plugin.alkis.data.types.PART_NUTZUNG = 1

class gws.plugin.alkis.data.types.PartProps(**kwargs)

Bases: Object

abbaugut: EnumPair

ackerzahlOderGruenlandzahl: str

anzahlDerFahrstreifen: int

anzahlDerStreckengleise: EnumPair

art: EnumPair

artDerBebauung: EnumPair

artDerFestlegung: EnumPair

bahnkategorie: list[EnumPair]

bedeutung: list[EnumPair]

befestigung: EnumPair

besondereFahrstreifen: EnumPair

besondereFunktion: EnumPair

bodenart: EnumPair

bodenzahlOderGruenlandgrundzahl: str

breiteDerFahrbahn: int

breiteDesGewaessers: int

breiteDesVerkehrsweges: int

datumAbgabe: str

datumAnordnung: str

datumBesitzeinweisung: str

datumrechtskraeftig: str

elektrifizierung: EnumPair

entstehungsartOderKlimastufeWasserverhaeltnisse: list[EnumPair]

fahrbahntrennung: EnumPair

fliessrichtung: bool

foerdergut: EnumPair

funktion: EnumPair

gewaesserkennzahl: str

gewaesserkennziffer: str

hydrologischesMerkmal: EnumPair

identnummer: str

internationaleBedeutung: EnumPair

jahreszahl: int

klassifizierung: EnumPair

kulturart: EnumPair

lagergut: EnumPair

markierung: EnumPair

merkmal: EnumPair

nummer: str

nummerDerSchutzzone: str

nummerDesSchutzgebietes: str

oberflaechenmaterial: EnumPair

primaerenergie: EnumPair

rechtszustand: EnumPair

schifffahrtskategorie: EnumPair

sonstigeAngaben: list[EnumPair]

spurweite: EnumPair

tagesabschnittsnummer: str

tidemerkmal: EnumPair

vegetationsmerkmal: EnumPair

veraenderungOhneRuecksprache: bool

verkehrsbedeutungInneroertlich: EnumPair

verkehrsbedeutungUeberoertlich: EnumPair

widmung: EnumPair

zone: EnumPair

zustand: EnumPair

zustandsstufeOderBodenstufe: EnumPair

class gws.plugin.alkis.data.types.PartRecord(**kwargs)

Bases: Record

amtlicheFlaeche: float

geom: str

geomFlaeche: float

props: PartProps

class gws.plugin.alkis.data.types.Person(**kwargs)

Bases: Entity

anschriftList: list[Anschrift]

recs: list[PersonRecord]

class gws.plugin.alkis.data.types.PersonRecord(**kwargs)

Bases: Record

akademischerGrad: str

anrede: str

geburtsdatum: str

geburtsname: str

nachnameOderFirma: str

vorname: str

class gws.plugin.alkis.data.types.Place(**kwargs)

Bases: Record

buchungsblattbezirk: EnumPair

dienststelle: EnumPair

gemarkung: EnumPair

gemeinde: EnumPair

kind: str

kreis: EnumPair

land: EnumPair

regierungsbezirk: EnumPair

class gws.plugin.alkis.data.types.PlaceKind(*args, **kwds)

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.

buchungsblattbezirk = 'buchungsblattbezirk'

dienststelle = 'dienststelle'

gemarkung = 'gemarkung'

gemeinde = 'gemeinde'

kreis = 'kreis'

land = 'land'

regierungsbezirk = 'regierungsbezirk'

gws.plugin.alkis.data.types.PROPS

class gws.plugin.alkis.data.types.Reader

count(cls: type, table_name: str | None = None) → int

read_all(cls: type, table_name: str | None = None, uids: list[str] | None = None)

class gws.plugin.alkis.data.types.Record(**kwargs)

Bases: Object

anlass: str

beginnt: str

endet: str

class gws.plugin.alkis.data.types.Strasse(*args, **kwargs)

Bases: gws.Data

Strasse (street) Record

gemarkung: EnumPair

Gemarkung (district) of the street.

gemeinde: EnumPair

Gemeinde (municipality) of the street.

name: str

Name of the street.