com.communote.server.core.blog

Class NoteShortener

java.lang.Object

com.communote.server.core.blog.NoteShortener

public class NoteShortener
extends Object

Allows shortening the HTML content of a note to a given number of lines. The processNoteContent is not thread safe.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NoteShortener() Creates a NoteShortener with default settings.
NoteShortener(int maxShownLines, int maxCharsOnLine, int maxCharsOnLastLine, int indentCharsWidth) Creates a NoteShortener with custom settings.

Method Summary

Modifier and Type	Method and Description
String	processNoteContent(String content) Returns the shortened content or null if there is no need to shorten it.
static String	replaceReadMorePlaceHolder(String content, String replacement) Replaces the read more placeholder with a replacement (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteShortener

public NoteShortener()

Creates a NoteShortener with default settings.

NoteShortener

public NoteShortener(int maxShownLines,
                     int maxCharsOnLine,
                     int maxCharsOnLastLine,
                     int indentCharsWidth)

Creates a NoteShortener with custom settings.

Parameters:

maxShownLines - the maximum number of lines to be shown. All lines beyond this line will be cut.

maxCharsOnLine - the maximum number of characters that fit on a line before a line break is necessary.

maxCharsOnLastLine - the maximum number of characters to be allowed on the last shown line if cutting is necessary. A line that is the maxShownLine can have maxCharsOnLine characters.

indentCharsWidth - the number of characters that are consumed by an indent (e.g. caused by an ul tag)

Method Detail

replaceReadMorePlaceHolder

public static String replaceReadMorePlaceHolder(String content,
                                                String replacement)

Replaces the read more placeholder with a replacement (e.g. some link).

Parameters:

content - the content where the placeholder should be replaced

replacement - the replacement

Returns:

the modified content

processNoteContent

public String processNoteContent(String content)
                          throws NoteStoringPreProcessorException

Returns the shortened content or null if there is no need to shorten it. If the content was shortened a directly closed read-more-link placeholder (<rml/>) will be contained at the cut position.

Parameters:

content - the content to shorten

Returns:

the shortened content or null if there is no need to shorten it.

Throws:

NoteStoringPreProcessorException - in case content processing fails