com.communote.plugins.api.rest.resource.note

Class NoteResourceHelper

java.lang.Object

com.communote.plugins.api.rest.resource.note.NoteResourceHelper

public final class NoteResourceHelper
extends Object

Helper for NoteResourceHandler

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NoteResourceHelper.NoteResourceComparator Comparator to sort note resources by their creation date in ascending order

Method Summary

Modifier and Type	Method and Description
static void	buildNoteResourceAttachments(NoteData note, NoteResource newNoteResource) Build the attachment part of the note
static void	buildNoteResourceNotifications(NoteData note, NoteResource newNoteResource) Build the notification part of the note
static NoteStoringTO	buildNoteStoringTO(CreateNoteParameter createNoteParameter) Get note storing transferobject
static NoteStoringTO	buildNoteStoringTO(EditNoteParameter editNoteParameter) Get note storing transferobject
static TagResource[]	buildTags(Collection<TagData> tagListItems) Build TagResources form Collection of TagData
static String	checkNoteText(String text, Boolean isHtml, Integer maxTextLength) Check the text of an note
static NoteQueryParameters	configureQueryInstance(GetCollectionNoteParameter noteCollectionParameter, QueryParametersParameterNameProvider nameProvider, Locale locale) Get query instance to filter notes
static NoteRenderContext	createNoteRenderContext(Boolean filterHtml, boolean beautifyPlainText, javax.ws.rs.core.Request request) Creates a suitable note render context.
static PageableList<NoteData>	getPageableList(NoteQueryParameters noteQueryInstance, NoteRenderContext renderContext) Get a PageableList of a NoteQueryParameters
static void	setToForParameterUnspecificElements(Boolean isHtml, NoteStoringTO noteStoringTO) Set elements of NoteStoringTO object that are the same in create or edit method
static List<NoteResource>	sortAndLimitNotes(List<NoteResource> notesToSort, Integer maxCount) Sort the notes by date in ascending order and return a subset that contains at most maxCount notes, starting with the oldest

Methods inherited from class java.lang.Object

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

Method Detail

buildNoteResourceAttachments

public static void buildNoteResourceAttachments(NoteData note,
                                                NoteResource newNoteResource)

Build the attachment part of the note

Parameters:

note - note of NoteData

newNoteResource - NoteResource

buildNoteResourceNotifications

public static void buildNoteResourceNotifications(NoteData note,
                                                  NoteResource newNoteResource)

Build the notification part of the note

Parameters:

note - note of NoteData

newNoteResource - NoteResource

buildNoteStoringTO

public static NoteStoringTO buildNoteStoringTO(CreateNoteParameter createNoteParameter)
                                        throws IllegalRequestParameterException

Get note storing transferobject

Parameters:

createNoteParameter - parameters to create an note

Returns:

NoteStoringTO

Throws:

IllegalRequestParameterException - text value is wrong

buildNoteStoringTO

public static NoteStoringTO buildNoteStoringTO(EditNoteParameter editNoteParameter)
                                        throws IllegalRequestParameterException

Get note storing transferobject

Parameters:

editNoteParameter - parameters to edit an note

Returns:

NoteStoringTO

Throws:

IllegalRequestParameterException - text value is wrong

buildTags

public static TagResource[] buildTags(Collection<TagData> tagListItems)

Build TagResources form Collection of TagData

Parameters:

tagListItems - Collection of TagData

Returns:

array of TagResource

checkNoteText

public static String checkNoteText(String text,
                                   Boolean isHtml,
                                   Integer maxTextLength)
                            throws IllegalRequestParameterException

Check the text of an note

Parameters:

text - textContent of the not

isHtml - is content html

maxTextLength - max length of text for note

Returns:

content or text of the note

Throws:

IllegalRequestParameterException - text value is wrong

configureQueryInstance

public static NoteQueryParameters configureQueryInstance(GetCollectionNoteParameter noteCollectionParameter,
                                                         QueryParametersParameterNameProvider nameProvider,
                                                         Locale locale)

Get query instance to filter notes

Parameters:

noteCollectionParameter - Extract context parameter needed for filter

nameProvider - The name provider.

locale - locale of the current user

Returns:

NoteQueryInstance

createNoteRenderContext

public static NoteRenderContext createNoteRenderContext(Boolean filterHtml,
                                                        boolean beautifyPlainText,
                                                        javax.ws.rs.core.Request request)

Creates a suitable note render context.

Parameters:

filterHtml - if true the content should be returned as plain text

beautifyPlainText - if true beautifications can be applied when creating the plain text. Will be ignored if filterHtml is false.

request - the current request

Returns:

the prepared note render context

getPageableList

public static PageableList<NoteData> getPageableList(NoteQueryParameters noteQueryInstance,
                                                     NoteRenderContext renderContext)

Get a PageableList of a NoteQueryParameters

Parameters:

noteQueryInstance - the prepared query instance

renderContext - the render context to use

Returns:

PageableList

setToForParameterUnspecificElements

public static void setToForParameterUnspecificElements(Boolean isHtml,
                                                       NoteStoringTO noteStoringTO)

Set elements of NoteStoringTO object that are the same in create or edit method

Parameters:

isHtml - is note text content html

noteStoringTO - NoteStoringTO

sortAndLimitNotes

public static List<NoteResource> sortAndLimitNotes(List<NoteResource> notesToSort,
                                                   Integer maxCount)

Sort the notes by date in ascending order and return a subset that contains at most maxCount notes, starting with the oldest

Parameters:

notesToSort - the notes to sort

maxCount - parameters to get a collection of notes

Returns:

the sorted sub set which is a view on the provided collection. The provided collection should therefore not be modified.