Package org.dspace.content.virtual

Class Collected

java.lang.Object
org.dspace.content.virtual.Collected
All Implemented Interfaces:
VirtualMetadataConfiguration
public class Collected extends Object implements VirtualMetadataConfiguration
A bean implementing the VirtualMetadataConfiguration interface to achieve the generation of Virtual metadata The Collected bean will take all the values of each metadata field defined in the list and it'll create a list of virtual metadata fields defined by the map in which it's defined. All values from the metadata fields will returned as separate elements

  • Constructor Summary

    Constructors
    Constructor
    Description
    Collected()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getFields()
    Generic getter for the fields property
    boolean
    getPopulateWithNameVariant()
    Generic getter for the populateWithNameVariant property
    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 return all those values as a list
    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
    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

    • Collected

      public Collected()

  • 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

    • 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 return all those values as a list
      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 values for all of the retrieved metadatavalues