fr.paris.lutece.plugins.digglike.utils

Class DiggUtils

java.lang.Object

fr.paris.lutece.plugins.digglike.utils.DiggUtils

public final class DiggUtils
extends Object

class FormUtils

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSTANT_ID_NULL
static int	CONSTANT_SUBMIT_FILTER_MONTH
static int	CONSTANT_SUBMIT_FILTER_TO_DAY
static int	CONSTANT_SUBMIT_FILTER_WEEK
static int	CONSTANT_SUBMIT_FILTER_YESTERDAY
static String	EMPTY_STRING
static String	PROPERTY_FILTER_ALL
static String	PROPERTY_FILTER_MONTH
static String	PROPERTY_FILTER_TO_DAY
static String	PROPERTY_FILTER_WEEK
static String	PROPERTY_FILTER_YESTERDAY
static String	SERVLET_IMAGE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAvatarToModel(Map<String,Object> model, DiggUserInfo luteceUserInfo) Add Avatar to model
static void	addEmptyItem(fr.paris.lutece.util.ReferenceList refList) Add an empty element to a reference list
static void	addHeaderResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String strFileName) write the http header in the response
static String	buildRequestWithFilter(String strSelect, List<String> listStrFilter, String strOrder) Builds a query with filters placed in parameters
static IEntry	createEntryByType(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin) return an instance of IEntry function of type entry
static SubmitFilter	createPinnedFilter(SubmitFilter filter) create a filter for getting the list of pinned digg submit
static Map<String,Object>	depopulate(Digg digg) Depopulate the digg into a map of key - value
static void	doReportDiggSubmit(DiggSubmit diggSubmit, fr.paris.lutece.portal.service.plugin.Plugin plugin) Perform the report on a digg submit
static void	doVoteDiggSubmit(int nIdDiggSubmit, int nScore, String strLuteceUserKey, fr.paris.lutece.portal.service.plugin.Plugin plugin) Perform the vote on a digg submit
static FormError	getAllResponsesData(javax.servlet.http.HttpServletRequest request, DiggSubmit diggSubmit, fr.paris.lutece.portal.service.plugin.Plugin plugin, Locale locale) perform in the object diggSubmit the responses associates to the diggsubmit
static Timestamp	getCurrentDate() return current date
static Timestamp	getDateAfterNDay(Timestamp date, int nDay) Return a date corresponding to the date provides in parameter add with a number of day
static String	getDateString(Timestamp date, Locale locale) Converts une java.sql.Timestamp date in a String date in a "jj/mm/aaaa" format
static SubmitFilter	getDiggSubmitFilter(DigglikeAdminSearchFields searchFields)
static SubmitFilter	getDiggSubmitFilter(DigglikeAdminSearchFields searchFields, Integer nDefaultIdSort)
static String	getDiggSubmitTitle(DiggSubmit diggSubmit, Locale locale) return the title of the digg submit
static Timestamp	getFirstDayOfMonth(Timestamp date) return the first day of month function of the date .
static Timestamp	getFirstDayOfWeek(Timestamp date) return the first day of week function of the date .
static Timestamp	getFirstMinute(String strDate, Locale locale) return a timestamp Object which correspond with the string specified in parameter.
static Timestamp	getFirstMinute(Timestamp date) return a timestamp Object which correspond at the fist minute of the date .
static String	getHtmlDiggSubmitValue(DiggSubmit diggSubmit, Locale locale) return the content of the html code of the digg submit
static String	getHtmlDiggSubmitValueShowInTheList(DiggSubmit diggSubmit, Locale locale) return the content of the html code of the digg submit show in the list of digg submit
static void	getHtmlFormEntry(int nIdEntry, fr.paris.lutece.portal.service.plugin.Plugin plugin, StringBuffer stringBuffer, Locale locale) insert in the string buffer the content of the html code of the entry
static void	getHtmlResponseEntry(Response response, StringBuffer stringBuffer, Locale locale, boolean bTitle) return the content of the html code response
static int	getIndexEntryInTheEntryList(int nIdEntry, List<IEntry> listEntry) return the index in the list of the entry whose key is specified in parameter
static int	getIntegerParameter(String strParameter) convert a string to int
static Timestamp	getLastDayOfMonth(Timestamp date) return the last day of month function of the date .
static Timestamp	getLastDayOfWeek(Timestamp date) return the last day of week function of the date .
static Timestamp	getLastMinute(String strDate, Locale locale) return a timestamp Object which correspond with the string specified in parameter.
static Timestamp	getLastMinute(Timestamp date) return a timestamp Object which correspond at the last minute of the date .
static Map<String,Object>	getModelHtmlForm(Digg digg, fr.paris.lutece.portal.service.plugin.Plugin plugin, Locale locale, int nIdDefaultCategory, boolean bBackOffice)
static fr.paris.lutece.util.ReferenceList	getRefListCategory(List<Category> listCategories) Init reference list with the different categories
static fr.paris.lutece.util.ReferenceList	getRefListCommentSort(Locale locale) Init reference list width the different sort
static fr.paris.lutece.util.ReferenceList	getRefListCommentState(Locale locale) Init reference list width the different sort
static fr.paris.lutece.util.ReferenceList	getRefListDigg(List<Digg> listDiggs, boolean bIncludeDefault) Init reference list with the different categories
static fr.paris.lutece.util.ReferenceList	getRefListDiggSort(Locale locale) Init reference list width the different sort
static fr.paris.lutece.util.ReferenceList	getRefListDiggSort(Locale locale, boolean bFront) Init reference list width the different sort
static fr.paris.lutece.util.ReferenceList	getRefListFilterByPeriod(Locale locale) Init reference list width the different sort
static fr.paris.lutece.util.ReferenceList	getRefListType(List<DiggSubmitType> listTypes) Init reference list with the different types
static FormError	getResponseEntry(javax.servlet.http.HttpServletRequest request, int nIdEntry, fr.paris.lutece.portal.service.plugin.Plugin plugin, DiggSubmit diggSubmit, boolean bResponseNull, Locale locale) perform in the object diggSubmit the responses associates with a entry specify in parameter.
static void	initCommentFilterBySort(SubmitFilter submitFilter, int nIdSort) initialized the submit filter object with the sort specified in parameter
static void	initSubmitFilterByPeriod(SubmitFilter submitFilter, int nIdPeriod) initialized the submit filter object with the period specified in parameter
static void	initSubmitFilterBySort(SubmitFilter submitFilter, int nIdSort) initialized the submit filter object with the sort specified in parameter
static void	moveElement(int nOldPosistion, int nNewPosition, ArrayList<Integer> list) move a element in the list
static List<Integer>	retainAllIdsKeepingFirstOrder(List<Integer> list1, List<Integer> list2) Like List.retainAll(java.util.Collection), keeping first list order.
static void	sendNotificationNewCommentSubmit(Digg digg, CommentSubmit commentSubmit, Locale locale, javax.servlet.http.HttpServletRequest request) sendMail of notification for new comment submit
static void	sendNotificationNewDiggSubmit(Digg digg, DiggSubmit diggSubmit, Locale locale, javax.servlet.http.HttpServletRequest request) sendMail of notification for new digg submit
static void	sendNotificationNewDiggSubmitDisable(Digg digg, DiggSubmit diggSubmit, Locale locale) sendMail of notification for new digg submit disable
static void	sendNotificationNewReportedMessage(Digg digg, ReportedMessage reportedMessage, Locale locale, javax.servlet.http.HttpServletRequest request) sendMail of notification for new reported message
static String	substituteSpecialCaractersForExport(String strSource) replace special characters in the string passed as a parameter
static String	trim(String strParameter) Returns a copy of the string , with leading and trailing whitespace omitted.

Methods inherited from class java.lang.Object

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

Field Detail

CONSTANT_ID_NULL

public static final int CONSTANT_ID_NULL

See Also:

Constant Field Values

CONSTANT_SUBMIT_FILTER_TO_DAY

public static final int CONSTANT_SUBMIT_FILTER_TO_DAY

See Also:

Constant Field Values

CONSTANT_SUBMIT_FILTER_WEEK

public static final int CONSTANT_SUBMIT_FILTER_WEEK

See Also:

Constant Field Values

CONSTANT_SUBMIT_FILTER_MONTH

public static final int CONSTANT_SUBMIT_FILTER_MONTH

See Also:

Constant Field Values

CONSTANT_SUBMIT_FILTER_YESTERDAY

public static final int CONSTANT_SUBMIT_FILTER_YESTERDAY

See Also:

Constant Field Values

SERVLET_IMAGE_PATH

public static final String SERVLET_IMAGE_PATH

See Also:

Constant Field Values

EMPTY_STRING

public static final String EMPTY_STRING

See Also:

Constant Field Values

PROPERTY_FILTER_ALL

public static final String PROPERTY_FILTER_ALL

See Also:

Constant Field Values

PROPERTY_FILTER_TO_DAY

public static final String PROPERTY_FILTER_TO_DAY

See Also:

Constant Field Values

PROPERTY_FILTER_WEEK

public static final String PROPERTY_FILTER_WEEK

See Also:

Constant Field Values

PROPERTY_FILTER_MONTH

public static final String PROPERTY_FILTER_MONTH

See Also:

Constant Field Values

PROPERTY_FILTER_YESTERDAY

public static final String PROPERTY_FILTER_YESTERDAY

See Also:

Constant Field Values

Method Detail

sendNotificationNewDiggSubmit

public static void sendNotificationNewDiggSubmit(Digg digg,
                                 DiggSubmit diggSubmit,
                                 Locale locale,
                                 javax.servlet.http.HttpServletRequest request)

sendMail of notification for new digg submit

Parameters:

digg - the digg

diggSubmit - the new diggSubmit

locale - the locale

request - the request

sendNotificationNewDiggSubmitDisable

public static void sendNotificationNewDiggSubmitDisable(Digg digg,
                                        DiggSubmit diggSubmit,
                                        Locale locale)

sendMail of notification for new digg submit disable

Parameters:

digg - the digg

diggSubmit - the digg submit disable

locale - the locale

sendNotificationNewCommentSubmit

public static void sendNotificationNewCommentSubmit(Digg digg,
                                    CommentSubmit commentSubmit,
                                    Locale locale,
                                    javax.servlet.http.HttpServletRequest request)

sendMail of notification for new comment submit

Parameters:

digg - the digg

commentSubmit - the new comment submit

locale - the locale

request - the request

sendNotificationNewReportedMessage

public static void sendNotificationNewReportedMessage(Digg digg,
                                      ReportedMessage reportedMessage,
                                      Locale locale,
                                      javax.servlet.http.HttpServletRequest request)

sendMail of notification for new reported message

Parameters:

digg - the digg

reportedMessage - the reported Message

locale - the locale

request - the request

getLastMinute

public static Timestamp getLastMinute(String strDate,
                      Locale locale)

return a timestamp Object which correspond with the string specified in parameter.

Parameters:

strDate - the date who must convert

locale - the locale

Returns:

a timestamp Object which correspond with the string specified in parameter.

getFirstMinute

public static Timestamp getFirstMinute(String strDate,
                       Locale locale)

return a timestamp Object which correspond with the string specified in parameter.

Parameters:

strDate - the date who must convert

locale - the locale

Returns:

a timestamp Object which correspond with the string specified in parameter.

getFirstDayOfWeek

public static Timestamp getFirstDayOfWeek(Timestamp date)

return the first day of week function of the date .

Parameters:

date - the date

Returns:

the first day of week function of the date.

getLastDayOfWeek

public static Timestamp getLastDayOfWeek(Timestamp date)

return the last day of week function of the date .

Parameters:

date - the date

Returns:

the last day of week function of the date.

getFirstMinute

public static Timestamp getFirstMinute(Timestamp date)

return a timestamp Object which correspond at the fist minute of the date .

Parameters:

date - the date

Returns:

a timestamp Object which correspond at the fist minute of the date .

getLastMinute

public static Timestamp getLastMinute(Timestamp date)

return a timestamp Object which correspond at the last minute of the date .

Parameters:

date - the date

Returns:

a timestamp Object which correspond at the last minute of the date .

getFirstDayOfMonth

public static Timestamp getFirstDayOfMonth(Timestamp date)

return the first day of month function of the date .

Parameters:

date - the date

Returns:

the first day of mont function of the date.

getLastDayOfMonth

public static Timestamp getLastDayOfMonth(Timestamp date)

return the last day of month function of the date .

Parameters:

date - the date

Returns:

the last day of mont function of the date.

getDateString

public static String getDateString(Timestamp date,
                   Locale locale)

Converts une java.sql.Timestamp date in a String date in a "jj/mm/aaaa" format

Parameters:

date - java.sql.Timestamp date to convert

locale - the locale

Returns:

strDate The String date in the short locale format or the emmpty String if the date is null

getCurrentDate

public static Timestamp getCurrentDate()

return current date

Returns:

return current date

getDateAfterNDay

public static Timestamp getDateAfterNDay(Timestamp date,
                         int nDay)

Return a date corresponding to the date provides in parameter add with a number of day

Parameters:

date - the date

nDay - the number of day to add

Returns:

a timestamp Object which correspond at the date + nDay .

createEntryByType

public static IEntry createEntryByType(javax.servlet.http.HttpServletRequest request,
                       fr.paris.lutece.portal.service.plugin.Plugin plugin)

return an instance of IEntry function of type entry

Parameters:

request - the request

plugin - the plugin

Returns:

an instance of IEntry function of type entry

getIndexEntryInTheEntryList

public static int getIndexEntryInTheEntryList(int nIdEntry,
                              List<IEntry> listEntry)

return the index in the list of the entry whose key is specified in parameter

Parameters:

nIdEntry - the key of the entry

listEntry - the list of the entry

Returns:

the index in the list of the entry whose key is specified in parameter

getModelHtmlForm

public static Map<String,Object> getModelHtmlForm(Digg digg,
                                  fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                  Locale locale,
                                  int nIdDefaultCategory,
                                  boolean bBackOffice)

Parameters:

digg -

plugin -

locale -

nIdDefaultCategory -

bBackOffice -

Returns:

getHtmlFormEntry

public static void getHtmlFormEntry(int nIdEntry,
                    fr.paris.lutece.portal.service.plugin.Plugin plugin,
                    StringBuffer stringBuffer,
                    Locale locale)

insert in the string buffer the content of the html code of the entry

Parameters:

nIdEntry - the key of the entry which html code must be insert in the stringBuffer

plugin - the plugin

stringBuffer - the buffer which contains the html code

locale - the locale

getHtmlResponseEntry

public static void getHtmlResponseEntry(Response response,
                        StringBuffer stringBuffer,
                        Locale locale,
                        boolean bTitle)

return the content of the html code response

Parameters:

response - the response which html code must be generate

stringBuffer - the stringBuffer

bTitle - true if the response is a title

locale - the locale

getHtmlDiggSubmitValue

public static String getHtmlDiggSubmitValue(DiggSubmit diggSubmit,
                            Locale locale)

return the content of the html code of the digg submit

Parameters:

diggSubmit - the diggsubmit

locale - the locale

Returns:

the content of the html code of the digg submit

getHtmlDiggSubmitValueShowInTheList

public static String getHtmlDiggSubmitValueShowInTheList(DiggSubmit diggSubmit,
                                         Locale locale)

return the content of the html code of the digg submit show in the list of digg submit

Parameters:

diggSubmit - the diggsubmit

locale - the locale

Returns:

the content of the html code of the digg submit show in the list of digg submit

getDiggSubmitTitle

public static String getDiggSubmitTitle(DiggSubmit diggSubmit,
                        Locale locale)

return the title of the digg submit

Parameters:

diggSubmit - the diggsubmit

locale - the locale

Returns:

the title of the digg submit

getAllResponsesData

public static FormError getAllResponsesData(javax.servlet.http.HttpServletRequest request,
                            DiggSubmit diggSubmit,
                            fr.paris.lutece.portal.service.plugin.Plugin plugin,
                            Locale locale)

perform in the object diggSubmit the responses associates to the diggsubmit

Parameters:

request -

diggSubmit -

plugin -

locale -

Returns:

Throws:

fr.paris.lutece.portal.service.message.SiteMessageException

getResponseEntry

public static FormError getResponseEntry(javax.servlet.http.HttpServletRequest request,
                         int nIdEntry,
                         fr.paris.lutece.portal.service.plugin.Plugin plugin,
                         DiggSubmit diggSubmit,
                         boolean bResponseNull,
                         Locale locale)

perform in the object diggSubmit the responses associates with a entry specify in parameter. return null if there is no error in the response else return a FormError Object

Parameters:

request - the request

nIdEntry - the key of the entry

plugin - the plugin

diggSubmit - digg Submit Object

bResponseNull - true if the response create must be null

locale - the locale

Returns:

null if there is no error in the response else return a FormError Object

getIntegerParameter

public static int getIntegerParameter(String strParameter)

convert a string to int

Parameters:

strParameter - the string parameter to convert

Returns:

the conversion

trim

public static String trim(String strParameter)

Returns a copy of the string , with leading and trailing whitespace omitted.

Parameters:

strParameter - the string parameter to convert

Returns:

null if the strParameter is null other return with leading and trailing whitespace omitted.

initSubmitFilterByPeriod

public static void initSubmitFilterByPeriod(SubmitFilter submitFilter,
                            int nIdPeriod)

initialized the submit filter object with the period specified in parameter

Parameters:

submitFilter - the filter to initialized

nIdPeriod - the id of the period (DAY,WEEK,MONTH)

initSubmitFilterBySort

public static void initSubmitFilterBySort(SubmitFilter submitFilter,
                          int nIdSort)

initialized the submit filter object with the sort specified in parameter

Parameters:

submitFilter - the filter to initialized

nIdSort - the id of the sort(date response, score)

initCommentFilterBySort

public static void initCommentFilterBySort(SubmitFilter submitFilter,
                           int nIdSort)

initialized the submit filter object with the sort specified in parameter

Parameters:

submitFilter - the filter to initialized

nIdSort - the id of the sort(date response, score)

doVoteDiggSubmit

public static void doVoteDiggSubmit(int nIdDiggSubmit,
                    int nScore,
                    String strLuteceUserKey,
                    fr.paris.lutece.portal.service.plugin.Plugin plugin)

Perform the vote on a digg submit

Parameters:

nIdDiggSubmit - the id of the digg submit

strLuteceUserKey - the key of the lutece user who have vote

nScore - the score of the vote

plugin - the plugin

doReportDiggSubmit

public static void doReportDiggSubmit(DiggSubmit diggSubmit,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)

Perform the report on a digg submit

Parameters:

diggSubmit - the digg submit

plugin - the plugin

getRefListCategory

public static fr.paris.lutece.util.ReferenceList getRefListCategory(List<Category> listCategories)

Init reference list with the different categories

Parameters:

listCategories - the list of categories

Returns:

reference list of category

getRefListType

public static fr.paris.lutece.util.ReferenceList getRefListType(List<DiggSubmitType> listTypes)

Init reference list with the different types

Parameters:

listTypes - the list of types

Returns:

reference list of type

getRefListDigg

public static fr.paris.lutece.util.ReferenceList getRefListDigg(List<Digg> listDiggs,
                                                boolean bIncludeDefault)

Init reference list with the different categories

Parameters:

listDiggs - the list of categories

bIncludeDefault - true if a default item must be insert

Returns:

reference list of category

getRefListDiggSort

public static fr.paris.lutece.util.ReferenceList getRefListDiggSort(Locale locale)

Init reference list width the different sort

Parameters:

locale - the locale

Returns:

reference list of sort

getRefListDiggSort

public static fr.paris.lutece.util.ReferenceList getRefListDiggSort(Locale locale,
                                                    boolean bFront)

Init reference list width the different sort

Parameters:

locale - the locale

bFront - yes if the refList is display in front office

Returns:

reference list of sort

getRefListFilterByPeriod

public static fr.paris.lutece.util.ReferenceList getRefListFilterByPeriod(Locale locale)

Init reference list width the different sort

Parameters:

locale - the locale

Returns:

reference list of sort

getRefListCommentSort

public static fr.paris.lutece.util.ReferenceList getRefListCommentSort(Locale locale)

Init reference list width the different sort

Parameters:

locale - the locale

Returns:

reference list of sort

getRefListCommentState

public static fr.paris.lutece.util.ReferenceList getRefListCommentState(Locale locale)

Init reference list width the different sort

Parameters:

locale - the locale

Returns:

reference list of sort

addHeaderResponse

public static void addHeaderResponse(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     String strFileName)

write the http header in the response

Parameters:

request - the httpServletRequest

response - the http response

strFileName - the name of the file who must insert in the response

buildRequestWithFilter

public static String buildRequestWithFilter(String strSelect,
                            List<String> listStrFilter,
                            String strOrder)

Builds a query with filters placed in parameters

Parameters:

strSelect - the select of the query

listStrFilter - the list of filter to add in the query

strOrder - the order by of the query

Returns:

a query

retainAllIdsKeepingFirstOrder

public static List<Integer> retainAllIdsKeepingFirstOrder(List<Integer> list1,
                                          List<Integer> list2)

Like List.retainAll(java.util.Collection), keeping first list order. This method is based on the fact that list1 and list2 have unique elements.

Parameters:

list1 - the first list

list2 - the other list

Returns:

first list

moveElement

public static void moveElement(int nOldPosistion,
               int nNewPosition,
               ArrayList<Integer> list)

move a element in the list

Parameters:

nOldPosistion - the old position

nNewPosition - the new position

list - The list

substituteSpecialCaractersForExport

public static String substituteSpecialCaractersForExport(String strSource)

replace special characters in the string passed as a parameter

Parameters:

strSource - the string

Returns:

substitute special in the string passed as a parameter

addEmptyItem

public static void addEmptyItem(fr.paris.lutece.util.ReferenceList refList)

Add an empty element to a reference list

Parameters:

refList - The reference list to add the empty element to

depopulate

public static Map<String,Object> depopulate(Digg digg)

Depopulate the digg into a map of key - value

Parameters:

digg - the digg

Returns:

a map of key - value

createPinnedFilter

public static SubmitFilter createPinnedFilter(SubmitFilter filter)

create a filter for getting the list of pinned digg submit

Parameters:

filter - the init filter

Returns:

a filter for getting f the list of pinned digg submit

getDiggSubmitFilter

public static SubmitFilter getDiggSubmitFilter(DigglikeAdminSearchFields searchFields)

Parameters:

searchFields - the search fields

Returns:

a submit Filter

getDiggSubmitFilter

public static SubmitFilter getDiggSubmitFilter(DigglikeAdminSearchFields searchFields,
                               Integer nDefaultIdSort)

Parameters:

searchFields - the search fields

nDefaultIdSort - the defautlt sort

Returns:

SubmitFilter

addAvatarToModel

public static void addAvatarToModel(Map<String,Object> model,
                    DiggUserInfo luteceUserInfo)

Add Avatar to model

Parameters:

model -

luteceUserInfo -