Class: PostcodeAnywhere::CleansePlus::CleansedAddress

Inherits:
ModelBase
  • Object
show all
Defined in:
lib/postcode_anywhere/cleanse_plus/cleansed_address.rb

Instance Attribute Summary collapse

Attributes inherited from ModelBase

#attrs

Method Summary

Methods inherited from ModelBase

attr_reader, define_attribute_method, define_predicate_method, #initialize, object_attr_reader, predicate_attr_reader

Constructor Details

This class inherits a constructor from PostcodeAnywhere::ModelBase

Instance Attribute Details

#barcode ⇒ Object (readonly)

The barcode for the address. Example: (WR26NJ3UT)



54
55
56
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 54

def barcode
  @barcode
end

#building_name ⇒ Object (readonly)

The building name if present. Elgar Business Centre



75
76
77
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 75

def building_name
  @building_name
end

#building_number ⇒ Object (readonly)

The number (or number range) of the building.



78
79
80
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 78

def building_number
  @building_number
end

#company ⇒ Object (readonly)

The name of the company. Example: Postcode Anywhere (Europe) Ltd



12
13
14
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 12

def company
  @company
end

#county ⇒ Object (readonly)

The postal county for the address. Example: Worcestershire



42
43
44
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 42

def county
  @county
end

#delivery_point_suffix ⇒ Object (readonly)

The 2 character delivery point suffix. Example: 3U



67
68
69
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 67

def delivery_point_suffix
  @delivery_point_suffix
end

#department ⇒ Object (readonly)

Department name (rarely used).



15
16
17
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 15

def department
  @department
end

#dependent_locality ⇒ Object (readonly)

Less significant locality name, possibly a village. Example: Hallow



92
93
94
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 92

def dependent_locality
  @dependent_locality
end

#double_dependent_locality ⇒ Object (readonly)

The least significant locality (rarely used), possibly a hamlet.



88
89
90
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 88

def double_dependent_locality
  @double_dependent_locality
end

#line1 ⇒ Object (readonly)

Line 1 of the address. Example: Enigma House



19
20
21
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 19

def line1
  @line1
end

#line2 ⇒ Object (readonly)

Line 2 of the address. Example: Elgar Business Centre



23
24
25
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 23

def line2
  @line2
end

#line3 ⇒ Object (readonly)

Line 3 of the address (rarely used). Example: Moseley Road



27
28
29
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 27

def line3
  @line3
end

#line4 ⇒ Object (readonly)

Line 4 of the address (rarely used). Example: Hallow



31
32
33
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 31

def line4
  @line4
end

#line5 ⇒ Object (readonly)

Line 5 of the address (rarely used).



34
35
36
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 34

def line5
  @line5
end

#mailsort ⇒ Object (readonly)

The mailsort code for the address. Example: 70122



50
51
52
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 50

def mailsort
  @mailsort
end

#po_box ⇒ Object (readonly)

The number of the PO Box if present (may contain non numeric items).



95
96
97
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 95

def po_box
  @po_box
end

#post_town ⇒ Object (readonly)

The post town for the address. Example: Worcester



38
39
40
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 38

def post_town
  @post_town
end

#postcode ⇒ Object (readonly)

The postcode for the address. Example: WR2 6NJ



46
47
48
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 46

def postcode
  @postcode
end

#primary_street ⇒ Object (readonly)

The primary thoroughfare name. Example: Moseley Road



82
83
84
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 82

def primary_street
  @primary_street
end

#secondary_street ⇒ Object (readonly)

The secondary thoroughfare name. Usually a small street off the primary.



85
86
87
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 85

def secondary_street
  @secondary_street
end

#sub_building ⇒ Object (readonly)

The name of the sub building (flat / unit etc). Example: Enigma House



71
72
73
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 71

def sub_building
  @sub_building
end

#type ⇒ Object (readonly)

The type of address. Example: SmallBusiness Values:

- Residential
- SmallBusiness
- LargeBusiness
- Unknown



63
64
65
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 63

def type
  @type
end

#udprn ⇒ Object (readonly)

The Royal Mail UDPRN (Unique Delivery Point Reference Number) for the address. Example: 26742632



8
9
10
 
# File 'lib/postcode_anywhere/cleanse_plus/cleansed_address.rb', line 8

def udprn
  @udprn
end