com.communote.plugins.api.rest.resource.timelinenote

Class TimelineNoteResourceConverter

java.lang.Object

com.communote.server.core.vo.query.QueryResultConverter<SimpleNoteListItem,TimelineNoteResource>

com.communote.plugins.api.rest.resource.timelinenote.TimelineNoteResourceConverter

public class TimelineNoteResourceConverter
extends QueryResultConverter<SimpleNoteListItem,TimelineNoteResource>

Converter to convert the query result depending on settings of the query instance. When a discussionId is set in the queryInstance the converter will return the notes of the discussion in threaded view order. Otherwise the items of the result will just be converted to the target type.

Author:

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

Constructor Summary

Constructors

Constructor and Description
TimelineNoteResourceConverter(NoteQueryParameters noteQueryInstance, NoteRenderContext renderContext) Creates a new converter which will convert the queryResult depending on settings of the query instance.

Method Summary

Modifier and Type	Method and Description
PageableList<TimelineNoteResource>	convert(DiscussionNoteData source) Helper method which flattens a discussion data object into a list of note resources.
PageableList<TimelineNoteResource>	convert(PageableList<SimpleNoteListItem> queryResult) Converts the temporary object of the query to a list object
boolean	convert(SimpleNoteListItem source, TimelineNoteResource target) Converts the temporary object of the query to a list object
TimelineNoteResource	create() Creates a new pageable list object to fill

Methods inherited from class com.communote.server.core.vo.query.QueryResultConverter

convertCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineNoteResourceConverter

public TimelineNoteResourceConverter(NoteQueryParameters noteQueryInstance,
                                     NoteRenderContext renderContext)

Creates a new converter which will convert the queryResult depending on settings of the query instance. When a discussionId is set in the queryInstance the converter will return the notes of the discussion in threaded view order. Otherwise the items of the result will just be converted to the target type.

Parameters:

noteQueryInstance - The query instance.

renderContext - the note render context to use

Method Detail

convert

public PageableList<TimelineNoteResource> convert(DiscussionNoteData source)

Helper method which flattens a discussion data object into a list of note resources. This list will contain the root note of the discussion as the first item, the following elements are the comments which are sorted the same way as within the discussion data object.

Parameters:

source - the object to convert

Returns:

the list of note resources

convert

public PageableList<TimelineNoteResource> convert(PageableList<SimpleNoteListItem> queryResult)

Converts the temporary object of the query to a list object

Overrides:

convert in class QueryResultConverter<SimpleNoteListItem,TimelineNoteResource>

Parameters:

queryResult - the temporary object returned by the executed query

Returns:

the pageable list object

convert

public boolean convert(SimpleNoteListItem source,
                       TimelineNoteResource target)

Converts the temporary object of the query to a list object

Specified by:

convert in class QueryResultConverter<SimpleNoteListItem,TimelineNoteResource>

Parameters:

source - The temporary object returned by the executed query

target - The converted list object

Returns:

A boolean, which decide to add or remove the object from the list.

create

public TimelineNoteResource create()

Creates a new pageable list object to fill

Specified by:

create in class QueryResultConverter<SimpleNoteListItem,TimelineNoteResource>

Returns:

pageable list object