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

Class BlogSearchHelper

java.lang.Object

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

public class BlogSearchHelper
extends Object

Helper class for blog search operations.

Author:

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

Method Summary

Modifier and Type	Method and Description
static org.codehaus.jackson.node.ArrayNode	createBlogSearchJSONResult(Collection<BlogData> list, boolean includeDescription, boolean includeImagePath) Creates a JSON array with JSON objects of the blog list items.
static org.codehaus.jackson.node.ObjectNode	createBlogSearchJSONResult(Long blogId, String nameIdentifier, String title, boolean includeImagePath) Creates a JSON object describing a blog by its id, nameId and title
static org.codehaus.jackson.node.ObjectNode	createBlogSearchJSONResult(Long blogId, String nameIdentifier, String title, String description, boolean includeImagePath) Creates a JSON object describing a blog by its id, nameId and title
static org.codehaus.jackson.node.ArrayNode	createBlogSearchJSONResult(PageableList<BlogData> list, boolean writeSummary, boolean includeDescription, boolean includeImagePath) Creates a JSON array with JSON objects of the blog list items.
static <E extends QueryParameters> PageableList<BlogData>	findBlogs(Query<BlogData,E> query, E queryParameters, boolean sortAndLocalizeResult) runs a query for blogs

Methods inherited from class java.lang.Object

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

Method Detail

createBlogSearchJSONResult

public static org.codehaus.jackson.node.ArrayNode createBlogSearchJSONResult(Collection<BlogData> list,
                                                                             boolean includeDescription,
                                                                             boolean includeImagePath)

Creates a JSON array with JSON objects of the blog list items.

Parameters:

list - list to process

includeDescription - whether to include the description

includeImagePath - whether to include the path to the image

Returns:

the JSON array

createBlogSearchJSONResult

public static org.codehaus.jackson.node.ObjectNode createBlogSearchJSONResult(Long blogId,
                                                                              String nameIdentifier,
                                                                              String title,
                                                                              boolean includeImagePath)

Creates a JSON object describing a blog by its id, nameId and title

Parameters:

blogId - the blog id

nameIdentifier - the alias

title - the title

includeImagePath - whether to include the path to the image

Returns:

the JSON object

createBlogSearchJSONResult

public static org.codehaus.jackson.node.ObjectNode createBlogSearchJSONResult(Long blogId,
                                                                              String nameIdentifier,
                                                                              String title,
                                                                              String description,
                                                                              boolean includeImagePath)

Creates a JSON object describing a blog by its id, nameId and title

Parameters:

blogId - the blog id

nameIdentifier - the alias

title - the title

description - the blog description

includeImagePath - whether to include the path to the image

Returns:

the JSON object

createBlogSearchJSONResult

public static org.codehaus.jackson.node.ArrayNode createBlogSearchJSONResult(PageableList<BlogData> list,
                                                                             boolean writeSummary,
                                                                             boolean includeDescription,
                                                                             boolean includeImagePath)

Creates a JSON array with JSON objects of the blog list items.

Parameters:

list - list to process

writeSummary - whether to include a summary about the number of items in the list. The summary will be the first item in the list.

includeDescription - whether to include the description

includeImagePath - whether to include the path to the image

Returns:

the JSON array

findBlogs

public static <E extends QueryParameters> PageableList<BlogData> findBlogs(Query<BlogData,E> query,
                                                                           E queryParameters,
                                                                           boolean sortAndLocalizeResult)

runs a query for blogs

Parameters:

query - The query to use.

queryParameters - the query parameters to use

sortAndLocalizeResult - whether to localize blog titles and sort the found blogs by title

Returns:

the found blogs