org.randomcoder.article
Class ArticleDecorator

java.lang.Object
  org.randomcoder.article.ArticleDecorator

public class ArticleDecorator
extends Object

Helper class which "decorates" an Article instance by providing XHTML formatting support.

 Copyright (c) 2006, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

Constructor Summary

ArticleDecorator(Article article, ContentFilter filter)
Creates a new decorator using the given article and content filter.

Method Summary

Article	getArticle() Gets the wrapped article.
List<CommentDecorator>	getComments() Gets the comments for this article;
String	getFormattedSummary() Gets article summary after applying filters and HTML escaping.
String	getFormattedText() Gets article content after applying filters and HTML escaping.
boolean	isSummaryPresent() Determines if a summary is present for this article.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArticleDecorator

public ArticleDecorator(Article article,
                        ContentFilter filter)

Creates a new decorator using the given article and content filter.

Parameters:

article - article to decorate

filter - content filter to parse content with

Method Detail

getArticle

public Article getArticle()

Gets the wrapped article.

Returns:

article instance

getComments

public List<CommentDecorator> getComments()

Gets the comments for this article;

Returns:

comment list

isSummaryPresent

public boolean isSummaryPresent()

Determines if a summary is present for this article.

Returns:

true if summary exists, false otherwise

getFormattedText

public String getFormattedText()
                        throws TransformerException,
                               IOException,
                               SAXException

Gets article content after applying filters and HTML escaping.

Returns:

String containing the article content in XHTML.

Throws:

TransformerException - if filtering fails

IOException - if an I/O error occurs

SAXException - if parsing fails

getFormattedSummary

public String getFormattedSummary()
                           throws TransformerException,
                                  IOException,
                                  SAXException

Gets article summary after applying filters and HTML escaping.

Returns:

String containing the article summary in XHTML.

Throws:

TransformerException - if filtering fails

IOException - if an I/O error occurs

SAXException - if parsing fails