| org.sakaiproject.search.api.EntityContentProducer
All known Subclasses: org.sakaiproject.search.component.adapter.contenthosting.ContentHostingContentProducer, org.sakaiproject.search.component.adapter.rwiki.RWikiEntityContentProducer, org.sakaiproject.chat2.model.impl.ChatContentProducer, org.sakaiproject.search.component.adapter.message.MessageContentProducer,
| EntityContentProducer | | public interface EntityContentProducer (Code) | | This is a special class than handles ContentResources for the purposes of
search. This must be impelented in a thread safe way. The aim is to map the
content handler to the mime type
author:
ieb |
| canRead | | boolean canRead(String reference)(Code) | | returns true if the current user can view the search result
Parameters:
ref - |
| getAction | | Integer getAction(Event event)(Code) | | Get the search builder action associated with the event
Parameters:
event - |
| getAllContent | | List getAllContent()(Code) | | Gets a list of Entity resource as a String to represent all indexable
content
|
| getContent | | String getContent(String reference)(Code) | | Get the content as a string
Parameters:
cr - |
| getContentReader | | Reader getContentReader(String reference)(Code) | | Get a reader for the supplied content resource
Parameters:
cr - |
| getCustomProperties | | Map getCustomProperties()(Code) | | Gets a map of custom document properties. The names of the map map will contain
the index name to which the value is added.
The value is expected to be a String or String[], containig the value, values to be
added. Before using this method in your entity producer, be certain that the value
is not already in the index. ( See SearchService for list of Fields)
|
| getCustomRDF | | String getCustomRDF()(Code) | | At the moment this is a placeholder, but eventually
It will return a block of Custom RDF, that the EntityContentProducer wants
the search index to index. This is ontop of any RDF that the search index is
already processing.
|
| getSiteContent | | List getSiteContent(String context)(Code) | | get all the content associated with a site managed by this EntityContentProducer
Parameters:
context - |
| getSiteContentIterator | | Iterator getSiteContentIterator(String context)(Code) | | Get the site content as an iterator
Parameters:
context - |
| getSiteId | | String getSiteId(String reference)(Code) | | get the site ID from the resource Name
Parameters:
resourceName - |
| getTitle | | String getTitle(String reference)(Code) | | get the title for the content
Parameters:
cr - |
| getTool | | String getTool()(Code) | | What is the name of the tool,
|
| getUrl | | String getUrl(String reference)(Code) | | Gets the url that displays the entity
Parameters:
entity - |
| isContentFromReader | | boolean isContentFromReader(String reference)(Code) | | Should the consumer use the reader or is it Ok to use a memory copy of
the content
Parameters:
cr - |
| isForIndex | | boolean isForIndex(String reference)(Code) | | If the reference should be indexed, return true
Parameters:
ref - |
| matches | | boolean matches(String reference)(Code) | | If the reference matches this EntityContentProducer return true
Parameters:
ref - |
| matches | | boolean matches(Event event)(Code) | | Is the event owned by this EntityContentProducer
Parameters:
event - |
|
|