django-ph-geography 1.0.0

ph_geography.models.Region

Model for regions. Available fields are:

• code (CharField<max_length=10, unique=True, null=False>): Unique geographical code for region.

• name (CharField<max_length=100, null=False)>): Geographical name for region.

• population (PositiveIntegerField<null=True>): Population count based on 2015 POPCEN. Null value means no data is available.

• island_group (CharField<max_length=1, choices=ISLAND_GROUP_CHOICES, null=False>): Island group where the region is located. Possible values are based on items in model property ISLAND_GROUP_CHOICES:

  • ISLAND_GROUP_LUZON ('L') - Luzon

  • ISLAND_GROUP_VISAYAS ('V') - Visayas

  • ISLAND_GROUP_MINDANAO ('M') - Mindanao

• is_active (BooleanField<null=False, default=True>): Toggle if region is active (True) or not (False).

ph_geography.models.Province

Model for provinces. Available fields are:

• code (CharField<max_length=10, unique=True, null=False>): Unique geographical code for region.

• name (CharField<max_length=100, null=False)>): Geographical name for region.

• population (PositiveIntegerField<null=True>): Population count based on 2015 POPCEN. Null value means no data is available.

• region (ForeignKey<Region, related_name='provinces', related_query_name='province', null=False, on_delete=models.CASCADE>): Region where province is located.

• income_class (CharField<max_length=1, choices=INCOME_CLASS_CHOICES, null=False, blank=True>): Income classification. Blank value means no data is available. Possible values are based on items in model property INCOME_CLASS_CHOICES:

  • INCOME_CLASS_1 ('1') - 1st

  • INCOME_CLASS_2 ('2') - 2nd

  • INCOME_CLASS_3 ('3') - 3rd

  • INCOME_CLASS_4 ('4') - 4th

  • INCOME_CLASS_5 ('5') - 5th

  • INCOME_CLASS_6 ('6') - 6th

  • INCOME_CLASS_SPECIAL ('S') - Special

• is_active (BooleanField<null=False, default=True>): Toggle if province is active (True) or not (False).

Available properties:

• island_group: Reference to Region field island_group.

ph_geography.models.Municipality

Model for municipalities and cities. Available fields are:

• code (CharField<max_length=10, unique=True, null=False>): Unique geographical code for region.

• name (CharField<max_length=100, null=False)>): Geographical name for region.

• population (PositiveIntegerField<null=True>): Population count based on 2015 POPCEN. Null value means no data is available.

• province (ForeignKey<Province, related_name='municipalities', related_query_name='municipality', null=False, on_delete=models.CASCADE>): Province where municipality is located.

• income_class (CharField<max_length=1, choices=INCOME_CLASS_CHOICES, null=False, blank=True>): Income classification. Blank value means no data is available. Possible values are based on items in model property INCOME_CLASS_CHOICES:

  • INCOME_CLASS_1 ('1') - 1st

  • INCOME_CLASS_2 ('2') - 2nd

  • INCOME_CLASS_3 ('3') - 3rd

  • INCOME_CLASS_4 ('4') - 4th

  • INCOME_CLASS_5 ('5') - 5th

  • INCOME_CLASS_6 ('6') - 6th

  • INCOME_CLASS_SPECIAL ('S') - Special

• is_city (BooleanField<null=False>): Toggle to define whether the municipality is a city (True) or not (False).

• is_capital (BooleanField<null=False>): Toggle to define whether the municipality is a capital (True) or not (False).

• city_class (CharField<max_length=1, choices=CITY_CLASS_CHOICES, null=False, blank=True>): City legal classification. Blank value means no data is available. Possible values are based on items in model property CITY_CLASS_CHOICES:

  • CITY_CLASS_COMPONENT_CITY ('C') - CC

  • CITY_CLASS_INDEPENDENT_COMPONENT_CITY ('I') - ICC

  • CITY_CLASS_HIGHLY_URBANIZED_CITY ('H') - HUC

• is_active (BooleanField<null=False, default=True>): Toggle if municipality is active (True) or not (False).

Available properties:

• island_group: Reference to Region field island_group.

• region: Reference to province field region.

ph_geography.models.Barangay

Model for barangays. Available fields are:

• code (CharField<max_length=10, unique=True, null=False>): Unique geographical code for region.

• name (CharField<max_length=100, null=False)>): Geographical name for region.

• population (PositiveIntegerField<null=True>): Population count based on 2015 POPCEN. Null value means no data is available.

• municipality (ForeignKey<Municipality>, related_name='barangays', related_query_name='barangay', null=False, on_delete=models.CASCADE>): Municipality where barangay is located.

• is_urban (NullBooleanField<null=False>): Toggle to define whether the barangay is urban (True) or rural (False). Null value means no data is available.

• is_active (BooleanField<null=False, default=True>): Toggle if barangay is active (True) or not (False).

Available properties:

• island_group: Reference to Region field island_group.

• province: Reference to municipality field province.

• region: Reference to property province field region.

Adding new fields

You can use the custom method add_field provided by abstract model class ph_geography.models.PhilippineGeography to add fields to the models provided. Using the said method to the abstract model will apply the action to all subclasses.

Example:

from django.db import models

from ph_geography.models import PhilippineGeography
from ph_geography.models import Region


# Add field to Region, Province, Municipality, Barangay, and any subclass models of PhilippineGeography
PhilippineGeography.add_field('all_models', models.BooleanField(null=True))

# Add field 'single_model' to Region
Region.add_field('single_model', models.BooleanField(null=True))

Removing existing fields

You can use the custom method remove_field provided by abstract model class ph_geography.models.PhilippineGeography to remove fields to the models provided. Using the same method to the abstract model will apply the action to all subclasses.

Example:

from ph_geography.models import PhilippineGeography
from ph_geography.models import Municipality
from ph_geography.models import Region


# Remove field to Region, Province, Municipality, Barangay, and any subclass models of PhilippineGeography
PhilippineGeography.remove_field('population')

# Remove field 'island_group' from Region
Region.remove_field('island_group')

# Multiple fields to remove are supported
Municipality.remove_field('is_city', 'is_capital')