com.raritantechnologies.recommend
Interface IRecommend

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

VerityRecommend

public interface IRecommend

extends IConfigurable

Interface for recommendation engine. Base interface for recommendation engine interaction

Contains methods for pushing information to a recommendation engine

Contains methods for retreiving user info, documents and queries from a recommendation engine

Developed by Raritan Technologies

Author:

Ted Sullivan, Ron Pohle

Method Summary

void	addDocuments(ILoginInfo userInfo, OrderedMap query, IDocument[] documents) Add a selected result to the recommendation engine - link a user / query to a result
void	addQuery(ILoginInfo userInfo, OrderedMap query) Add a query to the recommendation engine - links a user to a query
void	addUser(ILoginInfo userInfo) Add a user to the recommendation engine
void	createRecommendationLogEntries(java.lang.String transactionType, OrderedMap transMap) Flexible method for pushing data to recommendation engine
ILoginInfo[]	getExpertUsers(IQueryList queries, IDocument document, int returnCount) Retreives users based on query/document
IDocument[]	getRelatedDocuments(java.util.Collection repositories, java.util.Collection docFields, ILoginInfo userInfo, boolean isGroup, int returnCount) Retreives documents based on a user or user group
IDocument[]	getRelatedDocuments(java.util.Collection repositories, java.util.Collection docFields, ILoginInfo userinfo, IDocument document, OrderedMap query, boolean isGroup, int returnCount) Retreives documents based on user or user group/query/document
IQueryList	getRelatedQueries(java.util.Collection repositories, ILoginInfo userInfo, IQueryList queries, IDocument document, boolean isGroup, int returnCount) Retreives queries based on user or user group/query/document
IQueryList	getRelatedQueries(ILoginInfo userInfo, boolean isGroup, int returnCount) Retreives queries associated with a user or user group
ILoginInfo[]	getRelatedUsers(ILoginInfo userInfo, OrderedMap query, boolean isGroup, int returnCount) Retreives users based on user/query
IDocument[]	recommendDocuments(java.util.Collection repositories, java.util.Collection docFields, OrderedMap query, ILoginInfo userInfo, int returnCount) Retreives documents associated to query and user
IDocument[]	recommendSimilarDocuments(java.util.Collection repositories, java.util.Collection docFields, OrderedMap query, IDocument document, int returnCount) Retreives documents similar to the supplied document and query

Methods inherited from interface com.raritantechnologies.searchApp.IConfigurable

initialize

Method Detail

addUser

public void addUser(ILoginInfo userInfo)
             throws RecommendException

Add a user to the recommendation engine

Parameters:

userInfo - contains user name

Throws:

RecommendException

addQuery

public void addQuery(ILoginInfo userInfo,
                     OrderedMap query)
              throws RecommendException

Add a query to the recommendation engine - links a user to a query

Parameters:

userInfo - contains user name

query - contains query text

Throws:

RecommendException

addDocuments

public void addDocuments(ILoginInfo userInfo,
                         OrderedMap query,
                         IDocument[] documents)
                  throws RecommendException

Add a selected result to the recommendation engine - link a user / query to a result

Parameters:

userInfo - contains user name

query - contains query text

documents - contains documents

Throws:

RecommendException

createRecommendationLogEntries

public void createRecommendationLogEntries(java.lang.String transactionType,
                                           OrderedMap transMap)
                                    throws RecommendException

Flexible method for pushing data to recommendation engine

Parameters:

transactionType - any custom transaction type the application requires

transMap - used to supply data required by transaction type

Throws:

RecommendException

getRelatedDocuments

public IDocument[] getRelatedDocuments(java.util.Collection repositories,
                                       java.util.Collection docFields,
                                       ILoginInfo userInfo,
                                       boolean isGroup,
                                       int returnCount)
                                throws RecommendException

Retreives documents based on a user or user group

Parameters:

repositories - name of repositories to be involved in the search

docFields - list of fields to be returned in the result set

userInfo - contains user name or group

isGroup - is user a group

returnCount - number of results to return

Returns:

Throws:

RecommendException

getRelatedDocuments

public IDocument[] getRelatedDocuments(java.util.Collection repositories,
                                       java.util.Collection docFields,
                                       ILoginInfo userinfo,
                                       IDocument document,
                                       OrderedMap query,
                                       boolean isGroup,
                                       int returnCount)
                                throws RecommendException

Retreives documents based on user or user group/query/document

Parameters:

repositories - name of repositories to be involved in the search

docFields - list of fields to be returned in the result set

userinfo - contains user name or group

document - contains example document

query - contains query text

isGroup - is user a group

returnCount - number of results to return

Returns:

Throws:

RecommendException

recommendSimilarDocuments

public IDocument[] recommendSimilarDocuments(java.util.Collection repositories,
                                             java.util.Collection docFields,
                                             OrderedMap query,
                                             IDocument document,
                                             int returnCount)
                                      throws RecommendException

Retreives documents similar to the supplied document and query

Parameters:

repositories - name of repositories to be involved in the search

docFields - list of fields to be returned in the result set

query - contains query text

document - contains example document

returnCount - number of results to return

Returns:

Throws:

RecommendException

recommendDocuments

public IDocument[] recommendDocuments(java.util.Collection repositories,
                                      java.util.Collection docFields,
                                      OrderedMap query,
                                      ILoginInfo userInfo,
                                      int returnCount)
                               throws RecommendException

Retreives documents associated to query and user

Parameters:

repositories - name of repositories to be involved in the search

docFields - list of fields to be returned in the result set

query - contains query text

userInfo - contains user name

returnCount - number of results to return

Returns:

Throws:

RecommendException

getRelatedQueries

public IQueryList getRelatedQueries(ILoginInfo userInfo,
                                    boolean isGroup,
                                    int returnCount)
                             throws RecommendException

Retreives queries associated with a user or user group

Parameters:

userInfo - contains user name or group

isGroup - is user a group

returnCount - number of results to return

Returns:

Throws:

RecommendException

getRelatedQueries

public IQueryList getRelatedQueries(java.util.Collection repositories,
                                    ILoginInfo userInfo,
                                    IQueryList queries,
                                    IDocument document,
                                    boolean isGroup,
                                    int returnCount)
                             throws RecommendException

Retreives queries based on user or user group/query/document

Parameters:

userInfo - contains user name or group

queries - contains query text

document - contains example document

isGroup - is user a group

returnCount - number of results to return

Returns:

Throws:

RecommendException

getExpertUsers

public ILoginInfo[] getExpertUsers(IQueryList queries,
                                   IDocument document,
                                   int returnCount)
                            throws RecommendException

Retreives users based on query/document

Parameters:

queries - contains query text

document - contains example document

returnCount - number of results to return

Returns:

Throws:

RecommendException

getRelatedUsers

public ILoginInfo[] getRelatedUsers(ILoginInfo userInfo,
                                    OrderedMap query,
                                    boolean isGroup,
                                    int returnCount)
                             throws RecommendException

Retreives users based on user/query

Parameters:

userInfo - contains user name

query - contains query text

isGroup - is user a group

returnCount - number of results to return

Returns:

Throws:

RecommendException