class WellSubmissionLegacySerializer(WellSubmissionSerializerBase):
""" Class with no validation, and all possible fields, used by stacker to create legacy records """
casing_set = CasingSerializer(many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
linerperforation_set = LinerPerforationSerializer(
many=True, required=False)
decommission_description_set = DecommissionDescriptionSerializer(
many=True, required=False)
lithologydescription_set = LithologyDescriptionSerializer(many=True, required=False)
def get_well_activity_type(self):
return WellActivityCode.types.legacy()
def get_foreign_key_sets(self):
return {
'casing_set': Casing,
'screen_set': Screen,
'linerperforation_set': LinerPerforation,
'decommission_description_set': DecommissionDescription,
'lithologydescription_set': LithologyDescription,
}
class Meta:
model = ActivitySubmission
extra_kwargs = {
# This field might not be present
'create_user': {'required': False},
# This is autopopulated during create
'well_activity_type': {'required': False},
}
fields = '__all__'
class WellSubmissionListSerializer(serializers.ModelSerializer):
""" Class used for listing well submissions.
"""
casing_set = CasingSerializer(many=True, required=False)
decommission_description_set = DecommissionDescriptionSerializer(
many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
linerperforation_set = LinerPerforationSerializer(many=True,
required=False)
class Meta:
fields = '__all__'
model = ActivitySubmission
class WellSubsurfaceSerializer(serializers.ModelSerializer):
screen_set = ScreenSerializer(many=True)
lithologydescription_set = LithologyDescriptionSummarySerializer(many=True)
intended_water_use = serializers.ReadOnlyField(
source='intended_water_use.description')
distance = serializers.FloatField(required=False)
aquifer = WellAquiferSerializer()
class Meta:
model = Well
fields = ("well_tag_number", "static_water_level", "screen_set",
"lithologydescription_set", "well_yield", "diameter",
"aquifer", "distance", "latitude", "longitude",
"well_yield_unit", "finished_well_depth", "street_address",
"intended_water_use", "aquifer_lithology")
def to_representation(self, instance):
details = super().to_representation(instance)
if instance.aquifer and instance.aquifer.subtype:
details[
'aquifer_hydraulically_connected'] = instance.aquifer.subtype.code in HYDRAULIC_SUBTYPES
return details
class WellSubmissionStackerSerializer(WellSubmissionSerializerBase):
""" Class with no validation, and all possible fields, used by stacker to serialize. """
casing_set = CasingSerializer(many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
linerperforation_set = LinerPerforationSerializer(many=True,
required=False)
decommission_description_set = DecommissionDescriptionSerializer(
many=True, required=False)
productiondata_set = ProductionDataSerializer(many=True, required=False)
def get_foreign_keys(self):
return {
'casing_set': Casing,
'screen_set': Screen,
'linerperforation_set': LinerPerforation,
'decommission_description_set': DecommissionDescription,
'productiondata_set': ProductionData
}
class Meta:
model = ActivitySubmission
fields = '__all__'
class WellStaffEditSubmissionSerializer(WellSubmissionSerializerBase):
well = serializers.PrimaryKeyRelatedField(queryset=Well.objects.all())
linerperforation_set = LinerPerforationSerializer(many=True,
required=False)
casing_set = CasingSerializer(many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
productiondata_set = ProductionDataSerializer(many=True, required=False)
decommission_description_set = DecommissionDescriptionSerializer(
many=True, required=False)
def get_well_activity_type(self):
return WellActivityCode.types.staff_edit()
def get_foreign_keys(self):
return {
'casing_set': Casing,
'screen_set': Screen,
'linerperforation_set': LinerPerforation,
'productiondata_set': ProductionData,
'decommission_description_set': DecommissionDescription
}
class Meta:
model = ActivitySubmission
fields = (
'well',
'well_class',
'well_subclass',
'well_status',
'intended_water_use',
'identification_plate_number',
'well_identification_plate_attached',
'id_plate_attached_by',
'water_supply_system_name',
'water_supply_system_well_name',
'work_start_date',
'work_end_date',
'owner_full_name',
'owner_mailing_address',
'owner_province_state',
'owner_city',
'owner_postal_code',
'owner_email',
'owner_tel',
'street_address',
'city',
'consultant_company',
'consultant_name',
'driller_name',
'driller_responsible',
'legal_lot',
'legal_plan',
'legal_district_lot',
'legal_block',
'legal_section',
'legal_township',
'legal_range',
'land_district',
'legal_pid',
'well_location_description',
'latitude',
'longitude',
'coordinate_acquisition_code',
'ground_elevation',
'ground_elevation_method',
'drilling_method',
'other_drilling_method',
'well_orientation',
# 'lithologydescription_set',
'casing_set',
'surface_seal_material',
'surface_seal_depth',
'surface_seal_thickness',
'surface_seal_method',
'backfill_type',
'backfill_depth',
'liner_material',
'liner_diameter',
'liner_thickness',
'liner_from',
'liner_to',
'linerperforation_set',
'screen_intake_method',
'screen_type',
'screen_material',
'other_screen_material',
'screen_opening',
'screen_bottom',
'other_screen_bottom',
'screen_set',
'screen_information',
'filter_pack_from',
'filter_pack_to',
'filter_pack_thickness',
'filter_pack_material',
'filter_pack_material_size',
'development_method',
'development_hours',
'development_notes',
'productiondata_set',
'water_quality_characteristics',
'water_quality_colour',
'water_quality_odour',
'ems_id',
'total_depth_drilled',
'finished_well_depth',
'decommission_reason',
'decommission_method',
'sealant_material',
'backfill_material',
'decommission_details',
'final_casing_stick_up',
'bedrock_depth',
'static_water_level',
'well_yield',
'artesian_flow',
'artesian_pressure',
'well_cap_type',
'well_disinfected',
'comments',
'internal_comments',
'alternative_specs_submitted',
'decommission_description_set',
)
class WellAlterationSubmissionSerializer(WellSubmissionSerializerBase):
""" Serializes a well alteration submission. """
casing_set = CasingSerializer(many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
linerperforation_set = LinerPerforationSerializer(many=True,
required=False)
productiondata_set = ProductionDataSerializer(many=True, required=False)
def get_foreign_keys(self):
return {
'casing_set': Casing,
'screen_set': Screen,
'linerperforation_set': LinerPerforation,
'productiondata_set': ProductionData
}
def get_well_activity_type(self):
return WellActivityCode.types.alteration()
class Meta:
model = ActivitySubmission
fields = (
'filing_number',
'well_activity_type',
'well',
'well_class',
'well_subclass',
'intended_water_use',
'identification_plate_number',
'well_identification_plate_attached',
'work_start_date',
'work_end_date',
'owner_full_name',
'owner_mailing_address',
'owner_province_state',
'owner_city',
'owner_postal_code',
'owner_email',
'owner_tel',
'street_address',
'city',
'consultant_company',
'consultant_name',
'driller_name',
'driller_responsible',
'legal_lot',
'legal_plan',
'legal_district_lot',
'legal_block',
'legal_section',
'legal_township',
'legal_range',
'land_district',
'legal_pid',
'well_location_description',
'latitude',
'longitude',
'ground_elevation',
'ground_elevation_method',
'drilling_method',
'other_drilling_method',
'well_orientation',
'lithologydescription_set',
'casing_set',
'surface_seal_material',
'surface_seal_depth',
'surface_seal_thickness',
'surface_seal_method',
'backfill_type',
'backfill_depth',
'liner_material',
'liner_diameter',
'liner_thickness',
'liner_from',
'liner_to',
'linerperforation_set',
'screen_intake_method',
'screen_type',
'screen_material',
'other_screen_material',
'screen_opening',
'screen_bottom',
'other_screen_bottom',
'screen_information',
'screen_set',
'filter_pack_from',
'filter_pack_to',
'filter_pack_thickness',
'filter_pack_material',
'filter_pack_material_size',
'development_method',
'development_hours',
'development_notes',
'productiondata_set',
'water_quality_characteristics',
'water_quality_colour',
'water_quality_odour',
'ems_id',
'total_depth_drilled',
'finished_well_depth',
'final_casing_stick_up',
'bedrock_depth',
'static_water_level',
'well_yield',
'artesian_flow',
'artesian_pressure',
'well_cap_type',
'well_disinfected',
'comments',
'alternative_specs_submitted',
)
extra_kwargs = {
# TODO: reference appropriate serializer as above
'lithologydescription_set': {
'required': False
},
'well_activity_type': {
'required': False
}
}
class WellConstructionSubmissionSerializer(WellSubmissionSerializerBase):
""" Serializes a well construction submission. """
casing_set = CasingSerializer(many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
linerperforation_set = LinerPerforationSerializer(
many=True, required=False)
lithologydescription_set = LithologyDescriptionSerializer(many=True, required=False)
coordinate_acquisition_code = serializers.PrimaryKeyRelatedField(
queryset=CoordinateAcquisitionCode.objects.all(),
required=False, allow_null=True)
def create(self, validated_data):
# Whenever we create a Construction record, we default to H (gps) for the source.
if 'coordinate_acquisition_code' not in validated_data:
validated_data['coordinate_acquisition_code'] = CoordinateAcquisitionCode.objects.get(code='H')
return super().create(validated_data)
def get_foreign_key_sets(self):
return {
'casing_set': Casing,
'screen_set': Screen,
'linerperforation_set': LinerPerforation,
'lithologydescription_set': LithologyDescription,
}
def get_well_activity_type(self):
return WellActivityCode.types.construction()
class Meta:
model = ActivitySubmission
fields = ('filing_number', 'well_activity_type', 'well', 'well_class', 'well_subclass',
'intended_water_use', 'identification_plate_number', 'well_identification_plate_attached',
'work_start_date', 'work_end_date', 'owner_full_name', 'owner_mailing_address',
'owner_province_state', 'owner_city', 'owner_postal_code', 'owner_email',
'owner_tel', 'street_address', 'city',
'legal_lot', 'legal_plan', 'legal_district_lot', 'legal_block', 'legal_section',
'legal_township', 'legal_range', 'land_district', 'legal_pid', 'well_location_description',
'latitude', 'longitude', 'ground_elevation', 'ground_elevation_method', 'drilling_method',
'other_drilling_method', 'well_orientation', 'lithologydescription_set', 'casing_set',
'surface_seal_material', 'surface_seal_depth', 'surface_seal_thickness',
'surface_seal_method', 'backfill_type', 'backfill_depth',
'liner_material', 'liner_diameter', 'liner_thickness', 'liner_from', 'liner_to',
'linerperforation_set', 'screen_intake_method', 'screen_type', 'screen_material',
'other_screen_material', 'screen_opening', 'screen_bottom', 'other_screen_bottom',
'screen_set', 'filter_pack_from', 'filter_pack_to', 'filter_pack_thickness',
'filter_pack_material', 'filter_pack_material_size', 'development_method',
'development_hours', 'yield_estimation_method', 'yield_estimation_rate',
'yield_estimation_duration', 'well_yield_unit', 'static_level_before_test',
'drawdown', 'hydro_fracturing_performed', 'hydro_fracturing_yield_increase',
'recommended_pump_depth', 'recommended_pump_rate', 'development_notes',
'water_quality_characteristics',
'water_quality_colour', 'water_quality_odour', 'ems_id', 'total_depth_drilled',
'finished_well_depth', 'final_casing_stick_up', 'bedrock_depth', 'static_water_level',
'well_yield', 'artesian_flow', 'artesian_pressure', 'well_cap_type', 'well_disinfected',
'comments', 'alternative_specs_submitted', 'consultant_company', 'consultant_name',
'driller_name', 'driller_responsible', 'coordinate_acquisition_code',)
extra_kwargs = {
# TODO: reference appropriate serializer as above
'well_activity_type': {'required': False}
}
class WellSubmissionSerializer(serializers.ModelSerializer):
"""Serializes a well activity submission"""
casing_set = CasingSerializer(many=True, required=False)
decommission_description_set = DecommissionDescriptionSerializer(
many=True, required=False)
screen_set = ScreenSerializer(many=True, required=False)
linerperforation_set = LinerPerforationSerializer(many=True,
required=False)
class Meta:
model = ActivitySubmission
fields = (
"filing_number",
"activity_submission_guid",
"well",
"well_activity_type",
"well_class",
"well_subclass",
"intended_water_use",
"driller_responsible",
"driller_name",
"consultant_name",
"consultant_company",
"work_start_date",
"work_end_date",
"owner_full_name",
"owner_mailing_address",
"owner_city",
"owner_province_state",
"owner_postal_code",
"street_address",
"city",
"legal_lot",
"legal_plan",
"legal_district_lot",
"legal_block",
"legal_section",
"legal_township",
"legal_range",
"land_district",
"legal_pid",
"well_location_description",
"identification_plate_number",
"well_plate_attached",
"latitude",
"longitude",
"ground_elevation",
"ground_elevation_method",
"drilling_method",
"other_drilling_method",
"water_supply_system_name",
"water_supply_system_well_name",
"surface_seal_material",
"surface_seal_depth",
"surface_seal_thickness",
"surface_seal_method",
"backfill_above_surface_seal",
"backfill_above_surface_seal_depth",
"liner_material",
"liner_diameter",
"liner_thickness",
"liner_from",
"liner_to",
"screen_intake_method",
"screen_type",
"screen_material",
"other_screen_material",
"screen_opening",
"screen_bottom",
"other_screen_bottom",
"filter_pack_from",
"filter_pack_to",
"filter_pack_thickness",
"filter_pack_material",
"filter_pack_material_size",
"development_method",
"development_hours",
"development_notes",
"water_quality_characteristics",
"water_quality_colour",
"water_quality_odour",
"total_depth_drilled",
"finished_well_depth",
"final_casing_stick_up",
"bedrock_depth",
"static_water_level",
"well_yield",
"artesian_flow",
"artesian_pressure",
"well_cap_type",
"well_disinfected",
"comments",
"alternative_specs_submitted",
"well_yield_unit",
"diameter",
"casing_set",
"linerperforation_set",
"screen_set",
"decommission_reason",
"decommission_method",
"sealant_material",
"backfill_material",
"decommission_details",
'decommission_description_set',
)
@transaction.atomic
def create(self, validated_data):
# Pop foreign key records
FOREIGN_KEYS = {
'casing_set': Casing,
'screen_set': Screen,
'linerperforation_set': LinerPerforation,
'decommission_description_set': DecommissionDescription,
}
foreign_keys_data = {}
for key in FOREIGN_KEYS.keys():
foreign_keys_data[key] = validated_data.pop(key, None)
# Create submission
instance = super().create(validated_data)
# Create foreign key records
for key, value in foreign_keys_data.items():
if value:
for data in value:
FOREIGN_KEYS[key].objects.create(
activity_submission=instance, **data)
# Update the well record
stacker = wells.stack.StackWells()
stacker.process(instance.filing_number)
# The instance may have been updated with a well tag number
instance.refresh_from_db()
return instance