org.dspace.content.virtual.Concatenate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
The newest version!
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.content.virtual;

import java.util.LinkedList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.dspace.content.Item;
import org.dspace.content.MetadataValue;
import org.dspace.content.service.ItemService;
import org.dspace.core.Context;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * A bean implementing the {@link VirtualMetadataConfiguration} interface to achieve the generation of Virtual
 * metadata
 * The Concatenate bean will take all the values of each metadata field configured in the list
 * and it will join all of these together with the separator defined in this bean. This means that whichever
 * entry this bean belongs to, that metadata field will have the value of the related item's metadata values
 * joined together with this separator. Only one value will be returned
 */
public class Concatenate implements VirtualMetadataConfiguration {

    @Autowired
    private ItemService itemService;

    /**
     * The fields for which the metadata will be retrieved
     */
    private List fields;
    /**
     * The separator that will be used to concatenate the values retrieved from the above mentioned fields
     */
    private String separator;

    /**
     * The boolean value indicating whether this field should be used for place or not
     */
    private boolean useForPlace = false;

    private boolean populateWithNameVariant = false;
    /**
     * Generic getter for the fields property
     * @return The list of fields to be used in this bean
     */
    public List getFields() {
        return fields;
    }

    /**
     * Generic setter for the fields property
     * @param fields    the list of fields to which the fields property will be set to
     */
    public void setFields(List fields) {
        this.fields = fields;
    }

    /**
     * Generic getter for the separator
     * @return the separator to be used by this bean
     */
    public String getSeparator() {
        return separator;
    }

    /**
     * Generic setter for the separator property
     * @param separator The String separator value to which this separator value will be set to
     */
    public void setSeparator(String separator) {
        this.separator = separator;
    }

    /**
     * Generic setter for the useForPlace property
     * @param useForPlace   The boolean value that the useForPlace property will be set to
     */
    @Override
    public void setUseForPlace(boolean useForPlace) {
        this.useForPlace = useForPlace;
    }

    /**
     * Generic getter for the useForPlace property
     * @return  The useForPlace to be used by this bean
     */
    @Override
    public boolean getUseForPlace() {
        return useForPlace;
    }

    @Override
    public void setPopulateWithNameVariant(boolean populateWithNameVariant) {
        this.populateWithNameVariant = populateWithNameVariant;
    }

    @Override
    public boolean getPopulateWithNameVariant() {
        return populateWithNameVariant;
    }

    /**
     * this method will retrieve the metadata values from the given item for all the metadata fields listed
     * in the fields property and it'll concatenate all those values together with the separator specified
     * in this class
     * @param context   The relevant DSpace context
     * @param item      The item that will be used to either retrieve metadata values from
     * @return The String value for all of the retrieved metadatavalues combined with the separator
     */
    @Override
    public List getValues(Context context, Item item) {

        List resultValues = new LinkedList<>();
        List value = this.getFields();
        for (String s : value) {
            String[] splittedString = s.split("\\.");

            List resultList = itemService.getMetadata(item,
                                                                     splittedString.length > 0 ? splittedString[0] :
                                                                         null,
                                                                     splittedString.length > 1 ? splittedString[1] :
                                                                         null,
                                                                     splittedString.length > 2 ? splittedString[2] :
                                                                         null,
                                                                     Item.ANY, false);

            String resultString = "";
            for (int i = 0; i < resultList.size(); i++) {
                String metadataValueString = resultList.get(i).getValue();
                if (StringUtils.isNotBlank(metadataValueString)) {
                    if (StringUtils.isNotBlank(resultString)) {
                        resultString += this.getSeparator();
                    }
                    resultString += metadataValueString;
                }
            }
            if (StringUtils.isNotBlank(resultString)) {
                resultValues.add(resultString);
            }
        }

        String result = StringUtils.join(resultValues, this.getSeparator());
        List listToReturn = new LinkedList<>();
        listToReturn.add(result);
        return listToReturn;
    }

}