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

Class SimpleXpathMetadatumContributor

java.lang.Object

org.dspace.importer.external.metadatamapping.contributor.SimpleXpathMetadatumContributor

All Implemented Interfaces:

MetadataContributor<org.jdom2.Element>

Direct Known Subclasses:

ArXivIdMetadataContributor, AuthorMetadataContributor, PageRangeXPathMetadataContributor, PubmedAbstractMetadatumContributor, ReplaceCharacterXPathMetadataContributor, SimpleConcatContributor, SimpleMultiplePathContributor, SimpleXpathDateFormatMetadataContributor, SimpleXpathMetadatumAndAttributeContributor, WosIdentifierContributor, WosIdentifierRidContributor

public class SimpleXpathMetadatumContributor
extends Object
implements MetadataContributor<org.jdom2.Element>

Metadata contributor that takes a JDOM Element and turns it into a metadatum

Author:

Roeland Dillen (roeland at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
protected MetadataFieldConfig	field
protected MetadataFieldMapping<org.jdom2.Element,MetadataContributor<org.jdom2.Element>>	metadataFieldMapping
protected Map<String,String>	prefixToNamespaceMapping
protected String	query

Constructor Summary

Constructors

Constructor	Description
SimpleXpathMetadatumContributor()	Empty constructor for SimpleXpathMetadatumContributor
SimpleXpathMetadatumContributor(String query, Map<String,String> prefixToNamespaceMapping, MetadataFieldConfig field)	Initialize SimpleXpathMetadatumContributor with a query, prefixToNamespaceMapping and MetadataFieldConfig

Method Summary

Modifier and Type	Method	Description
Collection<MetadatumDTO>	contributeMetadata(org.jdom2.Element t)	Retrieve the metadata associated with the given object.
MetadataFieldConfig	getField()	Return the MetadataFieldConfig used while retrieving MetadatumDTO
MetadataFieldMapping<org.jdom2.Element,MetadataContributor<org.jdom2.Element>>	getMetadataFieldMapping()	Return metadataFieldMapping
Map<String,String>	getPrefixToNamespaceMapping()	Return prefixToNamespaceMapping
String	getQuery()	Return query used to create an xpathExpression on, this query is used to
void	setField(MetadataFieldConfig field)	Setting the MetadataFieldConfig
void	setMetadataFieldMapping(MetadataFieldMapping<org.jdom2.Element,MetadataContributor<org.jdom2.Element>> metadataFieldMapping)	Set the metadataFieldMapping of this SimpleXpathMetadatumContributor
void	setPrefixToNamespaceMapping(Map<String,String> prefixToNamespaceMapping)	Set the prefixToNamespaceMapping for this object,
void	setQuery(String query)

Methods inherited from class java.lang.Object

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

Field Details

field

protected MetadataFieldConfig field

metadataFieldMapping

protected MetadataFieldMapping<org.jdom2.Element,MetadataContributor<org.jdom2.Element>> metadataFieldMapping

prefixToNamespaceMapping

protected Map<String,String> prefixToNamespaceMapping

query

protected String query

Constructor Details

SimpleXpathMetadatumContributor

public SimpleXpathMetadatumContributor(String query,
 Map<String,String> prefixToNamespaceMapping,
 MetadataFieldConfig field)

Initialize SimpleXpathMetadatumContributor with a query, prefixToNamespaceMapping and MetadataFieldConfig

Parameters:

query - query string

prefixToNamespaceMapping - metadata prefix to namespace mapping

field - MetadataFieldConfig

SimpleXpathMetadatumContributor

public SimpleXpathMetadatumContributor()

Empty constructor for SimpleXpathMetadatumContributor

Method Details

getPrefixToNamespaceMapping

public Map<String,String> getPrefixToNamespaceMapping()

Return prefixToNamespaceMapping

Returns:

a prefixToNamespaceMapping map

getMetadataFieldMapping

public MetadataFieldMapping<org.jdom2.Element,MetadataContributor<org.jdom2.Element>> getMetadataFieldMapping()

Return metadataFieldMapping

Returns:

MetadataFieldMapping

setMetadataFieldMapping

public void setMetadataFieldMapping(MetadataFieldMapping<org.jdom2.Element,MetadataContributor<org.jdom2.Element>> metadataFieldMapping)

Set the metadataFieldMapping of this SimpleXpathMetadatumContributor

Specified by:

setMetadataFieldMapping in interface MetadataContributor<org.jdom2.Element>

Parameters:

metadataFieldMapping - the new mapping.

setPrefixToNamespaceMapping

public void setPrefixToNamespaceMapping(Map<String,String> prefixToNamespaceMapping)

Set the prefixToNamespaceMapping for this object,

Parameters:

prefixToNamespaceMapping - the new mapping.

getField

public MetadataFieldConfig getField()

Return the MetadataFieldConfig used while retrieving MetadatumDTO

Returns:

MetadataFieldConfig

setField

@Autowired(required=true)
public void setField(MetadataFieldConfig field)

Setting the MetadataFieldConfig

Parameters:

field - MetadataFieldConfig used while retrieving MetadatumDTO

getQuery

public String getQuery()

Return query used to create an xpathExpression on, this query is used to

Returns:

the query this instance is based on

setQuery

@Autowired(required=true)
public void setQuery(String query)

contributeMetadata

public Collection<MetadatumDTO> contributeMetadata(org.jdom2.Element t)

Retrieve the metadata associated with the given object. Depending on the retrieved node (using the query), different types of values will be added to the MetadatumDTO list

Specified by:

contributeMetadata in interface MetadataContributor<org.jdom2.Element>

Parameters:

t - An element to retrieve metadata from.

Returns:

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