Class: BagKadasterClient::Woonplaats

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

Overview

Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig aangewezen en van een naam voorzien gedeelte van het grondgebied van de gemeente.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Woonplaats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 81

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `BagKadasterClient::Woonplaats` 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::Woonplaats`. 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?(:'naam')
    self.naam = attributes[:'naam']
  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
end

Instance Attribute Details

#documentdatum ⇒ Object

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.



33
34
35
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 33

def documentdatum
  @documentdatum
end

#documentnummer ⇒ Object

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.



36
37
38
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 36

def documentnummer
  @documentnummer
end

#domein ⇒ Object

NL.IMBAG.Woonplaats



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

def domein
  @domein
end

#geconstateerd ⇒ Object

Returns the value of attribute geconstateerd.



30
31
32
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 30

def geconstateerd
  @geconstateerd
end

#identificatie ⇒ Object

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$.



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

def identificatie
  @identificatie
end

#naam ⇒ Object

De benaming van een door het gemeentebestuur aangewezen woonplaats.



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

def naam
  @naam
end

#status ⇒ Object

Returns the value of attribute status.



28
29
30
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 28

def status
  @status
end

#voorkomen ⇒ Object

Returns the value of attribute voorkomen.



38
39
40
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 38

def voorkomen
  @voorkomen
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 41

def self.attribute_map
  {
    :'identificatie' => :'identificatie',
    :'domein' => :'domein',
    :'naam' => :'naam',
    :'status' => :'status',
    :'geconstateerd' => :'geconstateerd',
    :'documentdatum' => :'documentdatum',
    :'documentnummer' => :'documentnummer',
    :'voorkomen' => :'voorkomen'
  }
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



346
347
348
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 346

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 60

def self.openapi_types
  {
    :'identificatie' => :'String',
    :'domein' => :'String',
    :'naam' => :'String',
    :'status' => :'StatusWoonplaats',
    :'geconstateerd' => :'Indicatie',
    :'documentdatum' => :'Date',
    :'documentnummer' => :'String',
    :'voorkomen' => :'Voorkomen'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 318

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      identificatie == o.identificatie &&
      domein == o.domein &&
      naam == o.naam &&
      status == o.status &&
      geconstateerd == o.geconstateerd &&
      documentdatum == o.documentdatum &&
      documentnummer == o.documentnummer &&
      voorkomen == o.voorkomen
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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 376

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 447

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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 353

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


333
334
335
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 333

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



339
340
341
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 339

def hash
  [identificatie, domein, naam, status, geconstateerd, documentdatum, documentnummer, voorkomen].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
179
180
181
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
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 129

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 > 4
    invalid_properties.push('invalid value for "identificatie", the character length must be smaller than or equal to 4.')
  end

  if @identificatie.to_s.length < 4
    invalid_properties.push('invalid value for "identificatie", 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 @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 @naam.nil?
    invalid_properties.push('invalid value for "naam", naam cannot be nil.')
  end

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

  if @naam.to_s.length < 1
    invalid_properties.push('invalid value for "naam", 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 @naam !~ pattern
    invalid_properties.push("invalid value for \"naam\", must conform to the pattern #{pattern}.")
  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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 423

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 429

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



417
418
419
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 417

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/bag_kadaster_client/models/woonplaats.rb', line 211

def valid?
  return false if @identificatie.nil?
  return false if @identificatie.to_s.length > 4
  return false if @identificatie.to_s.length < 4
  return false if @identificatie !~ 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 @domein.nil?
  return false if @domein.to_s.length < 1
  return false if @naam.nil?
  return false if @naam.to_s.length > 80
  return false if @naam.to_s.length < 1
  return false if @naam !~ 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 @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?
  true
end