com.jivesoftware.community.search
Interface IndexInfoProvider

All Known Implementing Classes:

BaseIndexInfoProvider

public interface IndexInfoProvider

The search subsystem will use subtypes of this interface to index objects of type IndexableType.

Method Summary

boolean	getCanViewObject(JiveObject jiveObject) Returns true if the current user can view this JiveObject in Jive SBS or not.
boolean	getCanViewType() Returns true if the current user can view this type in Jive SBS or not.
IndexInfo	getContent(long id) Returns the indexable content for a given ID
List<IndexInfo>	getContent(long minID, long maxID, Date minDate, Date maxDate) Returns a list of IDs where minID <= ID <= maxID and create/publish date was after min date
long	getCount(Date max) Returns the count of objects that were created before the given max date.
List<EntityDescriptor>	getIDs(long minID, long maxID, Date minDate, Date maxDate) Returns a list of IDs where minID <= ID <= maxID and create/publish date was after min date
long	getMaxID(Date max) Returns the highest id for a give object type that was created before the given max date.
long	getMinID(Date min) Returns the smallest id for a give object type that was created after the given min date.
boolean	isIndexable(JiveObject jiveObject) Returns true if the jiveObject should be indexed, false otherwise.

Method Detail

getCount

long getCount(Date max)

Returns the count of objects that were created before the given max date.

Parameters:

max - date before which the content was created

Returns:

id highest id

getMaxID

long getMaxID(Date max)

Returns the highest id for a give object type that was created before the given max date.

Parameters:

max - date before which the content was created

Returns:

id highest id

getMinID

long getMinID(Date min)

Returns the smallest id for a give object type that was created after the given min date.

Parameters:

min - date after which the content was created

Returns:

id smallest id

getContent

List<IndexInfo> getContent(long minID,
                           long maxID,
                           Date minDate,
                           Date maxDate)

Returns a list of IDs where minID <= ID <= maxID and create/publish date was after min date

Parameters:

minID - lower bound on the ID

maxID - upper bound on the ID

minDate - date before which the document was published

maxDate - latest date for which the document was published

Returns:

list of ids

getIDs

List<EntityDescriptor> getIDs(long minID,
                              long maxID,
                              Date minDate,
                              Date maxDate)

Returns a list of IDs where minID <= ID <= maxID and create/publish date was after min date

Parameters:

minID - lower bound on the ID

maxID - upper bound on the ID

minDate - date before which the document was published

maxDate - latest date for which the document was published

Returns:

list of ids

getContent

IndexInfo getContent(long id)

Returns the indexable content for a given ID

Parameters:

id - content id

Returns:

indexable content

getCanViewType

boolean getCanViewType()

Returns true if the current user can view this type in Jive SBS or not. This method is related to a global permission in Jive SBS, and not just a permission for a community.

Returns:

true if the user can see the content type in Jive SBS.

getCanViewObject

boolean getCanViewObject(JiveObject jiveObject)

Returns true if the current user can view this JiveObject in Jive SBS or not.

Parameters:

jiveObject - to determine visibility of

Returns:

true if the user can see the JiveObject.

isIndexable

boolean isIndexable(JiveObject jiveObject)

Returns true if the jiveObject should be indexed, false otherwise. As an example, an implementation might check the state of the object to see if it's in a draft state. If so, it would return false as draft instances of the object should not be indexed, otherwise it would return true.

Parameters:

jiveObject - the jive object to determine indexability for

Returns:

true if the jiveObject should be indexed, false otherwise.