Uses of Interface
org.dspace.discovery.IndexableObject

Packages that use IndexableObject

Package	Description
org.dspace.app.bulkedit	The DSpace Batch Metadata Editor, which uses a CSV file to export/import item metadata.
org.dspace.app.util	Miscellaneous utility classes.
org.dspace.app.util.service
org.dspace.browse	Provides classes and methods for browsing Items in DSpace by whatever is specified in the configuration.
org.dspace.content	Provides an API for reading and manipulating content in the DSpace system.
org.dspace.content.service
org.dspace.discovery
org.dspace.discovery.configuration
org.dspace.discovery.indexobject
org.dspace.discovery.indexobject.factory
org.dspace.discovery.utils
org.dspace.subscriptions
org.dspace.subscriptions.objectupdates
org.dspace.subscriptions.service

Uses of IndexableObject in org.dspace.app.bulkedit

Methods in org.dspace.app.bulkedit that return IndexableObject

Modifier and Type	Method	Description
IndexableObject	MetadataExportSearch.resolveScope(Context context, String id)

Uses of IndexableObject in org.dspace.app.util

Methods in org.dspace.app.util with parameters of type IndexableObject

Modifier and Type	Method	Description
protected SyndicationFeed	OpenSearchServiceImpl.getResults(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)
Document	OpenSearchServiceImpl.getResultsDoc(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)
String	OpenSearchServiceImpl.getResultsString(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)
void	SyndicationFeed.populate(jakarta.servlet.http.HttpServletRequest request, Context context, IndexableObject dso, List<IndexableObject> items)	Fills in the feed and entry-level metadata from DSpace objects.

Method parameters in org.dspace.app.util with type arguments of type IndexableObject

Modifier and Type	Method	Description
protected SyndicationFeed	OpenSearchServiceImpl.getResults(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)
Document	OpenSearchServiceImpl.getResultsDoc(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)
String	OpenSearchServiceImpl.getResultsString(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)
void	SyndicationFeed.populate(jakarta.servlet.http.HttpServletRequest request, Context context, IndexableObject dso, List<IndexableObject> items)	Fills in the feed and entry-level metadata from DSpace objects.

Uses of IndexableObject in org.dspace.app.util.service

Methods in org.dspace.app.util.service with parameters of type IndexableObject

Modifier and Type	Method	Description
Document	OpenSearchService.getResultsDoc(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)	Returns a formatted set of search results as a document
String	OpenSearchService.getResultsString(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)	Returns a formatted set of search results as a string

Method parameters in org.dspace.app.util.service with type arguments of type IndexableObject

Modifier and Type	Method	Description
Document	OpenSearchService.getResultsDoc(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)	Returns a formatted set of search results as a document
String	OpenSearchService.getResultsString(Context context, String format, String query, int totalResults, int start, int pageSize, IndexableObject scope, List<IndexableObject> results)	Returns a formatted set of search results as a string

Uses of IndexableObject in org.dspace.browse

Methods in org.dspace.browse with parameters of type IndexableObject

Modifier and Type	Method	Description
void	BrowserScope.setBrowseContainer(IndexableObject dso)	Set the DSpaceObject that is the container for this browse.

Uses of IndexableObject in org.dspace.content

Methods in org.dspace.content with parameters of type IndexableObject

Modifier and Type	Method	Description
Optional<PotentialDuplicate>	DuplicateDetectionServiceImpl.validateDuplicateResult(Context context, IndexableObject indexableObject, Item original)	Validate an indexable object (returned by discovery search) to ensure it is permissible, readable and valid and can be added to a list of results.

Uses of IndexableObject in org.dspace.content.service

Methods in org.dspace.content.service with parameters of type IndexableObject

Modifier and Type	Method	Description
Optional<PotentialDuplicate>	DuplicateDetectionService.validateDuplicateResult(Context context, IndexableObject indexableObject, Item original)	Validate an indexable object (returned by discovery search) to ensure it is permissible, readable and valid and can be added to a list of results.

Uses of IndexableObject in org.dspace.discovery

Methods in org.dspace.discovery that return IndexableObject

Modifier and Type	Method	Description
protected IndexableObject	SolrServiceImpl.findIndexableObject(Context context, org.apache.solr.common.SolrDocument doc)	Find the indexable object by type and UUID
IndexableObject	DiscoverResult.IndexableObjectHighlightResult.getIndexableObject()	Return the indexable object that the highlighting snippets refer to
protected IndexableObject	DiscoverResultIterator.getNextIndexableObject()	Retrieves the next indexable object.

Methods in org.dspace.discovery that return types with arguments of type IndexableObject

Modifier and Type	Method	Description
List<IndexableObject>	DiscoverResult.getIndexableObjects()
List<IndexableObject>	SearchService.search(Context context, String query, String orderfield, boolean ascending, int offset, int max, String... filterquery)
List<IndexableObject>	SolrServiceImpl.search(Context context, String query, int offset, int max, String... filterquery)
List<IndexableObject>	SolrServiceImpl.search(Context context, String query, String orderfield, boolean ascending, int offset, int max, String... filterquery)

Methods in org.dspace.discovery with parameters of type IndexableObject

Modifier and Type	Method	Description
void	DiscoverResult.addHighlightedResult(IndexableObject dso, DiscoverResult.IndexableObjectHighlightResult highlightedResult)
void	DiscoverResult.addIndexableObject(IndexableObject idxObj)
void	SolrServiceContentInOriginalBundleFilterPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceFileInfoPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceGeospatialFilterPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceIndexAccessStatusPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceIndexCollectionSubmittersPlugin.additionalIndex(Context context, IndexableObject idxObj, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceIndexComparisonPlugin.additionalIndex(Context context, IndexableObject idxObj, org.apache.solr.common.SolrInputDocument document)	Index the normalised name of the item to a solr field
void	SolrServiceIndexItemEditorsPlugin.additionalIndex(Context context, IndexableObject idxObj, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceIndexOutputPlugin.additionalIndex(Context context, IndexableObject dso, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceIndexPlugin.additionalIndex(Context context, IndexableObject dso, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceMetadataBrowseIndexingPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceParentObjectIndexingPlugin.additionalIndex(Context context, IndexableObject idxObj, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceResourceRestrictionPlugin.additionalIndex(Context context, IndexableObject idxObj, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceSpellIndexingPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	SolrServiceSupervisionOrderIndexingPlugin.additionalIndex(Context context, IndexableObject indexableObject, org.apache.solr.common.SolrInputDocument document)
void	DiscoverResult.addSearchDocument(IndexableObject dso, DiscoverResult.SearchDocument searchDocument)
void	FacetYearRange.calculateRange(Context context, List<String> filterQueries, IndexableObject scope, SearchService searchService, DiscoverQuery parentQuery)
FacetYearRange	SearchService.getFacetYearRange(Context context, IndexableObject scope, DiscoverySearchFilterFacet facet, List<String> filterQueries, DiscoverQuery parentQuery)
FacetYearRange	SolrServiceImpl.getFacetYearRange(Context context, IndexableObject scope, DiscoverySearchFilterFacet facet, List<String> filterQueries, DiscoverQuery parentQuery)
DiscoverResult.IndexableObjectHighlightResult	DiscoverResult.getHighlightedResults(IndexableObject dso)
static String	DiscoverResult.SearchDocument.getIndexableObjectStringRepresentation(IndexableObject idxObj)
List<DiscoverResult.SearchDocument>	DiscoverResult.getSearchDocument(IndexableObject idxObj)	Returns all the sought after search document values
void	IndexingService.indexContent(Context context, IndexableObject dso)
void	IndexingService.indexContent(Context context, IndexableObject dso, boolean force)
void	IndexingService.indexContent(Context context, IndexableObject dso, boolean force, boolean commit)
void	IndexingService.indexContent(Context context, IndexableObject dso, boolean force, boolean commit, boolean preDb)	Index a given DSO
void	SolrServiceImpl.indexContent(Context context, IndexableObject dso)	If the handle for the "dso" already exists in the index, and the "dso" has a lastModified timestamp that is newer than the document in the index then it is updated, otherwise a new document is added.
void	SolrServiceImpl.indexContent(Context context, IndexableObject indexableObject, boolean force)	If the handle for the "dso" already exists in the index, and the "dso" has a lastModified timestamp that is newer than the document in the index then it is updated, otherwise a new document is added.
void	SolrServiceImpl.indexContent(Context context, IndexableObject dso, boolean force, boolean commit)
void	SolrServiceImpl.indexContent(Context context, IndexableObject indexableObject, boolean force, boolean commit, boolean preDb)
Iterator<Item>	SearchService.iteratorSearch(Context context, IndexableObject dso, DiscoverQuery query)	Convenience method to call @see #search(Context, DSpaceObject, DiscoverQuery) and getting an iterator for the results
Iterator<Item>	SolrServiceImpl.iteratorSearch(Context context, IndexableObject dso, DiscoverQuery query)
void	IndexingService.reIndexContent(Context context, IndexableObject dso)
void	SolrServiceImpl.reIndexContent(Context context, IndexableObject dso)	reIndexContent removes something from the index, then re-indexes it
DiscoverResult	SearchService.search(Context context, IndexableObject dso, DiscoverQuery query)	Convenient method to call @see #search(Context, DSpaceObject, DiscoverQuery, boolean) with includeWithdrawn=false
DiscoverResult	SolrServiceImpl.search(Context context, IndexableObject dso, DiscoverQuery discoveryQuery)
void	IndexingService.unIndexContent(Context context, IndexableObject dso)
void	IndexingService.unIndexContent(Context context, IndexableObject dso, boolean commit)
void	SolrServiceImpl.unIndexContent(Context context, IndexableObject dso)	unIndex removes an Item, Collection, or Community
void	SolrServiceImpl.unIndexContent(Context context, IndexableObject indexableObject, boolean commit)	unIndex removes an Item, Collection, or Community
protected void	SolrServiceImpl.update(Context context, IndexFactory indexableObjectService, IndexableObject indexableObject)
protected void	SolrServiceImpl.update(Context context, IndexFactory indexableObjectService, IndexableObject indexableObject, boolean preDB)	Update the given indexable object using a given service

Constructors in org.dspace.discovery with parameters of type IndexableObject

Modifier	Constructor	Description
	DiscoverResultItemIterator(Context context, IndexableObject<?,?> scopeObject, DiscoverQuery discoverQuery)	Constructs an iterator within a specific scope object.
	DiscoverResultItemIterator(Context context, IndexableObject<?,?> scopeObject, DiscoverQuery discoverQuery, int maxResults)	Constructs an iterator with a scope object and a limit on the maximum number of results.
	DiscoverResultIterator(Context context, IndexableObject<?,?> scopeObject, DiscoverQuery discoverQuery)	Constructor for scoped search without a limit on the number of results.
	DiscoverResultIterator(Context context, IndexableObject<?,?> scopeObject, DiscoverQuery discoverQuery, boolean uncacheEntities, int maxResults)	Full constructor with all options.
	IndexableObjectHighlightResult(IndexableObject idxObj, Map<String,List<String>> highlightResults)

Uses of IndexableObject in org.dspace.discovery.configuration

Methods in org.dspace.discovery.configuration with parameters of type IndexableObject

Modifier and Type	Method	Description
DiscoveryConfiguration	DiscoveryConfigurationService.getDiscoveryConfiguration(Context context, IndexableObject indexableObject)	Retrieve the discovery configuration for the provided IndexableObject.
DiscoveryConfiguration	DiscoveryConfigurationService.getDiscoveryConfigurationByNameOrIndexableObject(Context context, String configurationName, IndexableObject indexableObject)	Retrieve the Discovery configuration for the provided name or IndexableObject.

Uses of IndexableObject in org.dspace.discovery.indexobject

Classes in org.dspace.discovery.indexobject with type parameters of type IndexableObject

Modifier and Type	Class	Description
class	IndexFactoryImpl<T extends IndexableObject,S>	Basis factory interface implementation for indexing/retrieving any IndexableObject in the search core

Classes in org.dspace.discovery.indexobject that implement IndexableObject

Modifier and Type	Class	Description
class	AbstractIndexableObject<T extends ReloadableEntity<PK>,PK extends Serializable>	This class exists in order to provide a default implementation for the equals and hashCode methods.
class	IndexableClaimedTask	ClaimedTask implementation for the IndexableObject
class	IndexableCollection	Collection implementation for the IndexableObject
class	IndexableCommunity	Community implementation for the IndexableObject
class	IndexableDSpaceObject<T extends DSpaceObject>	DSpaceObject implementation for the IndexableObject, contains methods used by all DSpaceObject methods All DSpaceObjects that will be indexed in discovery should inherit from this class & have their own implementation
class	IndexableInProgressSubmission<T extends InProgressSubmission>	InProgressSubmission implementation for the IndexableObject
class	IndexableItem	Item implementation for the IndexableObject
class	IndexableLDNNotification	LDNMessageEntity implementation for the IndexableObject
class	IndexableMetadataField	MetadataField implementation for the IndexableObject
class	IndexablePoolTask	PoolTask implementation for the IndexableObject
class	IndexableWorkflowItem	Workflow item implementation for the IndexableObject
class	IndexableWorkspaceItem	Workspace item implementation for the IndexableObject

Uses of IndexableObject in org.dspace.discovery.indexobject.factory

Classes in org.dspace.discovery.indexobject.factory with type parameters of type IndexableObject

Modifier and Type	Interface	Description
interface	IndexFactory<T extends IndexableObject,S>	Basis factory interface for indexing/retrieving any IndexableObject in the search core

Methods in org.dspace.discovery.indexobject.factory that return types with arguments of type IndexableObject

Modifier and Type	Method	Description
List<IndexableObject>	IndexObjectFactoryFactory.getIndexableObjects(Context context, Object object)	Retrieve all the indexable objects for the provided object

Methods in org.dspace.discovery.indexobject.factory with parameters of type IndexableObject

Modifier and Type	Method	Description
IndexFactory	IndexObjectFactoryFactory.getIndexableObjectFactory(IndexableObject indexableObject)	Retrieve the IndexFactory implementation for the given indexable object

Uses of IndexableObject in org.dspace.discovery.utils

Methods in org.dspace.discovery.utils with parameters of type IndexableObject

Modifier and Type	Method	Description
DiscoverQuery	DiscoverQueryBuilder.buildFacetQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String prefix, String query, List<QueryBuilderSearchFilter> searchFilters, String dsoType, Integer pageSize, Long offset, String facetName)	Create a discovery facet query.
DiscoverQuery	DiscoverQueryBuilder.buildFacetQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String prefix, String query, List<QueryBuilderSearchFilter> searchFilters, List<String> dsoTypes, Integer pageSize, Long offset, String facetName)	Create a discovery facet query.
DiscoverQuery	DiscoverQueryBuilder.buildQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String query, List<QueryBuilderSearchFilter> searchFilters, String dsoType, Integer pageSize, Long offset, String sortProperty, String sortDirection)	Build a discovery query
DiscoverQuery	DiscoverQueryBuilder.buildQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String query, List<QueryBuilderSearchFilter> searchFilters, List<String> dsoTypes, Integer pageSize, Long offset, String sortProperty, String sortDirection)	Build a discovery query

Uses of IndexableObject in org.dspace.subscriptions

Method parameters in org.dspace.subscriptions with type arguments of type IndexableObject

Modifier and Type	Method	Description
void	ContentGenerator.notifyForSubscriptions(Context context, EPerson ePerson, List<IndexableObject> indexableComm, List<IndexableObject> indexableColl)

Uses of IndexableObject in org.dspace.subscriptions.objectupdates

Methods in org.dspace.subscriptions.objectupdates that return types with arguments of type IndexableObject

Modifier and Type	Method	Description
List<IndexableObject>	CollectionUpdates.findUpdates(Context context, DSpaceObject dSpaceObject, String frequency)
List<IndexableObject>	CommunityUpdates.findUpdates(Context context, DSpaceObject dSpaceObject, String frequency)

Uses of IndexableObject in org.dspace.subscriptions.service

Methods in org.dspace.subscriptions.service that return types with arguments of type IndexableObject

Modifier and Type	Method	Description
List<IndexableObject>	DSpaceObjectUpdates.findUpdates(Context context, DSpaceObject dSpaceObject, String frequency)	Send an email to some addresses, concerning a Subscription, using a given dso.