Package org.dspace.content.virtual

Interface VirtualMetadataConfiguration

All Known Implementing Classes:

Collected, Concatenate, Related, UUIDValue

public interface VirtualMetadataConfiguration

This interface describes beans to be used for the VirtualMetadataPopulator implementation. The config is located in core-services.xml whilst the actual code implementation is located in ItemServiceImpl

Method Summary

Modifier and Type	Method	Description
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 return a list filled with String values which will be determine by the bean that's responsible of handling the metadata fields when fully traversed through all the Related beans
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

Method Detail

getValues

List<String> getValues(Context context,
                       Item item)
                throws SQLException

This method will return a list filled with String values which will be determine by the bean that's responsible of handling the metadata fields when fully traversed through all the Related beans

Parameters:

context - The relevant DSpace context

item - The item that will be used to either retrieve metadata values from or to find the related item through its relationships

Returns:

The list of String values of all the metadata values as constructed by the responsible bean

Throws:

SQLException - If something goes wrong

setUseForPlace

void setUseForPlace(boolean useForPlace)

Generic setter for the useForPlace property

Parameters:

useForPlace - The boolean value that the useForPlace property will be set to

getUseForPlace

boolean getUseForPlace()

Generic getter for the useForPlace property

Returns:

The useForPlace to be used by this bean

setPopulateWithNameVariant

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)

Parameters:

populateWithNameVariant - The boolean value that the populateWithNameVariant property will be set to

getPopulateWithNameVariant

boolean getPopulateWithNameVariant()

Generic getter for the populateWithNameVariant property

Returns:

The populatewithNameVariant to be used by this bean