Package org.dspace.xoai.app.plugins

Class AccessStatusElementItemCompilePlugin

java.lang.Object

org.dspace.xoai.app.plugins.AccessStatusElementItemCompilePlugin

All Implemented Interfaces:

XOAIExtensionItemCompilePlugin

public class AccessStatusElementItemCompilePlugin
extends Object
implements XOAIExtensionItemCompilePlugin

AccessStatusElementItemCompilePlugin aims to add structured information about the Access Status of the item (if any). The xoai document will be enriched with a structure like that

 
   <element name="others">
       <element name="access-status">
          <field name="value">open.access</field>
       </element>
   </element>
   OR
   <element name="others">
       <element name="access-status">
          <field name="value">embargo</field>
          <field name="embargo">2024-10-10</field>
       </element>
   </element>
 
 

Returning Values are based on:

See Also:

DefaultAccessStatusHelper

Constructor Summary

Constructors

Constructor	Description
AccessStatusElementItemCompilePlugin()

Method Summary

Modifier and Type	Method	Description
com.lyncode.xoai.dataprovider.xml.xoai.Metadata	additionalMetadata(Context context, com.lyncode.xoai.dataprovider.xml.xoai.Metadata metadata, Item item)	This method allows plugins to add content to the xoai document generated for the item.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessStatusElementItemCompilePlugin

public AccessStatusElementItemCompilePlugin()

Method Detail

additionalMetadata

public com.lyncode.xoai.dataprovider.xml.xoai.Metadata additionalMetadata(Context context,
                                                                          com.lyncode.xoai.dataprovider.xml.xoai.Metadata metadata,
                                                                          Item item)

Description copied from interface: XOAIExtensionItemCompilePlugin

This method allows plugins to add content to the xoai document generated for the item.

Specified by:

additionalMetadata in interface XOAIExtensionItemCompilePlugin

Parameters:

context - the DSpace Context

metadata - the basic xoai representation of the item that can be manipulated by the plugin

item - the dspace item to index

Returns:

the altered xoai metadata