Options
All
  • Public
  • Public/Protected
  • All
Menu

Module rules

Index

Functions

Const po_box

Const rule1

  • Rule 1 - No building name, number or sub building name No premise elements detected (typically organisation name)

    Parameters

    Returns FormattedPremise

Const rule2

Const rule3

  • Rule 3 - Building name only

    Check format of Building Name (see note (a) above). If the Exception Rule applies, the Building Name should appear at the beginning of the first Thoroughfare line, or the first Locality line if there is no Thoroughfare information.

    When a building has a name AND a number range, both must be held in the Building Name field because the Building Number field can only hold numeric characters.

    If an address has a building name with text followed by a space and then completed by numerics/numeric ranges with the numeric part an exception (see Note (a) above), the numerics/numeric range are treated as a building number, and the text part is treated as the Building Name and the numerics/numeric range are split off to appear at the beginning of the first Thoroughfare line, or the first Locality line if there is no Thoroughfare.

    Parameters

    Returns FormattedPremise

Const rule4

  • Rule 4 - Building Name and Number

    The Building Name should appear on the line preceding the Thoroughfare and/or Locality information. The Building Number should appear at the beginning of the first Thoroughfare line. If there is no Thoroughfare information then the Building Number should appear at the beginning of the first Locality line.

    Parameters

    Returns FormattedPremise

Const rule5

  • Rule 5 - Sub Building Name and Building Number

    The Sub Building Name should appear on the line preceding the Thoroughfare and Locality information. The Building Number should appear at the beginning of the first Thoroughfare line. If there is no Thoroughfare information then the Building Number should appear at the beginning of the first Locality line.

    Parameters

    Returns FormattedPremise

Const rule6

  • Rule 6 - Sub building name and building name

    Check the format of Sub Building Name (see Note (a) above). If the Exception Rule applies, the Sub Building Name should appear on the same line as, and before, the Building Name.

    Otherwise, the Sub Building Name should appear on a line preceding the Building Name, Thoroughfare and Locality information

    Check format of Building Name (see note (a) above) If the Exception Rule applies, the Building Name should appear at the beginning of the first Thoroughfare line, or the first Locality line if there is no Thoroughfare information. Otherwise, the Building Name should appear on a line preceding the Thoroughfare and Locality information.

    Parameters

    Returns FormattedPremise

Const rule7

  • Rule 7 - Sub building name, building name and building number

    If the Exception Rule applies, the Sub Building Name should appear on the same line as and before the Building Name.

    Parameters

    Returns FormattedPremise

Const undocumentedRule

  • Undocumented Rule

    This rule should not exist as it is not listed in the developer docs. But some records in the wild only have a sub building name

    Parameters

    Returns FormattedPremise