Package org.dspace.importer.external.pubmed.metadatamapping.contributor

Class PubmedDateMetadatumContributor<T>

java.lang.Object

org.dspace.importer.external.pubmed.metadatamapping.contributor.PubmedDateMetadatumContributor<T>

All Implemented Interfaces:

MetadataContributor<T>

public class PubmedDateMetadatumContributor<T>
extends Object
implements MetadataContributor<T>

Pubmed specific implementation of MetadataContributor Responsible for generating a set of Date metadata from the retrieved document.

Author:

Philip Vissenaekens (philip at atmire dot com)

Constructor Summary

Constructors

Constructor	Description
PubmedDateMetadatumContributor()	Initialize an empty PubmedDateMetadatumContributor object
PubmedDateMetadatumContributor(MetadataFieldConfig field, MetadataContributor day, MetadataContributor month, MetadataContributor year)

Method Summary

Modifier and Type	Method	Description
Collection<MetadatumDTO>	contributeMetadata(T t)	Retrieve the metadata associated with the given object.
List<String>	getDateFormatsToAttempt()
MetadataContributor	getDay()	Retrieve the day from the object
MetadataFieldConfig	getField()	Return the MetadataFieldConfig used while retrieving MetadatumDTO
MetadataContributor	getMonth()	Retrieve the month from the object
MetadataContributor	getYear()	Retrieve the year from the object
void	setDateFormatsToAttempt(List<String> dateFormatsToAttempt)
void	setDay(MetadataContributor day)	Set a day (MetadataContributor) to this object
void	setField(MetadataFieldConfig field)	Setting the MetadataFieldConfig
void	setMetadataFieldMapping(MetadataFieldMapping<T,MetadataContributor<T>> metadataFieldMapping)	Set the metadatafieldMapping used in the transforming of a record to actual metadata.
void	setMonth(MetadataContributor month)	Set a month (MetadataContributor) to this object
void	setYear(MetadataContributor year)	Set a year (MetadataContributor) to this object

Methods inherited from class java.lang.Object

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

Constructor Detail

PubmedDateMetadatumContributor

public PubmedDateMetadatumContributor()

Initialize an empty PubmedDateMetadatumContributor object

PubmedDateMetadatumContributor

public PubmedDateMetadatumContributor(MetadataFieldConfig field,
                                      MetadataContributor day,
                                      MetadataContributor month,
                                      MetadataContributor year)

Parameters:

field - MetadataFieldConfig used in mapping

day - a MetadataContributor, representing a day

month - a MetadataContributor, representing a month

year - a MetadataContributor, representing a year

Method Detail

getDateFormatsToAttempt

public List<String> getDateFormatsToAttempt()

setDateFormatsToAttempt

public void setDateFormatsToAttempt(List<String> dateFormatsToAttempt)

setMetadataFieldMapping

public void setMetadataFieldMapping(MetadataFieldMapping<T,MetadataContributor<T>> metadataFieldMapping)

Set the metadatafieldMapping used in the transforming of a record to actual metadata.

Specified by:

setMetadataFieldMapping in interface MetadataContributor<T>

Parameters:

metadataFieldMapping - the new mapping.

contributeMetadata

public Collection<MetadatumDTO> contributeMetadata(T t)

Retrieve the metadata associated with the given object. The code will loop over the different dates and attempt to format them using the configured dateFormats to attempt. For each date, once a format is successful, this result is used. Make sure that dateFormatsToAttempt is configured from most restrictive to most lenient to try and get the most precise result

Specified by:

contributeMetadata in interface MetadataContributor<T>

Parameters:

t - A class to retrieve metadata from.

Returns:

a collection of import records. Only the identifier of the found records may be put in the record.

getField

public MetadataFieldConfig getField()

Return the MetadataFieldConfig used while retrieving MetadatumDTO

Returns:

MetadataFieldConfig

setField

public void setField(MetadataFieldConfig field)

Setting the MetadataFieldConfig

Parameters:

field - MetadataFieldConfig used while retrieving MetadatumDTO

getDay

public MetadataContributor getDay()

Retrieve the day from the object

Returns:

MetadataContributor, representing a day

setDay

public void setDay(MetadataContributor day)

Set a day (MetadataContributor) to this object

Parameters:

day - a MetadataContributor, representing a day

getMonth

public MetadataContributor getMonth()

Retrieve the month from the object

Returns:

MetadataContributor, representing a month

setMonth

public void setMonth(MetadataContributor month)

Set a month (MetadataContributor) to this object

Parameters:

month - a MetadataContributor, representing a month

getYear

public MetadataContributor getYear()

Retrieve the year from the object

Returns:

MetadataContributor, representing a year

setYear

public void setYear(MetadataContributor year)

Set a year (MetadataContributor) to this object

Parameters:

year - a MetadataContributor, representing a year