Package org.dspace.discovery.indexobject

Class ItemIndexFactoryImpl

java.lang.Object

org.dspace.discovery.indexobject.IndexFactoryImpl<T,S>

org.dspace.discovery.indexobject.DSpaceObjectIndexFactoryImpl<IndexableItem,Item>

org.dspace.discovery.indexobject.ItemIndexFactoryImpl

All Implemented Interfaces:

DSpaceObjectIndexFactory<IndexableItem,Item>, IndexFactory<IndexableItem,Item>, ItemIndexFactory

public class ItemIndexFactoryImpl
extends DSpaceObjectIndexFactoryImpl<IndexableItem,Item>
implements ItemIndexFactory

Factory implementation for indexing/retrieving items in the search core

Author:

Kevin Van de Velde (kevin at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorityValueService	authorityValueService
protected ChoiceAuthorityService	choiceAuthorityService
protected HandleService	handleService
protected ItemService	itemService
protected MetadataAuthorityService	metadataAuthorityService
static String	STATUS_FIELD
static String	STATUS_FIELD_PREDB
static String	STORE_SEPARATOR
static String	VARIANTS_STORE_SEPARATOR
protected VersionHistoryService	versionHistoryService
protected WorkflowItemIndexFactory	workflowItemIndexFactory
protected WorkspaceItemIndexFactory	workspaceItemIndexFactory
protected WorkspaceItemService	workspaceItemService
protected XmlWorkflowItemService	xmlWorkflowItemService

Fields inherited from class org.dspace.discovery.indexobject.IndexFactoryImpl

solrSearchCore, solrServiceIndexPlugins

Constructor Summary

Constructors

Constructor	Description
ItemIndexFactoryImpl()

Method Summary

Modifier and Type	Method	Description
void	addDiscoveryFields(org.apache.solr.common.SolrInputDocument doc, Context context, Item item, List<DiscoveryConfiguration> discoveryConfigurations)	Store item fields in the solr document
org.apache.solr.common.SolrInputDocument	buildDocument(Context context, IndexableItem indexableItem)	Build a Solr document for a DSpace Item and write the index
org.apache.solr.common.SolrInputDocument	buildNewDocument(Context context, IndexableItem indexableItem)	Create solr document with all the shared fields initialized.
void	delete(String indexableObjectIdentifier)	Remove the provided indexable object from the solr core
void	delete(IndexableItem indexableObject)	Remove the provided indexable object from the solr core
Iterator<IndexableItem>	findAll(Context context)	Retrieve all instances of a certain indexable object type
Optional<IndexableItem>	findIndexableObject(Context context, String id)	Retrieve a single indexable object using the provided identifier
List	getIndexableObjects(Context context, Item item)	Retrieve all the indexable objects for the provided object
List<String>	getLocations(Context context, IndexableItem indexableDSpaceObject)	Return a list of the identifiers from the parents for the provided IndexableObject, communities will be prepended by "m", collections b "c"
String	getType()	Return the type of the indexable object
protected boolean	isLatestVersion(Context context, Item item)	Check whether the given item is the latest version.
boolean	supports(Object object)	Determine whether the class can handle the factory implementation
void	writeDocument(Context context, IndexableItem indexableObject, org.apache.solr.common.SolrInputDocument solrInputDocument)	Write the provided document to the solr core

Methods inherited from class org.dspace.discovery.indexobject.DSpaceObjectIndexFactoryImpl

addContainerMetadataField, storeCommunityCollectionLocations

Methods inherited from class org.dspace.discovery.indexobject.IndexFactoryImpl

addFacetIndex, addFacetIndex, addNamedResourceTypeIndex, deleteAll, writeDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.discovery.indexobject.factory.DSpaceObjectIndexFactory

storeCommunityCollectionLocations

Methods inherited from interface org.dspace.discovery.indexobject.factory.IndexFactory

deleteAll

Field Detail

VARIANTS_STORE_SEPARATOR

public static final String VARIANTS_STORE_SEPARATOR

See Also:

Constant Field Values

STORE_SEPARATOR

public static final String STORE_SEPARATOR

See Also:

Constant Field Values

STATUS_FIELD

public static final String STATUS_FIELD

See Also:

Constant Field Values

STATUS_FIELD_PREDB

public static final String STATUS_FIELD_PREDB

See Also:

Constant Field Values

handleService

@Autowired
protected HandleService handleService

itemService

@Autowired
protected ItemService itemService

choiceAuthorityService

@Autowired(required=true)
protected ChoiceAuthorityService choiceAuthorityService

authorityValueService

@Autowired(required=true)
protected AuthorityValueService authorityValueService

metadataAuthorityService

@Autowired
protected MetadataAuthorityService metadataAuthorityService

workspaceItemService

@Autowired
protected WorkspaceItemService workspaceItemService

xmlWorkflowItemService

@Autowired
protected XmlWorkflowItemService xmlWorkflowItemService

workflowItemIndexFactory

@Autowired
protected WorkflowItemIndexFactory workflowItemIndexFactory

workspaceItemIndexFactory

@Autowired
protected WorkspaceItemIndexFactory workspaceItemIndexFactory

versionHistoryService

@Autowired
protected VersionHistoryService versionHistoryService

Constructor Detail

ItemIndexFactoryImpl

public ItemIndexFactoryImpl()

Method Detail

findAll

public Iterator<IndexableItem> findAll(Context context)
                                throws SQLException

Description copied from interface: IndexFactory

Retrieve all instances of a certain indexable object type

Specified by:

findAll in interface IndexFactory<IndexableItem,Item>

Parameters:

context - DSpace context object

Returns:

An iterator containing all the objects to be indexed for the indexable object

Throws:

SQLException - If database error

getType

public String getType()

Description copied from interface: IndexFactory

Return the type of the indexable object

Specified by:

getType in interface IndexFactory<IndexableItem,Item>

Returns:

a string containing the type

buildDocument

public org.apache.solr.common.SolrInputDocument buildDocument(Context context,
                                                              IndexableItem indexableItem)
                                                       throws SQLException,
                                                              IOException

Build a Solr document for a DSpace Item and write the index

Specified by:

buildDocument in interface IndexFactory<IndexableItem,Item>

Overrides:

buildDocument in class DSpaceObjectIndexFactoryImpl<IndexableItem,Item>

Parameters:

context - Users Context

indexableItem - The IndexableItem Item to be indexed

Returns:

initialized solr document

Throws:

SQLException - if database error

IOException - if IO error

isLatestVersion

protected boolean isLatestVersion(Context context,
                                  Item item)
                           throws SQLException

Check whether the given item is the latest version. If the latest item cannot be determined, because either the version history or the latest version is not present, assume the item is latest.

Parameters:

context - the DSpace context.

item - the item that should be checked.

Returns:

true if the item is the latest version, false otherwise.

Throws:

SQLException

buildNewDocument

public org.apache.solr.common.SolrInputDocument buildNewDocument(Context context,
                                                                 IndexableItem indexableItem)
                                                          throws SQLException,
                                                                 IOException

Description copied from interface: IndexFactory

Create solr document with all the shared fields initialized. Can contain special fields required for "new" documents vs regular buildDocument

Specified by:

buildNewDocument in interface IndexFactory<IndexableItem,Item>

Overrides:

buildNewDocument in class IndexFactoryImpl<IndexableItem,Item>

indexableItem - the indexableObject that we want to index

Returns:

initialized solr document

Throws:

SQLException

IOException

addDiscoveryFields

public void addDiscoveryFields(org.apache.solr.common.SolrInputDocument doc,
                               Context context,
                               Item item,
                               List<DiscoveryConfiguration> discoveryConfigurations)
                        throws SQLException,
                               IOException

Description copied from interface: ItemIndexFactory

Store item fields in the solr document

Specified by:

addDiscoveryFields in interface ItemIndexFactory

Parameters:

doc - Solr input document which will be written to our discovery solr core

context - DSpace context object

item - Item for which we want to index our fields in the provided solr document

discoveryConfigurations - The discovery configuration which holds information for which item fields we should index

Throws:

SQLException - If database error

IOException - If IO error

writeDocument

public void writeDocument(Context context,
                          IndexableItem indexableObject,
                          org.apache.solr.common.SolrInputDocument solrInputDocument)
                   throws SQLException,
                          IOException,
                          org.apache.solr.client.solrj.SolrServerException

Description copied from interface: IndexFactory

Write the provided document to the solr core

Specified by:

writeDocument in interface IndexFactory<IndexableItem,Item>

Overrides:

writeDocument in class IndexFactoryImpl<IndexableItem,Item>

Parameters:

context - DSpace context object

indexableObject - The indexable object that we want to store in the search core

solrInputDocument - Solr input document which will be written to our discovery search core

Throws:

SQLException - If database error

IOException - If IO error

org.apache.solr.client.solrj.SolrServerException - If the solr document could not be written to the search core

getLocations

public List<String> getLocations(Context context,
                                 IndexableItem indexableDSpaceObject)
                          throws SQLException

Description copied from interface: DSpaceObjectIndexFactory

Return a list of the identifiers from the parents for the provided IndexableObject, communities will be prepended by "m", collections b "c"

Specified by:

getLocations in interface DSpaceObjectIndexFactory<IndexableItem,Item>

Parameters:

context - DSpace context object

Returns:

A list of community identifiers with "m" prepended to every one

Throws:

SQLException - If database error

delete

public void delete(IndexableItem indexableObject)
            throws IOException,
                   org.apache.solr.client.solrj.SolrServerException

Description copied from interface: IndexFactory

Remove the provided indexable object from the solr core

Specified by:

delete in interface IndexFactory<IndexableItem,Item>

Overrides:

delete in class IndexFactoryImpl<IndexableItem,Item>

Parameters:

indexableObject - The indexable object that we want to remove from the search core

Throws:

IOException - If IO error

org.apache.solr.client.solrj.SolrServerException - If the solr document could not be removed to the search core

delete

public void delete(String indexableObjectIdentifier)
            throws IOException,
                   org.apache.solr.client.solrj.SolrServerException

Description copied from interface: IndexFactory

Remove the provided indexable object from the solr core

Specified by:

delete in interface IndexFactory<IndexableItem,Item>

Overrides:

delete in class IndexFactoryImpl<IndexableItem,Item>

Parameters:

indexableObjectIdentifier - The identifier that we want to remove from the search core

Throws:

IOException - If IO error

org.apache.solr.client.solrj.SolrServerException - If the solr document could not be removed to the search core

supports

public boolean supports(Object object)

Description copied from interface: IndexFactory

Determine whether the class can handle the factory implementation

Specified by:

supports in interface IndexFactory<IndexableItem,Item>

Parameters:

object - The object which we want to check

Returns:

True if the factory implementation can handle the given object. False if it doesn't.

getIndexableObjects

public List getIndexableObjects(Context context,
                                Item item)
                         throws SQLException

Description copied from interface: IndexFactory

Retrieve all the indexable objects for the provided object

Specified by:

getIndexableObjects in interface IndexFactory<IndexableItem,Item>

Parameters:

context - DSpace context object

item - The object we want to retrieve our indexable objects for

Returns:

A list of indexable objects

Throws:

SQLException - If database error

findIndexableObject

public Optional<IndexableItem> findIndexableObject(Context context,
                                                   String id)
                                            throws SQLException

Description copied from interface: IndexFactory

Retrieve a single indexable object using the provided identifier

Specified by:

findIndexableObject in interface IndexFactory<IndexableItem,Item>

Parameters:

context - DSpace context object

id - The identifier for which we want to retrieve our indexable object

Returns:

An indexable object

Throws:

SQLException - If database error