Class: BagKadasterClient::Nummeraanduiding

Inherits:
Object
  • Object
show all
Defined in:
lib/bag_kadaster_client/models/nummeraanduiding.rb

Overview

Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als zodanig toegekende aanduiding van een verblijfsobject, een standplaats of een ligplaats.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Nummeraanduiding

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 110

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `BagKadasterClient::Nummeraanduiding` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `BagKadasterClient::Nummeraanduiding`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'identificatie')
    self.identificatie = attributes[:'identificatie']
  end

  if attributes.key?(:'domein')
    self.domein = attributes[:'domein']
  end

  if attributes.key?(:'huisnummer')
    self.huisnummer = attributes[:'huisnummer']
  end

  if attributes.key?(:'huisletter')
    self.huisletter = attributes[:'huisletter']
  end

  if attributes.key?(:'huisnummertoevoeging')
    self.huisnummertoevoeging = attributes[:'huisnummertoevoeging']
  end

  if attributes.key?(:'postcode')
    self.postcode = attributes[:'postcode']
  end

  if attributes.key?(:'type_adresseerbaar_object')
    self.type_adresseerbaar_object = attributes[:'type_adresseerbaar_object']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'geconstateerd')
    self.geconstateerd = attributes[:'geconstateerd']
  end

  if attributes.key?(:'documentdatum')
    self.documentdatum = attributes[:'documentdatum']
  end

  if attributes.key?(:'documentnummer')
    self.documentnummer = attributes[:'documentnummer']
  end

  if attributes.key?(:'voorkomen')
    self.voorkomen = attributes[:'voorkomen']
  end

  if attributes.key?(:'ligt_in')
    self.ligt_in = attributes[:'ligt_in']
  end

  if attributes.key?(:'ligt_aan')
    self.ligt_aan = attributes[:'ligt_aan']
  end
end

Instance Attribute Details

#documentdatumObject

De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.



44
45
46
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 44

def documentdatum
  @documentdatum
end

#documentnummerObject

De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.



47
48
49
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 47

def documentnummer
  @documentnummer
end

#domeinObject

NL.IMBAG.Nummeraanduiding



23
24
25
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 23

def domein
  @domein
end

#geconstateerdObject

Returns the value of attribute geconstateerd.



41
42
43
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 41

def geconstateerd
  @geconstateerd
end

#huisletterObject

Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.



29
30
31
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 29

def huisletter
  @huisletter
end

#huisnummerObject

Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.



26
27
28
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 26

def huisnummer
  @huisnummer
end

#huisnummertoevoegingObject

Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.



32
33
34
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 32

def huisnummertoevoeging
  @huisnummertoevoeging
end

#identificatieObject

Deze wordt gebruikt in de operation.



20
21
22
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 20

def identificatie
  @identificatie
end

#ligt_aanObject

Deze wordt gebruikt in de operation.



55
56
57
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 55

def ligt_aan
  @ligt_aan
end

#ligt_inObject

De identificatie wordt gebruikt in de operation, bv. /woonplaatsen/3560. Waarde: 0001-9999, formaat: ^[0-9]3\|[0-9]2[0-9]\|[1-9]2\|[1-9]3$.



52
53
54
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 52

def ligt_in
  @ligt_in
end

#postcodeObject

De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.



35
36
37
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 35

def postcode
  @postcode
end

#statusObject

Returns the value of attribute status.



39
40
41
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 39

def status
  @status
end

#type_adresseerbaar_objectObject

Returns the value of attribute type_adresseerbaar_object.



37
38
39
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 37

def type_adresseerbaar_object
  @type_adresseerbaar_object
end

#voorkomenObject

Returns the value of attribute voorkomen.



49
50
51
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 49

def voorkomen
  @voorkomen
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



78
79
80
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 58

def self.attribute_map
  {
    :'identificatie' => :'identificatie',
    :'domein' => :'domein',
    :'huisnummer' => :'huisnummer',
    :'huisletter' => :'huisletter',
    :'huisnummertoevoeging' => :'huisnummertoevoeging',
    :'postcode' => :'postcode',
    :'type_adresseerbaar_object' => :'typeAdresseerbaarObject',
    :'status' => :'status',
    :'geconstateerd' => :'geconstateerd',
    :'documentdatum' => :'documentdatum',
    :'documentnummer' => :'documentnummer',
    :'voorkomen' => :'voorkomen',
    :'ligt_in' => :'ligtIn',
    :'ligt_aan' => :'ligtAan'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



529
530
531
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 529

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



103
104
105
106
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 103

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 83

def self.openapi_types
  {
    :'identificatie' => :'String',
    :'domein' => :'String',
    :'huisnummer' => :'Integer',
    :'huisletter' => :'String',
    :'huisnummertoevoeging' => :'String',
    :'postcode' => :'String',
    :'type_adresseerbaar_object' => :'TypeAdresseerbaarObject',
    :'status' => :'StatusNaamgeving',
    :'geconstateerd' => :'Indicatie',
    :'documentdatum' => :'Date',
    :'documentnummer' => :'String',
    :'voorkomen' => :'Voorkomen',
    :'ligt_in' => :'String',
    :'ligt_aan' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 495

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      identificatie == o.identificatie &&
      domein == o.domein &&
      huisnummer == o.huisnummer &&
      huisletter == o.huisletter &&
      huisnummertoevoeging == o.huisnummertoevoeging &&
      postcode == o.postcode &&
      type_adresseerbaar_object == o.type_adresseerbaar_object &&
      status == o.status &&
      geconstateerd == o.geconstateerd &&
      documentdatum == o.documentdatum &&
      documentnummer == o.documentnummer &&
      voorkomen == o.voorkomen &&
      ligt_in == o.ligt_in &&
      ligt_aan == o.ligt_aan
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 559

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = BagKadasterClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 630

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 536

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


516
517
518
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 516

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



522
523
524
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 522

def hash
  [identificatie, domein, huisnummer, huisletter, huisnummertoevoeging, postcode, type_adresseerbaar_object, status, geconstateerd, documentdatum, documentnummer, voorkomen, ligt_in, ligt_aan].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 182

def list_invalid_properties
  invalid_properties = Array.new
  if @identificatie.nil?
    invalid_properties.push('invalid value for "identificatie", identificatie cannot be nil.')
  end

  if @identificatie.to_s.length > 16
    invalid_properties.push('invalid value for "identificatie", the character length must be smaller than or equal to 16.')
  end

  if @identificatie.to_s.length < 16
    invalid_properties.push('invalid value for "identificatie", the character length must be great than or equal to 16.')
  end

  pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
  if @identificatie !~ pattern
    invalid_properties.push("invalid value for \"identificatie\", must conform to the pattern #{pattern}.")
  end

  if @domein.nil?
    invalid_properties.push('invalid value for "domein", domein cannot be nil.')
  end

  if @domein.to_s.length < 1
    invalid_properties.push('invalid value for "domein", the character length must be great than or equal to 1.')
  end

  if @huisnummer.nil?
    invalid_properties.push('invalid value for "huisnummer", huisnummer cannot be nil.')
  end

  if @huisnummer > 99999
    invalid_properties.push('invalid value for "huisnummer", must be smaller than or equal to 99999.')
  end

  if @huisnummer < 1
    invalid_properties.push('invalid value for "huisnummer", must be greater than or equal to 1.')
  end

  pattern = Regexp.new(/^[a-zA-Z]{1}$/)
  if !@huisletter.nil? && @huisletter !~ pattern
    invalid_properties.push("invalid value for \"huisletter\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[0-9a-zA-Z]{1,4}$/)
  if !@huisnummertoevoeging.nil? && @huisnummertoevoeging !~ pattern
    invalid_properties.push("invalid value for \"huisnummertoevoeging\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[1-9]{1}[0-9]{3}[A-Z]{2}$/)
  if !@postcode.nil? && @postcode !~ pattern
    invalid_properties.push("invalid value for \"postcode\", must conform to the pattern #{pattern}.")
  end

  if @type_adresseerbaar_object.nil?
    invalid_properties.push('invalid value for "type_adresseerbaar_object", type_adresseerbaar_object cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @geconstateerd.nil?
    invalid_properties.push('invalid value for "geconstateerd", geconstateerd cannot be nil.')
  end

  if @documentdatum.nil?
    invalid_properties.push('invalid value for "documentdatum", documentdatum cannot be nil.')
  end

  if @documentnummer.nil?
    invalid_properties.push('invalid value for "documentnummer", documentnummer cannot be nil.')
  end

  if @documentnummer.to_s.length > 40
    invalid_properties.push('invalid value for "documentnummer", the character length must be smaller than or equal to 40.')
  end

  if @documentnummer.to_s.length < 1
    invalid_properties.push('invalid value for "documentnummer", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[\u0020-\u007E;\u00A0-\u00FF;\u0100-\u0113;\u0116-\u012B;\u012E-\u014D;\u0150-\u017E;\u02C7;\u02D8-\u02DB;\u02DD;\u2015;\u2018-\u2019;\u201C-\u201D;\u20AC;\u2122;\u2126;\u215B-\u215E;\u2190-\u2193;\u266A;]*/)
  if @documentnummer !~ pattern
    invalid_properties.push("invalid value for \"documentnummer\", must conform to the pattern #{pattern}.")
  end

  if @voorkomen.nil?
    invalid_properties.push('invalid value for "voorkomen", voorkomen cannot be nil.')
  end

  if !@ligt_in.nil? && @ligt_in.to_s.length > 4
    invalid_properties.push('invalid value for "ligt_in", the character length must be smaller than or equal to 4.')
  end

  if !@ligt_in.nil? && @ligt_in.to_s.length < 4
    invalid_properties.push('invalid value for "ligt_in", the character length must be great than or equal to 4.')
  end

  pattern = Regexp.new(/^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$/)
  if !@ligt_in.nil? && @ligt_in !~ pattern
    invalid_properties.push("invalid value for \"ligt_in\", must conform to the pattern #{pattern}.")
  end

  if @ligt_aan.nil?
    invalid_properties.push('invalid value for "ligt_aan", ligt_aan cannot be nil.')
  end

  if @ligt_aan.to_s.length > 16
    invalid_properties.push('invalid value for "ligt_aan", the character length must be smaller than or equal to 16.')
  end

  if @ligt_aan.to_s.length < 16
    invalid_properties.push('invalid value for "ligt_aan", the character length must be great than or equal to 16.')
  end

  pattern = Regexp.new(/^[0-9]{4}30[0-9]{10}$/)
  if @ligt_aan !~ pattern
    invalid_properties.push("invalid value for \"ligt_aan\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



606
607
608
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 606

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 612

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



600
601
602
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 600

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/bag_kadaster_client/models/nummeraanduiding.rb', line 308

def valid?
  return false if @identificatie.nil?
  return false if @identificatie.to_s.length > 16
  return false if @identificatie.to_s.length < 16
  return false if @identificatie !~ Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
  return false if @domein.nil?
  return false if @domein.to_s.length < 1
  return false if @huisnummer.nil?
  return false if @huisnummer > 99999
  return false if @huisnummer < 1
  return false if !@huisletter.nil? && @huisletter !~ Regexp.new(/^[a-zA-Z]{1}$/)
  return false if !@huisnummertoevoeging.nil? && @huisnummertoevoeging !~ Regexp.new(/^[0-9a-zA-Z]{1,4}$/)
  return false if !@postcode.nil? && @postcode !~ Regexp.new(/^[1-9]{1}[0-9]{3}[A-Z]{2}$/)
  return false if @type_adresseerbaar_object.nil?
  return false if @status.nil?
  return false if @geconstateerd.nil?
  return false if @documentdatum.nil?
  return false if @documentnummer.nil?
  return false if @documentnummer.to_s.length > 40
  return false if @documentnummer.to_s.length < 1
  return false if @documentnummer !~ Regexp.new(/^[\u0020-\u007E;\u00A0-\u00FF;\u0100-\u0113;\u0116-\u012B;\u012E-\u014D;\u0150-\u017E;\u02C7;\u02D8-\u02DB;\u02DD;\u2015;\u2018-\u2019;\u201C-\u201D;\u20AC;\u2122;\u2126;\u215B-\u215E;\u2190-\u2193;\u266A;]*/)
  return false if @voorkomen.nil?
  return false if !@ligt_in.nil? && @ligt_in.to_s.length > 4
  return false if !@ligt_in.nil? && @ligt_in.to_s.length < 4
  return false if !@ligt_in.nil? && @ligt_in !~ Regexp.new(/^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$/)
  return false if @ligt_aan.nil?
  return false if @ligt_aan.to_s.length > 16
  return false if @ligt_aan.to_s.length < 16
  return false if @ligt_aan !~ Regexp.new(/^[0-9]{4}30[0-9]{10}$/)
  true
end