org.dspace.authority.indexer

Class DSpaceAuthorityIndexer

java.lang.Object

org.dspace.authority.indexer.DSpaceAuthorityIndexer

All Implemented Interfaces:

AuthorityIndexerInterface, org.springframework.beans.factory.InitializingBean

public class DSpaceAuthorityIndexer
extends Object
implements AuthorityIndexerInterface, org.springframework.beans.factory.InitializingBean

DSpaceAuthorityIndexer is used in IndexClient, which is called by the AuthorityConsumer and the indexing-script.

An instance of DSpaceAuthorityIndexer is bound to a list of items. This can be one item or all items too depending on the init() method.

DSpaceAuthorityIndexer lets you iterate over each metadata value for each metadata field defined in dspace.cfg with 'authority.author.indexer.field' for each item in the list.

Author:

Antoine Snyers (antoine at atmire.com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorityValueService	authorityValueService
protected Map<String,AuthorityValue>	cache
protected ConfigurationService	configurationService
protected Context	context
protected int	currentFieldIndex
protected Item	currentItem
protected int	currentMetadataIndex
protected Iterator<Item>	itemIterator
protected ItemService	itemService
protected List<String>	metadataFields The list of metadata fields which are to be indexed *
protected AuthorityValue	nextValue
protected boolean	useCache

Constructor Summary

Constructors

Constructor and Description
DSpaceAuthorityIndexer()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	close()
boolean	hasMore()
void	init(Context context)
void	init(Context context, boolean useCache)
void	init(Context context, Item item)
protected void	initialize(Context context)
boolean	isConfiguredProperly()
AuthorityValue	nextValue()
protected void	prepareNextValue(String metadataField, MetadataValue value) This method looks at the authority of a metadata.

Methods inherited from class java.lang.Object

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

Field Detail

itemIterator

protected Iterator<Item> itemIterator

currentItem

protected Item currentItem

metadataFields

protected List<String> metadataFields

The list of metadata fields which are to be indexed *

currentFieldIndex

protected int currentFieldIndex

currentMetadataIndex

protected int currentMetadataIndex

nextValue

protected AuthorityValue nextValue

context

protected Context context

authorityValueService

@Autowired(required=true)
protected AuthorityValueService authorityValueService

itemService

@Autowired(required=true)
protected ItemService itemService

useCache

protected boolean useCache

cache

protected Map<String,AuthorityValue> cache

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

Constructor Detail

DSpaceAuthorityIndexer

public DSpaceAuthorityIndexer()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

init

public void init(Context context,
        Item item)

Specified by:

init in interface AuthorityIndexerInterface

init

public void init(Context context)

Specified by:

init in interface AuthorityIndexerInterface

init

public void init(Context context,
        boolean useCache)

Specified by:

init in interface AuthorityIndexerInterface

initialize

protected void initialize(Context context)

nextValue

public AuthorityValue nextValue()

Specified by:

nextValue in interface AuthorityIndexerInterface

hasMore

public boolean hasMore()
                throws SQLException,
                       AuthorizeException

Specified by:

hasMore in interface AuthorityIndexerInterface

Throws:

SQLException

AuthorizeException

prepareNextValue

protected void prepareNextValue(String metadataField,
                    MetadataValue value)
                         throws SQLException,
                                AuthorizeException

This method looks at the authority of a metadata. If the authority can be found in solr, that value is reused. Otherwise a new authority value will be generated that will be indexed in solr. If the authority starts with AuthorityValueGenerator.GENERATE, a specific type of AuthorityValue will be generated. Depending on the type this may involve querying an external REST service

Parameters:

metadataField - Is one of the fields defined in dspace.cfg to be indexed.

value - Is one of the values of the given metadataField in one of the items being indexed.

Throws:

SQLException - if database error

AuthorizeException - if authorization error

close

public void close()

Specified by:

close in interface AuthorityIndexerInterface

isConfiguredProperly

public boolean isConfiguredProperly()

Specified by:

isConfiguredProperly in interface AuthorityIndexerInterface