001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.CreateCityForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.geo.common.GeoCodeAliasTypes;
022import com.echothree.model.control.geo.common.GeoCodeTypes;
023import com.echothree.model.control.geo.server.control.GeoControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.control.sequence.common.SequenceTypes;
028import com.echothree.model.control.sequence.server.logic.SequenceGeneratorLogic;
029import com.echothree.model.data.geo.server.entity.GeoCode;
030import com.echothree.model.data.geo.server.entity.GeoCodeRelationship;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.persistence.BasePK;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.Collection;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class CreateCityCommand
046        extends BaseSimpleCommand<CreateCityForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.City.name(), SecurityRoles.Create.name())
056                ))
057        ));
058        
059        FORM_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("StateGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("CityName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
063                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
064                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
065        );
066    }
067
068    @Inject
069    GeoControl geoControl;
070
071    @Inject
072    SequenceGeneratorLogic sequenceGeneratorLogic;
073
074    
075    /** Creates a new instance of CreateCityCommand */
076    public CreateCityCommand() {
077        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
078    }
079    
080    @Override
081    protected BaseResult execute() {
082        var result = GeoResultFactory.getCreateCityResult();
083        BasePK createdBy = getPartyPK();
084        GeoCode geoCode;
085
086        var stateGeoCodeName = form.getStateGeoCodeName();
087        var stateGeoCode = geoControl.getGeoCodeByName(stateGeoCodeName);
088
089        var stateGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(stateGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.POSTAL_2_LETTER.name());
090        var stateGeoCodeAlias = geoControl.getGeoCodeAlias(stateGeoCode, stateGeoCodeAliasType);
091        var statePostal2Letter = stateGeoCodeAlias.getAlias();
092
093        var countryGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTRY.name());
094        GeoCode countryGeoCode = null;
095        Collection stateRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(stateGeoCode);
096        for(var iter = stateRelationships.iterator(); iter.hasNext();) {
097            var geoCodeRelationship = (GeoCodeRelationship)iter.next();
098            var toGeoCode = geoCodeRelationship.getToGeoCode();
099            if(toGeoCode.getLastDetail().getGeoCodeType().equals(countryGeoCodeType)) {
100                countryGeoCode = toGeoCode;
101                break;
102            }
103        }
104
105        var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.ISO_2_LETTER.name());
106        var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
107        var countryIso2Letter = countryGeoCodeAlias.getAlias();
108
109        var geoCodeScopeName = countryIso2Letter + "_" + statePostal2Letter + "_CITIES";
110        var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
111        if(geoCodeScope == null) {
112            geoCodeScope = geoControl.createGeoCodeScope(geoCodeScopeName, false, 0, getPartyPK());
113        }
114
115        var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.CITY.name());
116        var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.CITY_NAME.name());
117        var cityName = form.getCityName();
118        var geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, cityName);
119        
120        if(geoCodeAlias == null) {
121            var geoCodeName = sequenceGeneratorLogic.getNextSequenceValue(null, SequenceTypes.GEO_CODE.name());
122            var isDefault = Boolean.valueOf(form.getIsDefault());
123            var sortOrder = Integer.valueOf(form.getSortOrder());
124            var description = form.getDescription();
125            
126            geoCode = geoControl.createGeoCode(geoCodeName, geoCodeType, geoCodeScope, isDefault, sortOrder, createdBy);
127            geoControl.createGeoCodeRelationship(geoCode, stateGeoCode, createdBy);
128            geoControl.createGeoCodeAlias(geoCode, geoCodeAliasType, cityName, createdBy);
129            
130            if(description != null) {
131                var language = getPreferredLanguage();
132                
133                geoControl.createGeoCodeDescription(geoCode, language, description, createdBy);
134            }
135        } else {
136            geoCode = geoCodeAlias.getGeoCode();
137        }
138        
139        if(geoCode != null) {
140            result.setEntityRef(geoCode.getPrimaryKey().getEntityRef());
141            result.setGeoCodeName(geoCode.getLastDetail().getGeoCodeName());
142        }
143        
144        return result;
145    }
146    
147}