com.communote.server.web.fe.portal.blog.helper

Class UserSearchHelper

java.lang.Object

com.communote.server.web.fe.portal.blog.helper.UserSearchHelper

public class UserSearchHelper
extends Object

Helper class for user search.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static org.codehaus.jackson.node.ArrayNode	createEntitySearchJSONResult(PageableList<CommunoteEntityData> list, boolean addSummary, ImageSizeType imageSize) Creates an array of JSON objects which hold details about the found users or groups.
static org.codehaus.jackson.node.ObjectNode	createSearchSummaryStatement(PageableList<?> results) Creates a JSON Object that holds details about the number of items returned and whether there are more results
static org.codehaus.jackson.node.ObjectNode	createUserSearchJSONResult(Long userId, String shortName, String longName, String imagePath, String alias) Creates a JSON Object with key value pairs from the parameters passed to this method.
static <T extends UserData> org.codehaus.jackson.node.ArrayNode	createUserSearchJSONResult(PageableList<T> results, boolean addSummary, ImageSizeType imageSize) Creates an array of JSON objects which hold details about the found users.
static org.codehaus.jackson.node.ObjectNode	createUserSearchJSONResult(UserData item, ImageSizeType imageSize) Creates a JSON object describing a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createEntitySearchJSONResult

public static org.codehaus.jackson.node.ArrayNode createEntitySearchJSONResult(PageableList<CommunoteEntityData> list,
                                                                               boolean addSummary,
                                                                               ImageSizeType imageSize)

Creates an array of JSON objects which hold details about the found users or groups.

Parameters:

list - the search result to process

addSummary - if true a summary JSON object will be added to the top of the array. The JSON object will be created with createSearchSummaryStatement(PageableList) .

imageSize - the size of the user logo to include in the image path, can be null to not include the image path into the JSON object. For groups no image will be included.

Returns:

the JSON array with the details about the users

createSearchSummaryStatement

public static org.codehaus.jackson.node.ObjectNode createSearchSummaryStatement(PageableList<?> results)

Creates a JSON Object that holds details about the number of items returned and whether there are more results

Parameters:

results - the result of a search

Returns:

the JSON Object with keys resultsTotal and resultsReturned

createUserSearchJSONResult

public static org.codehaus.jackson.node.ObjectNode createUserSearchJSONResult(Long userId,
                                                                              String shortName,
                                                                              String longName,
                                                                              String imagePath,
                                                                              String alias)

Creates a JSON Object with key value pairs from the parameters passed to this method. Only the values (and keys) which are not null will be added.

Parameters:

userId - the ID of the user, if null this information is not added to the JSON object

shortName - a short version of the user name, if null this information is not added to the JSON object

longName - a long version of the user name, if null this information is not added to the JSON object

imagePath - the path to the user image, if null this information is not added to the JSON object

alias - the alias of the user, if null this information is not added to the JSON object

Returns:

the JSON object

createUserSearchJSONResult

public static <T extends UserData> org.codehaus.jackson.node.ArrayNode createUserSearchJSONResult(PageableList<T> results,
                                                                                                  boolean addSummary,
                                                                                                  ImageSizeType imageSize)

Creates an array of JSON objects which hold details about the found users.

Type Parameters:

T - the type of the result items

Parameters:

results - the search result to process

addSummary - if true a summary JSONObject will be added to the top of the array. The JSONObject will be created with createSearchSummaryStatement(PageableList) .

imageSize - the size of the user logo to include in the image path, can be null to not include the image path into the JSON object

Returns:

the JSON array with the details about the users

createUserSearchJSONResult

public static org.codehaus.jackson.node.ObjectNode createUserSearchJSONResult(UserData item,
                                                                              ImageSizeType imageSize)

Creates a JSON object describing a user. The returned object will have the attributes listed in createUserSearchJSONResult(Long, String, String, String, String) . If imageSize is null the imagePath will not be included.

Parameters:

item - the item from which the user information will be extracted

imageSize - the size of the user logo to include in the image path, can be null to not include the image path into the JSON object

Returns:

the JSON object