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.CreateCountyForm;
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 com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collection;
042import java.util.Collections;
043import java.util.List;
044import javax.enterprise.context.RequestScoped;
045
046@RequestScoped
047public class CreateCountyCommand
048        extends BaseSimpleCommand<CreateCountyForm> {
049    
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.County.name(), SecurityRoles.Create.name())
058                        )))
059                )));
060        
061        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("StateGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("CountyName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("CountyNumber", FieldType.NUMBER_3, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                ));
069    }
070    
071    /** Creates a new instance of CreateCountyCommand */
072    public CreateCountyCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var result = GeoResultFactory.getCreateCountyResult();
079        var geoControl = Session.getModelController(GeoControl.class);
080        BasePK createdBy = getPartyPK();
081        GeoCode geoCode;
082
083        var stateGeoCodeName = form.getStateGeoCodeName();
084        var stateGeoCode = geoControl.getGeoCodeByName(stateGeoCodeName);
085
086        var stateGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(stateGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.POSTAL_2_LETTER.name());
087        var stateGeoCodeAlias = geoControl.getGeoCodeAlias(stateGeoCode, stateGeoCodeAliasType);
088        var statePostal2Letter = stateGeoCodeAlias.getAlias();
089
090        var countryGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTRY.name());
091        GeoCode countryGeoCode = null;
092        Collection stateRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(stateGeoCode);
093        for(var iter = stateRelationships.iterator(); iter.hasNext();) {
094            var geoCodeRelationship = (GeoCodeRelationship)iter.next();
095            var toGeoCode = geoCodeRelationship.getToGeoCode();
096            if(toGeoCode.getLastDetail().getGeoCodeType().equals(countryGeoCodeType)) {
097                countryGeoCode = toGeoCode;
098                break;
099            }
100        }
101
102        var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.ISO_2_LETTER.name());
103        var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
104        var countryIso2Letter = countryGeoCodeAlias.getAlias();
105
106        var geoCodeScopeName = countryIso2Letter + "_" + statePostal2Letter + "_COUNTIES";
107        var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
108        if(geoCodeScope == null) {
109            geoCodeScope = geoControl.createGeoCodeScope(geoCodeScopeName, false, 0, getPartyPK());
110        }
111
112        var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTY.name());
113        var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.COUNTY_NAME.name());
114        var countyName = form.getCountyName();
115        var geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, countyName);
116        
117        if(geoCodeAlias == null) {
118            var geoCodeName = SequenceGeneratorLogic.getInstance().getNextSequenceValue(null, SequenceTypes.GEO_CODE.name());
119            var countyNumber = form.getCountyNumber();
120            var isDefault = Boolean.valueOf(form.getIsDefault());
121            var sortOrder = Integer.valueOf(form.getSortOrder());
122            var description = form.getDescription();
123            
124            geoCode = geoControl.createGeoCode(geoCodeName, geoCodeType, geoCodeScope, isDefault, sortOrder, createdBy);
125            geoControl.createGeoCodeRelationship(geoCode, stateGeoCode, createdBy);
126            geoControl.createGeoCodeAlias(geoCode, geoCodeAliasType, countyName, createdBy);
127            geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.COUNTY_NUMBER.name());
128            geoControl.createGeoCodeAlias(geoCode, geoCodeAliasType, countyNumber, 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}