Package org.dspace.discovery.indexobject

Class CommunityIndexFactoryImpl

java.lang.Object

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

org.dspace.discovery.indexobject.DSpaceObjectIndexFactoryImpl<IndexableCommunity,Community>

org.dspace.discovery.indexobject.CommunityIndexFactoryImpl

All Implemented Interfaces:

CommunityIndexFactory, DSpaceObjectIndexFactory<IndexableCommunity,Community>, IndexFactory<IndexableCommunity,Community>

public class CommunityIndexFactoryImpl
extends DSpaceObjectIndexFactoryImpl<IndexableCommunity,Community>
implements CommunityIndexFactory

Factory implementation for indexing/retrieving communities in the search core

Author:

Kevin Van de Velde (kevin at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
protected CommunityService	communityService

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

solrSearchCore, solrServiceIndexPlugins

Constructor Summary

Constructors

Constructor	Description
CommunityIndexFactoryImpl()

Method Summary

Modifier and Type	Method	Description
org.apache.solr.common.SolrInputDocument	buildDocument(Context context, IndexableCommunity indexableObject)	Create solr document with all the shared fields initialized.
Iterator<IndexableCommunity>	findAll(Context context)	Retrieve all instances of a certain indexable object type
Optional<IndexableCommunity>	findIndexableObject(Context context, String id)	Retrieve a single indexable object using the provided identifier
List	getIndexableObjects(Context context, Community object)	Retrieve all the indexable objects for the provided object
List<String>	getLocations(Context context, IndexableCommunity 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
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, buildNewDocument, 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

buildNewDocument, delete, delete, deleteAll, writeDocument

Field Details

communityService

@Autowired(required=true)
protected CommunityService communityService

Constructor Details

CommunityIndexFactoryImpl

public CommunityIndexFactoryImpl()

Method Details

findAll

public Iterator<IndexableCommunity> 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<IndexableCommunity,Community>

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<IndexableCommunity,Community>

Returns:

a string containing the type

buildDocument

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

Description copied from interface: IndexFactory

Create solr document with all the shared fields initialized.

Specified by:

buildDocument in interface IndexFactory<IndexableCommunity,Community>

Overrides:

buildDocument in class DSpaceObjectIndexFactoryImpl<IndexableCommunity,Community>

indexableObject - the indexableObject that we want to index

Returns:

initialized solr document

Throws:

SQLException

IOException

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<IndexableCommunity,Community>

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

Description copied from interface: IndexFactory

Retrieve all the indexable objects for the provided object

Specified by:

getIndexableObjects in interface IndexFactory<IndexableCommunity,Community>

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<IndexableCommunity> 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<IndexableCommunity,Community>

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,
 IndexableCommunity 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<IndexableCommunity,Community>

Parameters:

context - DSpace context object

Returns:

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

Throws:

SQLException - If database error