EDIT

/**

* Copyright (C) 2017 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.vaadin.view.name;

import java.util.Collection;

import java.util.EnumSet;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.UUID;

import org.apache.commons.lang3.BooleanUtils;

import org.springframework.context.annotation.Scope;

import org.vaadin.viritin.fields.AbstractElementCollection.Instantiator;

import org.vaadin.viritin.fields.ElementCollectionField;

import com.vaadin.data.Property;

import com.vaadin.data.Property.ValueChangeListener;

import com.vaadin.data.Validator.InvalidValueException;

import com.vaadin.server.ErrorMessage;

import com.vaadin.shared.ui.MarginInfo;

import com.vaadin.spring.annotation.SpringComponent;

import com.vaadin.ui.AbstractField;

import com.vaadin.ui.Alignment;

import com.vaadin.ui.CheckBox;

import com.vaadin.ui.Component;

import com.vaadin.ui.GridLayout;

import com.vaadin.ui.NativeSelect;

import com.vaadin.ui.Panel;

import com.vaadin.ui.TextField;

import eu.etaxonomy.cdm.api.utility.RoleProber;

import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;

import eu.etaxonomy.cdm.model.common.AnnotationType;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.common.RelationshipBase.Direction;

import eu.etaxonomy.cdm.model.name.NameRelationshipType;

import eu.etaxonomy.cdm.model.name.Rank;

import eu.etaxonomy.cdm.model.name.RankClass;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.model.reference.Reference;

import eu.etaxonomy.cdm.service.UserHelperAccess;

import eu.etaxonomy.cdm.vaadin.component.TextFieldNFix;

import eu.etaxonomy.cdm.vaadin.component.common.FilterableAnnotationsField;

import eu.etaxonomy.cdm.vaadin.component.common.TeamOrPersonField;

import eu.etaxonomy.cdm.vaadin.data.validator.NomenclaturalReferenceExistsValidator;

import eu.etaxonomy.cdm.vaadin.event.ReferenceEditorAction;

import eu.etaxonomy.cdm.vaadin.event.TaxonNameEditorAction;

import eu.etaxonomy.cdm.vaadin.event.TaxonNameEditorActionStrRep;

import eu.etaxonomy.cdm.vaadin.model.name.NameRelationshipDTO;

import eu.etaxonomy.cdm.vaadin.model.name.NomenclaturalStatusDTO;

import eu.etaxonomy.cdm.vaadin.model.name.TaxonNameDTO;

import eu.etaxonomy.cdm.vaadin.permission.CdmEditDeletePermissionTester;

import eu.etaxonomy.cdm.vaadin.permission.RolesAndPermissions;

import eu.etaxonomy.cdm.vaadin.ui.RegistrationUIDefaults;

import eu.etaxonomy.cdm.vaadin.ui.UIMessages;

import eu.etaxonomy.cdm.vaadin.util.TeamOrPersonBaseCaptionGenerator;

import eu.etaxonomy.cdm.vaadin.util.converter.SetToListConverter;

import eu.etaxonomy.vaadin.component.NameRelationField;

import eu.etaxonomy.vaadin.component.ReloadableLazyComboBox;

import eu.etaxonomy.vaadin.component.SwitchableTextField;

import eu.etaxonomy.vaadin.component.ToManyRelatedEntitiesComboboxSelect;

import eu.etaxonomy.vaadin.component.ToOneRelatedEntityCombobox;

import eu.etaxonomy.vaadin.component.WeaklyRelatedEntityCombobox;

import eu.etaxonomy.vaadin.event.EditorActionType;

import eu.etaxonomy.vaadin.mvp.AbstractCdmDTOPopupEditor;

/**

 * @author a.kohlbecker

 * @since May 22, 2017

 */

@SpringComponent

@Scope("prototype")

public class TaxonNamePopupEditor extends AbstractCdmDTOPopupEditor<TaxonNameDTO, TaxonName, TaxonNameEditorPresenter>

    implements TaxonNamePopupEditorView{

    private static final long serialVersionUID = -7037436241474466359L;

    private final static int GRID_COLS = 4;

    private final static int GRID_ROWS = 21;

    private static final boolean HAS_BASIONYM_DEFAULT = false;

    private AbstractField<String> genusOrUninomialField;

    private AbstractField<String> infraGenericEpithetField;

    private AbstractField<String> specificEpithetField;

    private AbstractField<String> infraSpecificEpithetField;

    private SwitchableTextField fullTitleCacheFiled;

    private SwitchableTextField protectedNameCacheField;

    private ToOneRelatedEntityCombobox<Reference> nomReferenceCombobox;

    private TextField nomenclaturalReferenceDetail;

    private TeamOrPersonField exBasionymAuthorshipField;

    private TeamOrPersonField basionymAuthorshipField;

    private ToManyRelatedEntitiesComboboxSelect<TaxonName> basionymsComboboxSelect;

    private ToManyRelatedEntitiesComboboxSelect<TaxonName> replacedSynonymsComboboxSelect;

    private NameRelationField validationField;

    private NameRelationField orthographicVariantField;

    private CheckBox nomStatusCollectionFieldToggle;

    private ElementCollectionField<NomenclaturalStatusDTO> nomStatusCollectionField;

    private CheckBox basionymToggle;

    private CheckBox replacedSynonymsToggle;

    private CheckBox validationToggle;

    private CheckBox orthographicVariantToggle;

    private NativeSelect rankSelect;

    private TeamOrPersonField combinationAuthorshipField;

    private TeamOrPersonField exCombinationAuthorshipField;

    private EnumSet<TaxonNamePopupEditorMode> modesActive = EnumSet.noneOf(TaxonNamePopupEditorMode.class);

    private Boolean isInferredCombinationAuthorship = null;

    private Boolean isInferredBasionymAuthorship = null;

    private Boolean isInferredExBasionymAuthorship = null;

    private Map<AbstractField, Property.ValueChangeListener> authorshipUpdateListeners = new HashMap<>();

    private Boolean isInferredExCombinationAuthorship;

    private int specificEpithetFieldRow;

    private ValueChangeListener updateFieldVisibilityListener = e -> updateFieldVisibility();

    private FilterableAnnotationsField annotationsListField;

    private AnnotationType[] editableAnotationTypes = RegistrationUIDefaults.EDITABLE_ANOTATION_TYPES;

    private int genusOrUninomialRow;

    private OrthographicCorrectionReferenceValidator orthographicCorrectionValidator;

    /**

     * By default  AnnotationType.EDITORIAL() is enabled.

     *

     * @return the editableAnotationTypes

     */

    @Override

    public AnnotationType[] getEditableAnotationTypes() {

        return editableAnotationTypes;

    }

    /**

     * By default  AnnotationType.EDITORIAL() is enabled.

     *

     * @param editableAnotationTypes the editableAnotationTypes to set

     */

    @Override

    public void setEditableAnotationTypes(AnnotationType ... editableAnotationTypes) {

        this.editableAnotationTypes = editableAnotationTypes;

    }

    public TaxonNamePopupEditor() {

        super(new GridLayout(GRID_COLS, GRID_ROWS), TaxonNameDTO.class);

    }

    @Override

    public String getWindowCaption() {

        return "Name editor";

    }

    @Override

    public int getWindowWidth() {

        return 800;

    }

    @Override

    public void focusFirst() {

        // none

    }

    @Override

    public void applyDefaultComponentStyle(Component ... components){

        for(int i = 0; i <components.length; i++){

            components[i].setStyleName(getDefaultComponentStyles());

        }

    }

    @Override

    protected String getDefaultComponentStyles() {

        return "tiny";

    }

    @Override

    protected void initContent() {

        GridLayout grid = (GridLayout)getFieldLayout();

        grid.setSizeFull();

        grid.setHideEmptyRowsAndColumns(true);

        grid.setSpacing(true);

        grid.setColumnExpandRatio(0, 0.3f);

        grid.setColumnExpandRatio(1, 0.3f);

        grid.setColumnExpandRatio(2, 0.3f);

        grid.setColumnExpandRatio(3, 0.0f);

        /*

         * TaxonName properties for reference here (NOTE: this editor operates on TaxonNameDTOs!):

         - nameType: preset, needs to be set in the presenter for new names

         - appendedPhrase: -> TODO field

         - nomenclaturalMicroReference:  -> TODO field

         - nomenclaturalSource.citation ->  field but disabled for REGISTRY

         - rank -> SelectField which determines the visiblity of the other fields

         - fullTitleCache + protectedFullTitleCache -> SwitchableTextField : ADVANCED_MODE

         - nameCache + protectedNameCache -> SwitchableTextField : ADVANCED_MODE

         - homotypicalGroup -> hidden

         - typeDesignations -> hidden

         - descriptions -> hidden

         - taxonBases -> hidden

         - registrations -> hidden

         - relationsFromThisName-> TODO implement later

         - relationsToThisName -> TODO implement later

         - genusOrUninomial -> textField

         - infraGenericEpithet  -> textField

         - specificEpithet  -> textField

         - infraSpecificEpithet  -> textField

         - authorshipCache + protectedAuthorshipCache -> SwitchableTextField : only ADVANCED_MODE and disabled for REGISTRY

         - basionymAuthorship -> field but disabled for REGISTRY, basionym is set as nameRelationShip

         - combinationAuthorship -> field but disabled for REGISTRY author team of the reference

         - exCombinationAuthorship -> textField

         - exBasionymAuthorship -> textField

         - status -> TODO field

         - monomHybrid -> TODO implement hybrids later

         - binomHybrid -> TODO implement hybrids later

         - trinomHybrid -> TODO implement hybrids later

         - hybridParentRelations -> TODO implement hybrids later

         - hybridChildRelations -> TODO implement hybrids later

         - hybridFormula -> TODO implement hybrids later

         ** ViralName attributes **

         - acronym

         ** BacterialName attributes **

         - subGenusAuthorship

         - nameApprobation

         - breed

         - publicationYear

         - originalPublicationYear

         - cultivarName

        */

        int row = 0;

        rankSelect = new NativeSelect("Rank");

        rankSelect.setNullSelectionAllowed(false);

        rankSelect.setWidth(100, Unit.PERCENTAGE);

        addField(rankSelect, "rank", 0, row, 1, row);

        grid.setComponentAlignment(rankSelect, Alignment.TOP_RIGHT);

        row++;

        basionymToggle = new CheckBox("With basionym");

        basionymToggle.setValue(HAS_BASIONYM_DEFAULT);

        basionymToggle.setStyleName(getDefaultComponentStyles());

        grid.addComponent(basionymToggle, 0, row);

        grid.setComponentAlignment(basionymToggle, Alignment.BOTTOM_LEFT);

        replacedSynonymsToggle = new CheckBox("With replaced synonym");

        grid.addComponent(replacedSynonymsToggle, 1, row);

        grid.setComponentAlignment(replacedSynonymsToggle, Alignment.BOTTOM_LEFT);

        validationToggle = new CheckBox("Validation");

        grid.addComponent(validationToggle, 2, row);

        grid.setComponentAlignment(validationToggle, Alignment.BOTTOM_LEFT);

        orthographicVariantToggle = new CheckBox("Orthographical variant");

        grid.addComponent(orthographicVariantToggle, 3, row);

        grid.setComponentAlignment(orthographicVariantToggle, Alignment.BOTTOM_LEFT);

        row++;

        // fullTitleCache

        fullTitleCacheFiled = addSwitchableTextField("Full title cache", "fullTitleCache", "protectedFullTitleCache", 0, row, GRID_COLS-1, row);

        fullTitleCacheFiled.setWidth(100, Unit.PERCENTAGE);

        row++;

        protectedNameCacheField = addSwitchableTextField("Name cache", "nameCache", "protectedNameCache", 0, row, GRID_COLS-1, row);

        protectedNameCacheField.setWidth(100, Unit.PERCENTAGE);

        row++;

        genusOrUninomialRow = row;

        genusOrUninomialField = addTextField("Genus or uninomial", "genusOrUninomial", 0, row, 1, row);

        genusOrUninomialField.setWidth(200, Unit.PIXELS);

        infraGenericEpithetField = addTextField("Infrageneric epithet", "infraGenericEpithet", 2, row, 3, row);

        infraGenericEpithetField.setWidth(200, Unit.PIXELS);

        row++;

        specificEpithetFieldRow = row;

        specificEpithetField = addTextField("Specific epithet", "specificEpithet", 0, row, 1, row);

        specificEpithetField.setWidth(200, Unit.PIXELS);

        infraSpecificEpithetField = addTextField("Infraspecific epithet", "infraSpecificEpithet", 2, row, 3, row);

        infraSpecificEpithetField.setWidth(200, Unit.PIXELS);

        row++;

        combinationAuthorshipField = new TeamOrPersonField("Combination author(s)", TeamOrPersonBaseCaptionGenerator.CacheType.NOMENCLATURAL_TITLE);

        combinationAuthorshipField.setWidth(100,  Unit.PERCENTAGE);

        addField(combinationAuthorshipField, "combinationAuthorship", 0, row, GRID_COLS-1, row);

        row++;

        nomReferenceCombobox = new ToOneRelatedEntityCombobox<Reference>("Nomenclatural reference", Reference.class);

        nomReferenceCombobox.addClickListenerAddEntity(e -> getViewEventBus().publish(

                this,

                new ReferenceEditorAction(EditorActionType.ADD, null, nomReferenceCombobox, this)

                ));

        nomReferenceCombobox.addClickListenerEditEntity(e -> {

            if(nomReferenceCombobox.getValue() != null){

                getViewEventBus().publish(this,

                    new ReferenceEditorAction(

                            EditorActionType.EDIT,

                            nomReferenceCombobox.getValue().getUuid(),

                            e.getButton(),

                            nomReferenceCombobox,

                            this)

                );

            }

            });

        // nomReferenceCombobox.getSelect().addValueChangeListener(e -> logger.debug("nomReferenceCombobox value changed #1"));

        // nomReferenceCombobox.setWidth(300, Unit.PIXELS);

        nomReferenceCombobox.setWidth("100%");

        addField(nomReferenceCombobox, "nomenclaturalReference", 0, row, 3, row);

        row++;

        nomenclaturalReferenceDetail = addTextField("Reference detail", "nomenclaturalMicroReference", 0, row, 2, row);

        nomenclaturalReferenceDetail.setWidth(100, Unit.PERCENTAGE);

        // --------------- nom status

        row++;

        nomStatusCollectionFieldToggle = new CheckBox("Invalid, illegitimate, or other status");

        nomStatusCollectionFieldToggle.addValueChangeListener(e -> {

            nomStatusCollectionField.getLayout().getParent().setVisible(nomStatusCollectionFieldToggle.getValue());

        });

        addComponent(nomStatusCollectionFieldToggle, 0, row, 0, row);

        row++;

        nomStatusCollectionField = new ElementCollectionField<NomenclaturalStatusDTO>(

                NomenclaturalStatusDTO.class,

                new Instantiator<NomenclaturalStatusDTO>() {

                    private static final long serialVersionUID = -2427045940046513092L;

                    @Override

                    public NomenclaturalStatusDTO create() {

                        return NomenclaturalStatusDTO.newInstance();

                    }

                },

                NomenclaturalStatusRow.class

                ){

                    private static final long serialVersionUID = -3130918034491809593L;

                    @Override

                    public void commit() throws SourceException, InvalidValueException {

                        validate(); // validate always so that empty rows are recognized

                        super.commit();

                    }

                    @Override

                    public boolean isEmpty() {

                        Collection<?> value = getValue();

                        return value == null || value.isEmpty() ;

                    }

                    @Override

                    public void setComponentError(ErrorMessage componentError) {

                        nomStatusCollectionField.setComponentError(componentError);

                    }

        };

        nomStatusCollectionField.getLayout().setSpacing(false);

        nomStatusCollectionField.setVisibleProperties(NomenclaturalStatusRow.visibleFields());

        nomStatusCollectionField.setPropertyHeader("type", "Status type");

        nomStatusCollectionField.setPropertyHeader("citation", "Reference");

        nomStatusCollectionField.setPropertyHeader("citationMicroReference", "Reference detail");

        nomStatusCollectionField.setPropertyHeader("ruleConsidered", "Rule considered");

        nomStatusCollectionField.addElementAddedListener( e -> nomStatusCollectionField.setComponentError(null));

        nomStatusCollectionField.getLayout().setMargin(new MarginInfo(false, true));

        Panel nomStatusCollectionPanel = new Panel(nomStatusCollectionField.getLayout());

        nomStatusCollectionPanel.setCaption("Status");

        nomStatusCollectionPanel.setWidth(100, Unit.PERCENTAGE);

        bindField(nomStatusCollectionField, "status");

        addComponent(nomStatusCollectionPanel, 0, row, 3, row);

        // --------------- Basionyms

        row++;

        basionymsComboboxSelect = new ToManyRelatedEntitiesComboboxSelect<TaxonName>(TaxonName.class, "Basionym");

        basionymsComboboxSelect.setConverter(new SetToListConverter<TaxonName>());

        addField(basionymsComboboxSelect, "basionyms", 0, row, 3, row);

        basionymsComboboxSelect.setWidth(100, Unit.PERCENTAGE);

        basionymsComboboxSelect.withEditButton(true);

        basionymsComboboxSelect.setEditPermissionTester(new CdmEditDeletePermissionTester());

        basionymsComboboxSelect.setEditActionListener(e -> {

            Object fieldValue = e.getSource().getValue();

            UUID beanUuid = null;

            if(fieldValue != null){

                beanUuid = ((CdmBase)fieldValue).getUuid();

            }

            ReloadableLazyComboBox<TaxonName>  lazyCombobox = (ReloadableLazyComboBox<TaxonName>) e.getSource();

            getViewEventBus().publish(this, new TaxonNameEditorAction(e.getAction(), beanUuid, null, lazyCombobox, this));

        });

        grid.setComponentAlignment(basionymsComboboxSelect, Alignment.TOP_RIGHT);

        row++;

        basionymAuthorshipField = new TeamOrPersonField("Basionym author(s)", TeamOrPersonBaseCaptionGenerator.CacheType.NOMENCLATURAL_TITLE);

        basionymAuthorshipField.setWidth(100,  Unit.PERCENTAGE);

        addField(basionymAuthorshipField, "basionymAuthorship", 0, row, GRID_COLS-1, row);

        row++;

        exBasionymAuthorshipField = new TeamOrPersonField("Ex-basionym author(s)", TeamOrPersonBaseCaptionGenerator.CacheType.NOMENCLATURAL_TITLE);

        exBasionymAuthorshipField.setWidth(100,  Unit.PERCENTAGE);

        addField(exBasionymAuthorshipField, "exBasionymAuthorship", 0, row, GRID_COLS-1, row);

        // --------------- ReplacedSynonyms

        row++;

        replacedSynonymsComboboxSelect = new ToManyRelatedEntitiesComboboxSelect<TaxonName>(TaxonName.class, "Replaced synonym");

        replacedSynonymsComboboxSelect.setConverter(new SetToListConverter<TaxonName>());

        addField(replacedSynonymsComboboxSelect, "replacedSynonyms", 0, row, 3, row);

        replacedSynonymsComboboxSelect.setWidth(100, Unit.PERCENTAGE);

        replacedSynonymsComboboxSelect.withEditButton(true);

        replacedSynonymsComboboxSelect.setEditPermissionTester(new CdmEditDeletePermissionTester());

        replacedSynonymsComboboxSelect.setEditActionListener(e -> {

            Object fieldValue = e.getSource().getValue();

            UUID beanUuid = null;

            if(fieldValue != null){

                beanUuid = ((CdmBase)fieldValue).getUuid();

            }

            ReloadableLazyComboBox<TaxonName>  lazyCombobox = (ReloadableLazyComboBox<TaxonName>) e.getSource();

            getViewEventBus().publish(this, new TaxonNameEditorAction(e.getAction(), beanUuid, null, lazyCombobox, this));

        });

        grid.setComponentAlignment(replacedSynonymsComboboxSelect, Alignment.TOP_RIGHT);

        // --------------- Validation

        row++;

        validationField = new NameRelationField("Validation of", "Designation", Direction.relatedTo, NameRelationshipType.VALIDATED_BY_NAME());

        validationField.setWidth(100, Unit.PERCENTAGE);

        ToOneRelatedEntityCombobox<TaxonName> validatedNameComboBox = validationField.getRelatedNameComboBox();

        validatedNameComboBox.addClickListenerAddEntity(e -> getViewEventBus().publish(

                this,

                new TaxonNameEditorAction(EditorActionType.ADD, null, validatedNameComboBox, this)

                ));

        validatedNameComboBox.addClickListenerEditEntity(e -> {

            if(validatedNameComboBox.getValue() != null){

                getViewEventBus().publish(this,

                    new TaxonNameEditorAction(

                            EditorActionType.EDIT,

                            validatedNameComboBox.getValue().getUuid(),

                            e.getButton(),

                            validatedNameComboBox,

                            this)

                );

            }

        });

        ToOneRelatedEntityCombobox<Reference> validationCitatonComboBox = validationField.getCitatonComboBox();

        validationCitatonComboBox.addClickListenerAddEntity(e -> getViewEventBus().publish(

                // NOTE: adding new references is currently not allowed for name relations, see NameRelationField!!

                this,

                new ReferenceEditorAction(EditorActionType.ADD, null, validationCitatonComboBox, this)

                ));

        validationCitatonComboBox.addClickListenerEditEntity(e -> {

            if(validationCitatonComboBox.getValue() != null){

                getViewEventBus().publish(this,

                    new ReferenceEditorAction(

                            EditorActionType.EDIT,

                            validationCitatonComboBox.getValue().getUuid(),

                            e.getButton(),

                            validationCitatonComboBox,

                            this)

                );

            }

        });

        addField(validationField, "validationFor", 0, row, 3, row);

        grid.setComponentAlignment(validationField, Alignment.TOP_RIGHT);

        // ------- Orthographic Variant (Correction)

        row++;

        orthographicVariantField = new NameRelationField("Orthographical variant", "Name variant", Direction.relatedTo, NameRelationshipType.ORTHOGRAPHIC_VARIANT());

        orthographicVariantField.setWidth(100, Unit.PERCENTAGE);

        // corrected name must have same

        ToOneRelatedEntityCombobox<TaxonName> orthographicVariantCombobox = orthographicVariantField.getRelatedNameComboBox();

        orthographicVariantCombobox.addClickListenerAddEntity(e -> getViewEventBus().publish(

                this,

                new TaxonNameEditorAction(EditorActionType.ADD, null, orthographicVariantCombobox, this)

                ));

        orthographicVariantCombobox.addClickListenerEditEntity(e -> {

            if(orthographicVariantCombobox.getValue() != null){

                getViewEventBus().publish(this,

                    new TaxonNameEditorAction(

                            EditorActionType.EDIT,

                            orthographicVariantCombobox.getValue().getUuid(),

                            e.getButton(),

                            orthographicVariantCombobox,

                            this)

                );

            }

        });

        ToOneRelatedEntityCombobox<Reference> orthographicCorrectionCitatonComboBox = orthographicVariantField.getCitatonComboBox();

        orthographicCorrectionCitatonComboBox.addClickListenerAddEntity(e -> getViewEventBus().publish(

                // NOTE: adding new references is currently not allowed for name relations, see NameRelationField!!

                this,

                new ReferenceEditorAction(EditorActionType.ADD, null, orthographicCorrectionCitatonComboBox, this)

                ));

        orthographicCorrectionCitatonComboBox.addClickListenerEditEntity(e -> {

            if(orthographicCorrectionCitatonComboBox.getValue() != null){

                getViewEventBus().publish(this,

                    new ReferenceEditorAction(

                            EditorActionType.EDIT,

                            orthographicCorrectionCitatonComboBox.getValue().getUuid(),

                            e.getButton(),

                            orthographicCorrectionCitatonComboBox,

                            this)

                );

            }

        });

        addField(orthographicVariantField, "orthographicVariant", 0, row, 3, row);

        grid.setComponentAlignment(orthographicVariantField, Alignment.TOP_RIGHT);

        row++;

        exCombinationAuthorshipField = new TeamOrPersonField("Ex-combination author(s)", TeamOrPersonBaseCaptionGenerator.CacheType.NOMENCLATURAL_TITLE);

        exCombinationAuthorshipField.setWidth(100,  Unit.PERCENTAGE);

        addField(exCombinationAuthorshipField, "exCombinationAuthorship", 0, row, GRID_COLS-1, row);

        row++;

        annotationsListField = new FilterableAnnotationsField("Editorial notes");

        annotationsListField.setWidth(100, Unit.PERCENTAGE);

        boolean isCurator = UserHelperAccess.userHelper().userIs(new RoleProber(RolesAndPermissions.ROLE_CURATION));

        boolean isAdmin = UserHelperAccess.userHelper().userIsAdmin();

        if(isCurator || isAdmin){

            annotationsListField.withNewButton(true);

        } else {

            annotationsListField.setAnnotationTypesVisible(editableAnotationTypes);

        }

        addField(annotationsListField, "annotations", 0, row, GRID_COLS-1, row);

        // -----------------------------------------------------------------------------

        setAdvancedModeEnabled(true);

        registerAdvancedModeComponents(fullTitleCacheFiled, protectedNameCacheField);

        registerAdvancedModeComponents(combinationAuthorshipField);

        registerAdvancedModeComponents(basionymAuthorshipField);

        registerAdvancedModeComponents(exBasionymAuthorshipField);

        registerAdvancedModeComponents(exCombinationAuthorshipField);

        registerAdvancedModeComponents(combinationAuthorshipField.getCachFields());

        registerAdvancedModeComponents(exCombinationAuthorshipField.getCachFields());

        registerAdvancedModeComponents(basionymAuthorshipField.getCachFields());

        registerAdvancedModeComponents(exBasionymAuthorshipField.getCachFields());

        setAdvancedMode(false);

        //TODO remove below line once #7858 is fixed

        withDeleteButton(false);

    }

    protected TeamOrPersonBase inferBasiomynAuthors() {

        List<TaxonName> basionyms = basionymsComboboxSelect.getValue();

        if(!basionyms.isEmpty() && basionyms.get(0) != null){

            TaxonName basionym = basionyms.get(0);

            if(basionym.getCombinationAuthorship() != null){

                return basionym.getCombinationAuthorship();

            } else if(basionym.getNomenclaturalReference() != null){

                return basionym.getNomenclaturalReference().getAuthorship();

            }

        }

        return null;

    }

    protected TeamOrPersonBase inferExBasiomynAuthors() {

        List<TaxonName> basionyms = basionymsComboboxSelect.getValue();

        if(!basionyms.isEmpty() && basionyms.get(0) != null){

            TaxonName basionym = basionyms.get(0);

                return basionym.getExCombinationAuthorship();

        }

        return null;

    }

    protected TeamOrPersonBase inferCombinationAuthors() {

        Reference nomRef = nomReferenceCombobox.getValue();

        if(nomRef != null) {

            return nomRef.getAuthorship();

        }

        return null;

    }

    protected TeamOrPersonBase inferExCombinationAuthors() {

        NameRelationshipDTO nameRelationDTO = validationField.getValue();

        TeamOrPersonBase inferredExAuthor = null;

        if(nameRelationDTO != null && nameRelationDTO.getOtherName() != null){

            TaxonName validatedName = nameRelationDTO.getOtherName();

            if(validatedName.getCombinationAuthorship() != null) {

                inferredExAuthor = validatedName.getCombinationAuthorship();

            } else if(validatedName.getNomenclaturalReference() != null){

                inferredExAuthor = validatedName.getNomenclaturalReference().getAuthorship();

            }

        }

        TeamOrPersonBase inferredCominationAuthors = inferCombinationAuthors();

        if(inferredExAuthor != null && inferredCominationAuthors != null

                // comparing by nomTitle to detect duplicates:

                && inferredExAuthor.getNomenclaturalTitle().equals(inferredCominationAuthors.getNomenclaturalTitle())) {

            // If and only if ex author = author the ex author is not included

            // into the author teams due to the ICN 46.10. (see #8317)

            inferredExAuthor = null;

        }

        return inferredExAuthor;

    }

    @Override

    protected void afterItemDataSourceSet() {

        rankSelect.addValueChangeListener(updateFieldVisibilityListener);

        basionymToggle.addValueChangeListener(e -> {

            updateAuthorshipFields();

        });

        validationToggle.addValueChangeListener(e -> {

            updateAuthorshipFields();

            });

        replacedSynonymsToggle.addValueChangeListener(e -> {

            boolean enable = e.getProperty().getValue() != null && (Boolean)e.getProperty().getValue();

            replacedSynonymsComboboxSelect.setVisible(enable);

        });

        orthographicVariantToggle.addValueChangeListener(e -> {

            boolean enable = e.getProperty().getValue() != null && (Boolean)e.getProperty().getValue();

            orthographicVariantField.setVisible(enable);

        });

        TaxonNameDTO taxonNameDTO = getBean();

        boolean showBasionymSection = taxonNameDTO.getBasionyms().size() > 0

                || taxonNameDTO.getBasionymAuthorship() != null

                || taxonNameDTO.getExBasionymAuthorship() != null;

        basionymToggle.setValue(showBasionymSection);

        basionymToggle.setReadOnly(showBasionymSection);

        boolean showReplacedSynonyms = taxonNameDTO.getReplacedSynonyms().size() > 0;

        replacedSynonymsToggle.setValue(showReplacedSynonyms);

        replacedSynonymsToggle.setReadOnly(showReplacedSynonyms);

        replacedSynonymsComboboxSelect.setVisible(showReplacedSynonyms);

        boolean showValidationSection = taxonNameDTO.getValidationFor() != null || taxonNameDTO.getExCombinationAuthorship() != null;

        validationToggle.setValue(showValidationSection);

        validationToggle.setReadOnly(showValidationSection);

        boolean showOrthographicCorrectionSection = taxonNameDTO.getOrthographicVariant() != null;

        orthographicVariantToggle.setValue(showOrthographicCorrectionSection);

        orthographicVariantToggle.setReadOnly(showOrthographicCorrectionSection);

        if(isModeEnabled(TaxonNamePopupEditorMode.AUTOFILL_AUTHORSHIP_DATA)){

            updateAuthorshipFields();

        }

        if(isModeEnabled(TaxonNamePopupEditorMode.NOMENCLATURALREFERENCE_SECTION_EDITING_ONLY) && getBean().getNomenclaturalReference() != null) {

            nomReferenceCombobox.setDescription("Selection limited to nomenclatural reference and parts of it.");

        }

        if(isModeEnabled(TaxonNamePopupEditorMode.REQUIRE_NOMENCLATURALREFERENCE)) {

            nomReferenceCombobox.setRequired(true);

            nomReferenceCombobox.setImmediate(true);

            String userHint = "Please use the 'Edit' function to fix the problem in the related name.";

            validationField.getRelatedNameComboBox().getSelect().addValidator(new NomenclaturalReferenceExistsValidator(userHint));

            orthographicVariantField.getRelatedNameComboBox().getSelect().addValidator(new NomenclaturalReferenceExistsValidator(userHint));

            basionymsComboboxSelect.addFieldValidator(new NomenclaturalReferenceExistsValidator(userHint));

            replacedSynonymsComboboxSelect.addFieldValidator(new NomenclaturalReferenceExistsValidator(userHint));

        }

    }

    /**

     * Updates all authorship fields if the an authorship field is empty this method attempts to infer the

     * authors from the related nomenclatural reference or taxon name.

     * <p>

     * Finally the {@link #updateFieldVisibility()} is invoked.

     *

     * @param taxonName

     */

    @Override

    public void updateAuthorshipFields() {

        TaxonNameDTO taxonName = getBean();

        // ------------- CombinationAuthors

        isInferredCombinationAuthorship = updateAuthorshipFieldData(

                taxonName.getCombinationAuthorship(),

                inferCombinationAuthors(),

                combinationAuthorshipField,

                nomReferenceCombobox.getSelect(),

                isInferredCombinationAuthorship);

        // ------------- Basionym and ExBasionymAuthors

        if(BooleanUtils.isTrue(basionymToggle.getValue())){

            isInferredBasionymAuthorship = updateAuthorshipFieldData(

                    taxonName.getBasionymAuthorship(),

                    inferBasiomynAuthors(),

                    basionymAuthorshipField,

                    basionymsComboboxSelect,

                    isInferredBasionymAuthorship

                    );

            isInferredExBasionymAuthorship = updateAuthorshipFieldData(

                    taxonName.getExBasionymAuthorship(),

                    inferExBasiomynAuthors(),

                    exBasionymAuthorshipField,

                    basionymsComboboxSelect,

                    isInferredExBasionymAuthorship

                    );

        }

        // ------------- Validation and ExCombinationAuthors

        isInferredExCombinationAuthorship = updateAuthorshipFieldData(

                taxonName.getExCombinationAuthorship(),

                inferExCombinationAuthors(),

                exCombinationAuthorshipField,

                validationField.getRelatedNameComboBox(),

                isInferredExCombinationAuthorship

                );

        updateFieldVisibility();

    }

    /**

     *

     * @param authorship

     *    the value of the taxonName authorship field

     * @param inferredAuthors

     *    the value inferred from other fields which may be set as authorship to the taxon name

     * @param authorshipField

     *    the ui element to edit the taxonName authorship field

     * @param updateTriggerField

     * @param lastInferredAuthorshipState

     * @return

     */

    protected Boolean updateAuthorshipFieldData(TeamOrPersonBase<?> authorship, TeamOrPersonBase inferredAuthors,

            TeamOrPersonField authorshipField, AbstractField updateTriggerField,

            Boolean lastInferredAuthorshipState) {

        if(authorship == null){

            authorshipField.setValue(inferredAuthors);

            lastInferredAuthorshipState = true;

        } else {

            boolean authorshipMatch = authorship == inferredAuthors;

            if(lastInferredAuthorshipState == null){

                // initialization of authorshipState, this comes only into account when the editor is just being initialized

                lastInferredAuthorshipState = authorshipMatch;

            }

            if(!authorshipMatch && lastInferredAuthorshipState){

                // update the combinationAuthorshipField to follow changes of the nomenclatural reference in case it was autofilled before

                authorshipField.setValue(inferredAuthors);

                lastInferredAuthorshipState = true;

            }

        }

        if(updateTriggerField != null){

            // IMPORTANT!

            // this ChangeListener must be added at this very late point in the editor lifecycle so that it is called after

            // the ToOneRelatedEntityReloader which may have been added to the updateTriggerField in the presenters handleViewEntered() method.

            // Otherwise we risk multiple representation problems in the hibernate session

            if(!authorshipUpdateListeners.containsKey(updateTriggerField)){

                ValueChangeListener listener = e ->  {

                    logger.debug(" value changed #2");

                    updateAuthorshipFields();

                };

                updateTriggerField.addValueChangeListener(listener);

                authorshipUpdateListeners.put(updateTriggerField, listener);

            }

        }

        return lastInferredAuthorshipState;

    }

    /**

     * @param rank

     * @return

     */

    private void updateFieldVisibility() {

        // TODO use getField() instead and remove field references

        Rank rank = (Rank) rankSelect.getValue();

        boolean isSpeciesOrBelow = !rank.isHigher(Rank.SPECIES()) && !rank.getRankClass().equals(RankClass.Unknown);

        Boolean withBasionymSection = BooleanUtils.isTrue(basionymToggle.getValue());

        Boolean withValidationSection = BooleanUtils.isTrue(validationToggle.getValue());

        Boolean withOrthographicCorrectionSection = BooleanUtils.isTrue(orthographicVariantToggle.getValue());

        if(isModeEnabled(TaxonNamePopupEditorMode.VALIDATE_AGAINST_HIGHER_NAME_PART)){

            if(isSpeciesOrBelow) {

                if(TextField.class.isAssignableFrom(genusOrUninomialField.getClass())){

                    WeaklyRelatedEntityCombobox<TaxonName> combobox = new WeaklyRelatedEntityCombobox<TaxonName>("-> this caption will be replaced <-", TaxonName.class);

                    combobox.addClickListenerAddEntity(e -> getViewEventBus().publish(

                            this,

                            new TaxonNameEditorActionStrRep(

                                    EditorActionType.ADD,

                                    e.getButton(),

                                    combobox,

                                    this)

                        ));

                    combobox.addClickListenerEditEntity(e -> {

                        //WeaklyRelatedEntityCombobox<TaxonName> wrcbbx = combobox;

                        if(combobox.getValue() != null){

                            getViewEventBus().publish(this,

                                new TaxonNameEditorActionStrRep(

                                        EditorActionType.EDIT,

                                        combobox.getIdForValue(),

                                        e.getButton(),

                                        combobox,

                                        this)

                            );

                        }

                    });

                    combobox.getSelect().setRequiredError(UIMessages.REQUIRED_SELECT_MISSING);

                    genusOrUninomialField = replaceComponent("genusOrUninomial", genusOrUninomialField, combobox, 0, genusOrUninomialRow, 1, genusOrUninomialRow);

                }

            } else {