EDIT

        CdmFilterablePagingProvider<Reference,Reference> pagingProvider = new CdmFilterablePagingProvider<Reference, Reference>(

                repo.getReferenceService(), MatchMode.ANYWHERE, referenceOrderHints);

        return pagingProvider;

    }

    public TypifiedEntityFilterablePagingProvider<Reference> referenceEntityReferencePagingProvider(ReferenceLabelProvider labelProvider, List<String> initStrategy){

        List<OrderHint> referenceOrderHints = new ArrayList<OrderHint>();

        referenceOrderHints.add(OrderHint.ORDER_BY_TITLE_CACHE);

        referenceOrderHints.add(new OrderHint("issn", SortOrder.ASCENDING));

        referenceOrderHints.add(new OrderHint("isbn", SortOrder.ASCENDING));

        TypifiedEntityFilterablePagingProvider<Reference> pagingProvider = new TypifiedEntityFilterablePagingProvider<Reference>(

                repo.getReferenceService(), MatchMode.ANYWHERE, referenceOrderHints, labelProvider);

        pagingProvider.setInitStrategy(initStrategy);

        return pagingProvider;

/**

* Copyright (C) 2018 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.service;

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

/**

 * @author a.kohlbecker

 * @since Dec 12, 2018

 *

 */

public interface ComboboxLabelProvider<T extends CdmBase> {

    public String composeLabel(T entity, String filterString);

}

/**

* Copyright (C) 2018 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.service;

import java.util.Arrays;

import java.util.List;

import java.util.StringTokenizer;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

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

/**

 * Creates truncated labels for references by applying ellypsis on the reference authors and title for inReferences an

 * ellypsis is also being created.

 * <p>

 * Here are some examples:

 * <table>

 * <th>

 *  <td>original</td>

 *  <td>ellypsis</td></th>

 * <tr>

 * </tr>

 * <td>

 *   <td>Gottschling, M., Tillmann, U., Kusber, W.-H. & al., A Gordian knot: Nomenclature and taxonomy of Heterocapsa triquetra (Peridiniales: Heterocapsaceae) in Taxon 67(1): 179–185. 2018<td>

 *   </td>Gottschling, M.,…Kusber…, A Gordian knot:… in Taxon 67(1): 179–185. 2018</td>

 *   </tr>

 * <td>

 *   <td>Hamilton, P.B., Stachura-Suchoples, K., Kusber, W.-H. & al., Typification of the puzzling large diatom species Neidium iridis Ehrenb. in Cryptog. Algol.<td>

 *   </td>Hamilton, P.B.,…Kusber…, Typification of the… in Cryptog. Algol.</td>

 * </tr>

 * <td>

 * <td>Jahn , R., Kusber, W.-H. & Cocquyt, C., Differentiating Iconella from Surirella (Bacillariophyceae): typifying four Ehrenberg names and a preliminary checklist of the African taxa in PhytoKeys 82: 73-112<td>

 * </td>Jahn , R., Kusber, W.-H. & Cocquyt, C., Differentiating… in PhytoKeys 82: 73-112</td>

 * </tr>

 * <td>

 * <td>Jahn, R., Kusber, W.-H., Skibbe, O. & al., Gomphonella olivacea (Hornemann) Rabenhorst – a new phylogenetic position for a well-known taxon, its typification, new species and combinations in Cryptog. Algol.<td>

 * </td>Jahn, R., Kusber,…, Gomphonella olivacea… in Cryptog. Algol.</td>

 * </td>

 * </table>

 * @author a.kohlbecker

 * @since Dec 12, 2018

 *

 */

public class ReferenceLabelProvider implements ComboboxLabelProvider<Reference> {

    private static final String DELIM = " ";

    /**

     * This init strategy should be used when the ReferenceLabelProvider is being used

     * outside of a hibernate session

     */

    public static List<String> INIT_STRATEGY = Arrays.asList(

            "authorship",

            "inReference.authorship",

            "inReference.inReference.authorship",

            "inReference.inReference.inReference");

    public enum LabelType {

        NOMENCLATURAL,

        BIBLIOGRAPHIC;

    }

    private LabelType labelType;

    private int maxAuthorCharsVisible = 20;

    private int maxTitleCharsVisible = 20;

    private String MORE = "\u2026"; // 'HORIZONTAL ELLIPSIS' (U+2026)

    public ReferenceLabelProvider(LabelType labelType){

        this.labelType = labelType;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public String composeLabel(Reference entity, String filterString) {

        EllipsisData ed = ellypsis(entity, filterString);

        String label = ed.truncated;

        return label;

    }

    /**

     * @param entity

     * @param filterString

     * @return

     */

    public EllipsisData ellypsis(Reference entity, String filterString) {

        String label = "";

        String authors = entity.getAuthorship() != null ? entity.getAuthorship().getTitleCache() : "";

        String title = null;

        String titleCache;

        switch(labelType){

            case NOMENCLATURAL:

                if(!entity.isProtectedAbbrevTitleCache()){

                    title = entity.getAbbrevTitle();

                    if(title == null) {

                        // fallback to use the title

                        title = entity.getTitle();

                    }

                }

                titleCache = entity.getAbbrevTitleCache();

                break;

            case BIBLIOGRAPHIC:

            default:

                if(!entity.isProtectedTitleCache()){

                    title = entity.getTitle();

                    if(title == null) {

                        // fallback to use the abbreviated title

                        title = entity.getAbbrevTitle();

                    }

                }

                titleCache = entity.getTitleCache();

                break;

        }

        Pattern pattern = Pattern.compile("(" + filterString +")", Pattern.CASE_INSENSITIVE);

        if(authors != null){

            String authorsEllipsed = authors;

            if(authorsEllipsed.length() > maxAuthorCharsVisible) {

                authorsEllipsed = applyEllipsis(authors, maxAuthorCharsVisible);

                authorsEllipsed = preserveFilterstring(filterString, authors, pattern, authorsEllipsed);

            }

            label = titleCache.replace(authors, authorsEllipsed);

        }

        if(title != null){

            String titleEllipsed = title;

            if(titleEllipsed.length() > maxTitleCharsVisible) {

                titleEllipsed = applyEllipsis(title, maxTitleCharsVisible);

                titleEllipsed = preserveFilterstring(filterString, title, pattern, titleEllipsed);

            }

            label = label.replace(title, titleEllipsed);

        }

        if(entity.getInReference() != null){

            EllipsisData inRefEd = ellypsis(entity.getInReference(), filterString);

            label = label.replaceFirst(inRefEd.original, inRefEd.truncated);

        }

        EllipsisData ed = new EllipsisData(titleCache, label);

        return ed;

    }

    /**

     * @param authors

     * @return

     */

    public String applyEllipsis(String text, int maxCharsVisible) {

        String ellipsedText = "";

        StringTokenizer tokenizer = new StringTokenizer(text, DELIM);

        while(tokenizer.hasMoreElements()){

            String token = tokenizer.nextToken();

            if(ellipsedText.length() + token.length() + DELIM.length() <= maxCharsVisible){

                ellipsedText = ellipsedText + (ellipsedText.isEmpty() ? "" : DELIM) + token;

            } else {

                break;

            }

        }

        return ellipsedText + MORE;

    }

    /**

     * @param filterString

     * @param authors

     * @param pattern

     * @param authorsEllipsed

     * @return

     */

    public String preserveFilterstring(String filterString, String text, Pattern pattern, String textEllipsed) {

        String matchingSubstring = null;

        if(!filterString.isEmpty()){

            Matcher m = pattern.matcher(text);

            if(m.find()){

                matchingSubstring = m.group(1);

            }

        }

        if(matchingSubstring != null && !textEllipsed.toLowerCase().contains(filterString)){

            textEllipsed += matchingSubstring + MORE;

        }

        return textEllipsed;

    }

    class EllipsisData {

        String original;

        String truncated;

        /**

         * @param original

         * @param truncated

         */

        public EllipsisData(String original, String truncated) {

            super();

            this.original = original;

            this.truncated = truncated;

        }

    }

}

/**

* Copyright (C) 2018 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.service;

import java.util.ArrayList;

import java.util.List;

import org.vaadin.viritin.fields.LazyComboBox.FilterableCountProvider;

import org.vaadin.viritin.fields.LazyComboBox.FilterablePagingProvider;

import eu.etaxonomy.cdm.api.service.IIdentifiableEntityService;

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

import eu.etaxonomy.cdm.persistence.dao.common.Restriction;

import eu.etaxonomy.cdm.persistence.query.MatchMode;

import eu.etaxonomy.cdm.persistence.query.OrderHint;

import eu.etaxonomy.cdm.ref.TypedEntityReference;

/**

 * @author a.kohlbecker

 * @since Dec 11, 2018

 *

 */

public class TypifiedEntityFilterablePagingProvider<T extends IdentifiableEntity> implements FilterablePagingProvider<TypedEntityReference<T>>, FilterableCountProvider{

    private CdmFilterablePagingProvider<T, T> entityPagingProvider;

    private ComboboxLabelProvider<T> labelProvider;

    public TypifiedEntityFilterablePagingProvider(IIdentifiableEntityService<T> service, MatchMode matchMode, List<OrderHint> orderHints, ComboboxLabelProvider<T> labelProvider){

        this.labelProvider = labelProvider;

        entityPagingProvider = new CdmFilterablePagingProvider<T, T>(service, matchMode, orderHints);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public int size(String filter) {

        return entityPagingProvider.size(filter);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public List<TypedEntityReference<T>> findEntities(int firstRow, String filter) {

        List<T> entities = entityPagingProvider.findEntities(firstRow, filter);

        List<TypedEntityReference<T>> ters = new ArrayList<>(entities.size());

        for(T e : entities){

            Class<T> type = (Class<T>)e.getClass();

            String label = labelProvider.composeLabel(e, filter);

            TypedEntityReference<T> ter = new TypedEntityReference<T>(type, e.getUuid(), label);

            ters.add(ter);

        }

        return ters;

    }

    /**

     * @param restriction

     */

    public void addRestriction(Restriction restriction) {

        entityPagingProvider.addRestriction(restriction);

    }

    /**

     * @return

     */

    public int getPageSize() {

        return entityPagingProvider.getPageSize();

    }

    /**

     * @param asList

     */

    public void setInitStrategy(List<String> initStrategy) {

        entityPagingProvider.setInitStrategy(initStrategy);

    }

}

/**

* Copyright (C) 2018 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.util;

import org.vaadin.viritin.fields.CaptionGenerator;

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

/**

 * @author a.kohlbecker

 * @since Dec 12, 2018

 *

 */

public class ReferenceCaptionGenerator implements CaptionGenerator<Reference> {

    private int authorsCharsVisible = 20;

    private int titleCharsVisible = 20;

    /**

     * {@inheritDoc}

     */

    @Override

    public String getCaption(Reference reference) {

        String title = "";

        return null;

    }

}

import eu.etaxonomy.cdm.ref.TypedEntityReference;

import eu.etaxonomy.cdm.service.ReferenceLabelProvider;

import eu.etaxonomy.cdm.service.TypifiedEntityFilterablePagingProvider;

        TypifiedEntityFilterablePagingProvider<Reference> pagingProvider =

                pagingProviderFactory.referenceEntityReferencePagingProvider(

                        new ReferenceLabelProvider(ReferenceLabelProvider.LabelType.BIBLIOGRAPHIC),

                        ReferenceLabelProvider.INIT_STRATEGY

                        );

        TypedEntityCaptionGenerator<Reference> titleCacheGenrator = new TypedEntityCaptionGenerator<Reference>();

        LazyComboBox<TypedEntityReference<Reference>> referenceCombobox = getView().getReferenceCombobox();

import eu.etaxonomy.cdm.ref.TypedEntityReference;

    LazyComboBox<TypedEntityReference<Reference>> getReferenceCombobox();

import com.vaadin.ui.AbstractSelect;

import com.vaadin.ui.ComboBox;

import eu.etaxonomy.cdm.ref.TypedEntityReference;

    private LazyComboBox<TypedEntityReference<Reference>> referenceCombobox;

        Class<TypedEntityReference<Reference>> type = (Class<TypedEntityReference<Reference>>) new TypedEntityReference<Reference>(Reference.class, null).getClass();

        referenceCombobox = new LazyComboBox<TypedEntityReference<Reference>>(type) {

            @Override

            protected void setSelectInstance(AbstractSelect select) {

                if(select instanceof ComboBox){

                    ComboBox combobox = (ComboBox)select;

                    // uncomment the below line to set a defined width for the ComboBox popup

                    // combobox.setPopupWidth("200%");

                }

                super.setSelectInstance(select);

            }

        };

                new ReferenceEditorAction(EditorActionType.REMOVE, removeNewPublicationButton, null, this)

    public LazyComboBox<TypedEntityReference<Reference>> getReferenceCombobox() {

/**

* Copyright (C) 2018 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.registration;

import org.vaadin.viritin.fields.CaptionGenerator;

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

import eu.etaxonomy.cdm.ref.TypedEntityReference;

/**

 * @author a.kohlbecker

 * @since Dec 12, 2018

 *

 */

public class TypedEntityCaptionGenerator<T extends CdmBase> implements CaptionGenerator<TypedEntityReference<T>> {

    private static final long serialVersionUID = 1312587195614966511L;

    @Override

    public String getCaption(TypedEntityReference<T> option) {

        return option.getLabel();

    }

}