001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.geo.server.command;
018
019import com.echothree.control.user.geo.common.form.AddZipCodeToCityForm;
020import com.echothree.model.control.geo.common.GeoCodeAliasTypes;
021import com.echothree.model.control.geo.common.GeoCodeTypes;
022import com.echothree.model.control.geo.server.control.GeoControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.geo.server.entity.GeoCode;
027import com.echothree.model.data.geo.server.entity.GeoCodeRelationship;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collection;
039import java.util.Collections;
040import java.util.List;
041import javax.enterprise.context.RequestScoped;
042
043@RequestScoped
044public class AddZipCodeToCityCommand
045        extends BaseSimpleCommand<AddZipCodeToCityForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                    new SecurityRoleDefinition(SecurityRoleGroups.City.name(), SecurityRoles.Edit.name())
055                    )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CityGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ZipCodeGeoCodeName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("ZipCodeName", FieldType.ENTITY_NAME, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of AddZipCodeToCityCommand */
066    public AddZipCodeToCityCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var zipCodeGeoCodeName = form.getZipCodeGeoCodeName();
073        var zipCodeName = form.getZipCodeName();
074        var parameterCount = (zipCodeGeoCodeName == null ? 0 : 1) + (zipCodeName == null ? 0 : 1);
075        
076        if(parameterCount == 1) {
077            var geoControl = Session.getModelController(GeoControl.class);
078            var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.ZIP_CODE.name());
079            var cityGeoCodeName = form.getCityGeoCodeName();
080            var cityGeoCode = geoControl.getGeoCodeByName(cityGeoCodeName);
081            GeoCode zipCodeGeoCode = null;
082            
083            if(zipCodeGeoCodeName != null) {
084                zipCodeGeoCode = geoControl.getGeoCodeByName(zipCodeGeoCodeName);
085                
086                if(!zipCodeGeoCode.getLastDetail().getGeoCodeType().equals(geoCodeType)) {
087                    zipCodeGeoCode = null;
088                }
089                
090                if(zipCodeGeoCode == null) {
091                    addExecutionError(ExecutionErrors.UnknownZipCodeGeoCodeName.name(), zipCodeGeoCodeName);
092                }
093            } else if(zipCodeName != null) {
094                var stateGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.STATE.name());
095                GeoCode stateGeoCode = null;
096                Collection cityRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(cityGeoCode);
097                for(var iter = cityRelationships.iterator(); iter.hasNext();) {
098                    var geoCodeRelationship = (GeoCodeRelationship)iter.next();
099                    var toGeoCode = geoCodeRelationship.getToGeoCode();
100                    if(toGeoCode.getLastDetail().getGeoCodeType().equals(stateGeoCodeType)) {
101                        stateGeoCode = toGeoCode;
102                        break;
103                    }
104                }
105
106                var countryGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTRY.name());
107                GeoCode countryGeoCode = null;
108                Collection stateRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(stateGeoCode);
109                for(var iter = stateRelationships.iterator(); iter.hasNext();) {
110                    var geoCodeRelationship = (GeoCodeRelationship)iter.next();
111                    var toGeoCode = geoCodeRelationship.getToGeoCode();
112                    if(toGeoCode.getLastDetail().getGeoCodeType().equals(countryGeoCodeType)) {
113                        countryGeoCode = toGeoCode;
114                        break;
115                    }
116                }
117
118                var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.ISO_2_LETTER.name());
119                var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
120                var countryIso2Letter = countryGeoCodeAlias.getAlias();
121
122                var geoCodeScopeName = countryIso2Letter + "_ZIP_CODES";
123                var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
124
125                var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.ZIP_CODE.name());
126                var geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, zipCodeName);
127                zipCodeGeoCode = geoCodeAlias.getGeoCode();
128                
129                if(zipCodeGeoCode == null) {
130                    addExecutionError(ExecutionErrors.UnknownZipCodeName.name(), zipCodeName);
131                }
132            }
133            
134            if(zipCodeGeoCode != null) {
135                var geoCodeRelationship = geoControl.getGeoCodeRelationship(zipCodeGeoCode, cityGeoCode);
136                
137                if(geoCodeRelationship == null) {
138                    geoControl.createGeoCodeRelationship(zipCodeGeoCode, cityGeoCode, getPartyPK());
139                } else {
140                    addExecutionError(ExecutionErrors.DuplicateGeoCodeRelationship.name());
141                }
142            }
143        } else {
144            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
145        }
146        
147        return null;
148    }
149    
150}