Package org.dspace.content.virtual

Class Concatenate

java.lang.Object
org.dspace.content.virtual.Concatenate
All Implemented Interfaces:
VirtualMetadataConfiguration
public class Concatenate extends Object implements VirtualMetadataConfiguration
A bean implementing the 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    Concatenate()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getFields()
    Generic getter for the fields property
    boolean
    getPopulateWithNameVariant()
    Generic getter for the populateWithNameVariant property
    String
    getSeparator()
    Generic getter for the separator
    boolean
    getUseForPlace()
    Generic getter for the useForPlace property
    List<String>
    getValues(Context context, Item item)
    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
    void
    setFields(List<String> fields)
    Generic setter for the fields property
    void
    setPopulateWithNameVariant(boolean populateWithNameVariant)
    Generic setter for the populateWithNameVariant This property defines whether the value should be retrieved from the left/rightward on the Relationship (true) or through the configuration and usual way (false)
    void
    setSeparator(String separator)
    Generic setter for the separator property
    void
    setUseForPlace(boolean useForPlace)
    Generic setter for the useForPlace property

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Concatenate

      public Concatenate()

  • Method Details

    • getFields

      public List<String> getFields()
      Generic getter for the fields property
      Returns:
      The list of fields to be used in this bean

    • setFields

      public void setFields(List<String> fields)
      Generic setter for the fields property
      Parameters:
      fields - the list of fields to which the fields property will be set to

    • getSeparator

      public String getSeparator()
      Generic getter for the separator
      Returns:
      the separator to be used by this bean

    • setSeparator

      public void setSeparator(String separator)
      Generic setter for the separator property
      Parameters:
      separator - The String separator value to which this separator value will be set to

    • setUseForPlace

      public void setUseForPlace(boolean useForPlace)
      Generic setter for the useForPlace property
      Specified by:
      setUseForPlace in interface VirtualMetadataConfiguration
      Parameters:
      useForPlace - The boolean value that the useForPlace property will be set to

    • getUseForPlace

      public boolean getUseForPlace()
      Generic getter for the useForPlace property
      Specified by:
      getUseForPlace in interface VirtualMetadataConfiguration
      Returns:
      The useForPlace to be used by this bean

    • setPopulateWithNameVariant

      public void setPopulateWithNameVariant(boolean populateWithNameVariant)
      Description copied from interface: VirtualMetadataConfiguration
      Generic setter for the populateWithNameVariant This property defines whether the value should be retrieved from the left/rightward on the Relationship (true) or through the configuration and usual way (false)
      Specified by:
      setPopulateWithNameVariant in interface VirtualMetadataConfiguration
      Parameters:
      populateWithNameVariant - The boolean value that the populateWithNameVariant property will be set to

    • getPopulateWithNameVariant

      public boolean getPopulateWithNameVariant()
      Description copied from interface: VirtualMetadataConfiguration
      Generic getter for the populateWithNameVariant property
      Specified by:
      getPopulateWithNameVariant in interface VirtualMetadataConfiguration
      Returns:
      The populatewithNameVariant to be used by this bean

    • getValues

      public List<String> getValues(Context context, Item item)
      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
      Specified by:
      getValues in interface VirtualMetadataConfiguration
      Parameters:
      context - The relevant DSpace context
      item - The item that will be used to either retrieve metadata values from
      Returns:
      The String value for all of the retrieved metadatavalues combined with the separator