Package org.dspace.discovery.indexobject

Class CollectionIndexFactoryImpl

java.lang.Object

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

org.dspace.discovery.indexobject.DSpaceObjectIndexFactoryImpl<IndexableCollection,Collection>

org.dspace.discovery.indexobject.CollectionIndexFactoryImpl

All Implemented Interfaces:

CollectionIndexFactory, DSpaceObjectIndexFactory<IndexableCollection,Collection>, IndexFactory<IndexableCollection,Collection>

public class CollectionIndexFactoryImpl
extends DSpaceObjectIndexFactoryImpl<IndexableCollection,Collection>
implements CollectionIndexFactory

Factory implementation for indexing/retrieving collections in the search core

Author:

Kevin Van de Velde (kevin at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionService	collectionService
protected CommunityService	communityService

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

solrSearchCore, solrServiceIndexPlugins

Constructor Summary

Constructors

Constructor	Description
CollectionIndexFactoryImpl()

Method Summary

Modifier and Type	Method	Description
org.apache.solr.common.SolrInputDocument	buildDocument(Context context, IndexableCollection indexableCollection)	Build a solr document for a DSpace Collection.
Iterator<IndexableCollection>	findAll(Context context)	Retrieve all instances of a certain indexable object type
Optional<IndexableCollection>	findIndexableObject(Context context, String id)	Retrieve a single indexable object using the provided identifier
List<String>	getCollectionLocations(Context context, Collection collection)	Return a list of the identifiers of the owning communities from the provided collection prepended by "m"
List	getIndexableObjects(Context context, Collection object)	Retrieve all the indexable objects for the provided object
List<String>	getLocations(Context context, IndexableCollection indexableCollection)	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
boolean	supports(Object object)	Determine whether the class can handle the factory implementation

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

addContainerMetadataField, storeCommunityCollectionLocations

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

addFacetIndex, addFacetIndex, addNamedResourceTypeIndex, delete, delete, deleteAll, writeDocument, 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

delete, delete, deleteAll, writeDocument

Field Detail

collectionService

@Autowired
protected CollectionService collectionService

communityService

@Autowired
protected CommunityService communityService

Constructor Detail

CollectionIndexFactoryImpl

public CollectionIndexFactoryImpl()

Method Detail

findAll

public Iterator<IndexableCollection> 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<IndexableCollection,Collection>

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<IndexableCollection,Collection>

Returns:

a string containing the type

buildDocument

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

Build a solr document for a DSpace Collection.

Specified by:

buildDocument in interface IndexFactory<IndexableCollection,Collection>

Overrides:

buildDocument in class DSpaceObjectIndexFactoryImpl<IndexableCollection,Collection>

Parameters:

context - The relevant DSpace Context.

indexableCollection - indexableCollection to be indexed

Returns:

initialized solr document

Throws:

SQLException - sql exception

IOException - IO exception

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<IndexableCollection,Collection>

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,
                                Collection object)

Description copied from interface: IndexFactory

Retrieve all the indexable objects for the provided object

Specified by:

getIndexableObjects in interface IndexFactory<IndexableCollection,Collection>

Parameters:

context - DSpace context object

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

Returns:

A list of indexable objects

findIndexableObject

public Optional<IndexableCollection> 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<IndexableCollection,Collection>

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

getLocations

public List<String> getLocations(Context context,
                                 IndexableCollection indexableCollection)
                          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<IndexableCollection,Collection>

Parameters:

context - DSpace context object

Returns:

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

Throws:

SQLException - If database error

getCollectionLocations

public List<String> getCollectionLocations(Context context,
                                           Collection collection)
                                    throws SQLException

Description copied from interface: CollectionIndexFactory

Return a list of the identifiers of the owning communities from the provided collection prepended by "m"

Specified by:

getCollectionLocations in interface CollectionIndexFactory

Parameters:

context - DSpace context object

collection - DSpace collection

Returns:

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

Throws:

SQLException - If database error