|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.pebble.domain.TimePeriod
net.sourceforge.pebble.domain.AbstractBlog
net.sourceforge.pebble.domain.Blog
public class Blog
Represents a blog.
Field Summary | |
---|---|
static java.lang.String |
ABOUT_KEY
|
static java.lang.String |
BLOG_CONTRIBUTORS_KEY
|
static java.lang.String |
BLOG_ENTRY_LISTENERS_KEY
|
static java.lang.String |
BLOG_LISTENERS_KEY
|
static java.lang.String |
BLOG_OWNERS_KEY
|
static java.lang.String |
BLOG_PUBLISHERS_KEY
|
static java.lang.String |
BLOG_READERS_KEY
|
static java.lang.String |
COMMENT_CONFIRMATION_STRATEGY_KEY
|
static java.lang.String |
COMMENT_LISTENERS_KEY
|
static java.lang.String |
CONTENT_DECORATORS_KEY
|
static java.lang.String |
EMAIL_KEY
|
static java.lang.String |
EVENT_DISPATCHER_KEY
|
static java.lang.String |
HOME_PAGE_KEY
|
static java.lang.String |
LOGGER_KEY
|
static java.lang.String |
LUCENE_ANALYZER_KEY
|
static java.lang.String |
PERMALINK_PROVIDER_KEY
|
static java.lang.String |
PRIVATE_KEY
|
static java.lang.String |
RICH_TEXT_EDITOR_FOR_COMMENTS_ENABLED_KEY
|
static java.lang.String |
TRACKBACK_CONFIRMATION_STRATEGY_KEY
|
static java.lang.String |
TRACKBACK_LISTENERS_KEY
|
Fields inherited from class net.sourceforge.pebble.domain.AbstractBlog |
---|
AUTHOR_KEY, BLOG_PROPERTIES_FILE, CHARACTER_ENCODING_KEY, COUNTRY_KEY, DESCRIPTION_KEY, FALSE, IMAGE_KEY, LANGUAGE_KEY, NAME_KEY, properties, RECENT_BLOG_ENTRIES_ON_HOME_PAGE_KEY, RECENT_RESPONSES_ON_HOME_PAGE_KEY, THEME_KEY, TIMEZONE_KEY, TRUE |
Constructor Summary | |
---|---|
Blog(java.lang.String root)
Creates a new Blog instance, based at the specified location. |
Method Summary | |
---|---|
void |
addCategory(Category category)
Adds a category. |
boolean |
equals(java.lang.Object o)
Indicates whether some other object is "equal to" this one. |
java.lang.String |
getAbout()
Gets the about description of this blog. |
java.util.List<java.lang.String> |
getApprovedResponses()
Gets the list of approved responses. |
java.util.List<Year> |
getArchives()
Gets all Years managed by this root blog, in reverse order. |
AuthorIndex |
getAuthorIndex()
Gets the author index. |
java.util.List<java.lang.String> |
getBlogContributors()
Gets a list of the users that are blog contributors for this blog. |
java.lang.String |
getBlogContributorsAsString()
Gets a comma separated list of the users that are blog contributors for this blog. |
java.util.List |
getBlogEntries()
Gets all blog entries for this blog. |
java.util.List<BlogEntry> |
getBlogEntries(java.util.List<java.lang.String> blogEntryIds)
Gets blog entries for a given list of IDs. |
Cache |
getBlogEntryCache()
|
BlogEntryIndex |
getBlogEntryIndex()
Gets the blog entry index. |
java.lang.String |
getBlogEntryListeners()
Gets the list of blog entry listeners as a String. |
Day |
getBlogForDay(java.util.Date date)
Gets a Day intance for the specified Date. |
Day |
getBlogForDay(int year,
int month,
int day)
Gets a Day intance for the specified year, month and day. |
Month |
getBlogForFirstMonth()
Gets the Month instance representing the first month that contains blog entries. |
Month |
getBlogForMonth(int year,
int month)
Gets a Month intance for the specified year and month. |
Year |
getBlogForNextYear(Year year)
Given a Year, this method returns the Year instance representing the next year. |
Year |
getBlogForPreviousYear(Year year)
Given a Year, this method returns the Year instance representing the previous year. |
Month |
getBlogForThisMonth()
Gets the Month instance representing this month. |
Year |
getBlogForThisYear()
Gets the Year instance representing this year. |
Day |
getBlogForToday()
Gets the Day instance for today. |
Year |
getBlogForYear(int year)
Gets the Year instance for the specified year. |
java.lang.String |
getBlogListeners()
Gets the list of blog listeners as a String. |
java.util.List<java.lang.String> |
getBlogOwners()
Gets a list of the users that are blog owners for this blog. |
java.lang.String |
getBlogOwnersAsString()
Gets a comma separated list of the users that are blog owners for this blog. |
java.util.List<java.lang.String> |
getBlogPublishers()
Gets a list of the users that are blog publishers for this blog. |
java.lang.String |
getBlogPublishersAsString()
Gets a comma separated list of the users that are blog publishers for this blog. |
java.util.List<java.lang.String> |
getBlogReaders()
Gets a list of the users that are blog readers for this blog. |
java.lang.String |
getBlogReadersAsString()
Gets a comma separated list of the users that are blog readers for this blog. |
java.util.List<Category> |
getCategories()
Gets the categories associated with this blog. |
Category |
getCategory(java.lang.String id)
Gets a specific category. |
CategoryIndex |
getCategoryIndex()
Gets the category index. |
CommentConfirmationStrategy |
getCommentConfirmationStrategy()
|
java.lang.String |
getCommentConfirmationStrategyName()
|
java.lang.String |
getCommentListeners()
Gets the list of comment listeners as a String. |
ContentDecoratorChain |
getContentDecoratorChain()
Gets the decorator manager associated with this blog. |
java.lang.String |
getContentDecorators()
Gets the list of plugins. |
java.util.Date |
getDateOfLastResponse()
Gets the date of the most recent response. |
protected java.util.Properties |
getDefaultProperties()
Gets the default properties for a Blog. |
Theme |
getEditableTheme()
Gets an object representing the editable theme. |
java.lang.String |
getEmail()
Gets the e-mail address of the blog owner. |
java.util.Collection |
getEmailAddresses()
Gets a Collection of e-mail addresses. |
EmailSubscriptionList |
getEmailSubscriptionList()
|
EventDispatcher |
getEventDispatcher()
Gets the event dispatcher in use. |
java.lang.String |
getEventDispatcherName()
Gets the name the event dispatcher. |
EventListenerList |
getEventListenerList()
Gets the event listsner list. |
java.lang.String |
getFilesDirectory()
Gets the location where the blog files are stored. |
java.lang.String |
getFirstEmailAddress()
Gets the first of multiple e-mail addresses. |
java.lang.String |
getHomePage()
Gets the home page to be used for this blog. |
java.lang.String |
getId()
Gets the ID of this blog. |
java.util.Date |
getLastModified()
Gets the date that this blog was last updated through the addition of a blog entry. |
AbstractLogger |
getLogger()
Gets the logger associated with this blog. |
java.lang.String |
getLoggerName()
Gets the name of the logger in use. |
java.lang.String |
getLuceneAnalyzer()
Gets the name of the Lucene analyzer to use. |
java.util.List<NewsFeedEntry> |
getNewsFeedEntries()
|
BlogEntry |
getNextBlogEntry(BlogEntry blogEntry)
|
int |
getNumberOfApprovedResponses()
Gets the number of approved responses. |
int |
getNumberOfBlogEntries()
Gets the number of blog entries for this blog. |
int |
getNumberOfPendingResponses()
Gets the number of pending responses. |
int |
getNumberOfPublishedBlogEntries()
Gets the number of published blog entries for this blog. |
int |
getNumberOfRejectedResponses()
Gets the number of rejected responses. |
int |
getNumberOfResponses()
Gets the number of responses. |
int |
getNumberOfStaticPages()
Gets the number of static pages for this blog. |
int |
getNumberOfUnpublishedBlogEntries()
Gets the number of unpublished blog entries for this blog. |
java.util.List<java.lang.String> |
getPendingResponses()
Gets the list of pending responses. |
PermalinkProvider |
getPermalinkProvider()
Gets the permalink provider in use. |
java.lang.String |
getPermalinkProviderName()
Gets the name of the permalink provider. |
PluginProperties |
getPluginProperties()
|
java.lang.String |
getPluginPropertiesFile()
Gets the location where the plugin properties file is stored. |
BlogEntry |
getPreviousBlogEntry(BlogEntry blogEntry)
|
java.util.List<Response> |
getRecentApprovedResponses()
Gets the most recent responses. |
java.util.List |
getRecentBlogEntries(int numberOfEntries)
Gets the most recent blog entries, the number of which is specified. |
java.util.List<NewsFeedEntry> |
getRecentNewsFeedEntries()
|
java.util.List |
getRecentPublishedBlogEntries()
Gets the most recent published blog entries, the number of which is taken from the recentBlogEntriesOnHomePage property. |
java.util.List |
getRecentPublishedBlogEntries(Category category)
Gets the most recent published blog entries for a given category, the number of which is taken from the recentBlogEntriesOnHomePage property. |
java.util.List |
getRecentPublishedBlogEntries(int number)
Gets the most recent published blog entries, the number of which is specified |
java.util.List |
getRecentPublishedBlogEntries(java.lang.String author)
Gets the most recent published blog entries for a given category, the number of which is taken from the recentBlogEntriesOnHomePage property. |
java.util.List |
getRecentPublishedBlogEntries(Tag tag)
Gets the most recent published blog entries for a given tag, the number of which is taken from the recentBlogEntriesOnHomePage property. |
RefererFilterManager |
getRefererFilterManager()
Gets the object managing referer filters. |
java.util.List<java.lang.String> |
getRejectedResponses()
Gets the list of rejected responses. |
java.lang.String |
getRelativeUrl()
Gets the relative URL where this blog is deployed. |
ResponseIndex |
getResponseIndex()
Gets the response index. |
Category |
getRootCategory()
Gets the root category for this blog. |
SearchIndex |
getSearchIndex()
Gets the search index. |
StaticPageIndex |
getStaticPageIndex()
Gets the story index. |
Tag |
getTag(java.lang.String name)
Gets the tag with the specified name. |
TagIndex |
getTagIndex()
Gets the tag index. |
java.util.List<Tag> |
getTags()
Gets the list of tags associated with this blog. |
java.lang.String |
getThemeDirectory()
Gets the location where the blog theme is stored. |
TrackBackConfirmationStrategy |
getTrackBackConfirmationStrategy()
|
java.lang.String |
getTrackBackConfirmationStrategyName()
|
java.lang.String |
getTrackBackListeners()
Gets the list of TrackBack listeners as a String. |
java.util.List<BlogEntry> |
getUnpublishedBlogEntries()
Gets all unpublished blog entries for this blog. |
java.lang.String |
getUrl()
Gets the URL where this blog is deployed. |
java.util.Collection |
getUsersInRole(java.lang.String roleName)
Gets a Collection containing the names of users that are blog owners for this blog. |
java.util.List |
getYears()
Gets all Years managed by this root blog. |
protected void |
init()
|
boolean |
isPrivate()
Determines whether this blog is private. |
boolean |
isPublic()
Determines whether this blog is public. |
boolean |
isRichTextEditorForCommentsEnabled()
|
boolean |
isUserInRole(java.lang.String roleName,
java.lang.String user)
Determines whether the specified user is in the specified role. |
void |
log(HttpServletRequest request,
int status)
Logs this request for blog. |
void |
reindex()
|
void |
removeCategory(Category category)
Removes a category. |
void |
setBlogEntryCache(Cache blogEntryCache)
|
void |
setEditableTheme(Theme editableTheme)
Sets an object representing the editable theme. |
void |
setId(java.lang.String id)
Sets the ID of this blog. |
void |
setPermalinkProvider(PermalinkProvider provider)
Sets the permalink provider in use. |
void |
setRootCategory(Category category)
Sets the root category for this blog. |
Methods inherited from class net.sourceforge.pebble.domain.AbstractBlog |
---|
clearMessages, error, getAuthor, getCalendar, getCharacterEncoding, getContext, getCountry, getDescription, getDomainName, getImage, getImagesDirectory, getIndexesDirectory, getLanguage, getLocale, getLogsDirectory, getMessages, getName, getNumberOfMessages, getProperties, getProperty, getProtocol, getRecentBlogEntries, getRecentBlogEntriesOnHomePage, getRecentResponsesOnHomePage, getRoot, getSearchIndexDirectory, getTheme, getTimeZone, getTimeZoneId, info, isConfigured, loadProperties, removeProperty, setProperty, setRecentBlogEntries, setRoot, storeProperties, toString, warn |
Methods inherited from class net.sourceforge.pebble.domain.TimePeriod |
---|
getBlog, getDate, setDate |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ABOUT_KEY
public static final java.lang.String EMAIL_KEY
public static final java.lang.String BLOG_OWNERS_KEY
public static final java.lang.String BLOG_PUBLISHERS_KEY
public static final java.lang.String BLOG_CONTRIBUTORS_KEY
public static final java.lang.String BLOG_READERS_KEY
public static final java.lang.String PRIVATE_KEY
public static final java.lang.String LUCENE_ANALYZER_KEY
public static final java.lang.String CONTENT_DECORATORS_KEY
public static final java.lang.String BLOG_LISTENERS_KEY
public static final java.lang.String BLOG_ENTRY_LISTENERS_KEY
public static final java.lang.String COMMENT_LISTENERS_KEY
public static final java.lang.String TRACKBACK_LISTENERS_KEY
public static final java.lang.String EVENT_DISPATCHER_KEY
public static final java.lang.String LOGGER_KEY
public static final java.lang.String PERMALINK_PROVIDER_KEY
public static final java.lang.String COMMENT_CONFIRMATION_STRATEGY_KEY
public static final java.lang.String TRACKBACK_CONFIRMATION_STRATEGY_KEY
public static final java.lang.String RICH_TEXT_EDITOR_FOR_COMMENTS_ENABLED_KEY
public static final java.lang.String HOME_PAGE_KEY
Constructor Detail |
---|
public Blog(java.lang.String root)
root
- an absolute path pointing to the root directory of the blogMethod Detail |
---|
protected void init()
init
in class AbstractBlog
protected java.util.Properties getDefaultProperties()
getDefaultProperties
in class AbstractBlog
public java.lang.String getId()
getId
in class AbstractBlog
public void setId(java.lang.String id)
id
- the ID as a Stringpublic java.lang.String getUrl()
getUrl
in class AbstractBlog
public java.lang.String getRelativeUrl()
getRelativeUrl
in class AbstractBlog
public java.lang.String getAbout()
public java.lang.String getHomePage()
public java.lang.String getEmail()
public java.util.Collection getEmailAddresses()
public java.lang.String getFirstEmailAddress()
public java.lang.String getBlogOwnersAsString()
public java.util.List<java.lang.String> getBlogOwners()
public java.lang.String getBlogPublishersAsString()
public java.util.List<java.lang.String> getBlogPublishers()
public java.lang.String getBlogContributorsAsString()
public java.util.List<java.lang.String> getBlogContributors()
public java.lang.String getBlogReadersAsString()
public java.util.List<java.lang.String> getBlogReaders()
public java.lang.String getLuceneAnalyzer()
public java.lang.String getLoggerName()
public java.util.Collection getUsersInRole(java.lang.String roleName)
public boolean isUserInRole(java.lang.String roleName, java.lang.String user)
roleName
- the name of the roleuser
- the name of the user
public Year getBlogForYear(int year)
year
- the year as an int (e.g. 2003)
public Year getBlogForThisYear()
public java.util.List getYears()
public java.util.List<Year> getArchives()
public Month getBlogForFirstMonth()
public Day getBlogForDay(java.util.Date date)
date
- a java.util.Date instance
public Day getBlogForToday()
public Day getBlogForDay(int year, int month, int day)
year
- the year as an intmonth
- the month as an intday
- the day as an int
public Month getBlogForMonth(int year, int month)
year
- the year as an intmonth
- the month as an int
public Month getBlogForThisMonth()
public Year getBlogForPreviousYear(Year year)
year
- a Year instance
public Year getBlogForNextYear(Year year)
year
- a Year instance
public java.util.List getBlogEntries()
public java.util.List<BlogEntry> getUnpublishedBlogEntries()
public int getNumberOfBlogEntries()
public int getNumberOfPublishedBlogEntries()
public int getNumberOfUnpublishedBlogEntries()
public int getNumberOfStaticPages()
public java.util.List getRecentBlogEntries(int numberOfEntries)
getRecentBlogEntries
in class AbstractBlog
numberOfEntries
- the number of entries to get
public java.util.List getRecentPublishedBlogEntries()
public java.util.List getRecentPublishedBlogEntries(int number)
number
- the number of blog entries to get
public java.util.List<BlogEntry> getBlogEntries(java.util.List<java.lang.String> blogEntryIds)
blogEntryIds
- the list of blog entry IDs
public java.util.List getRecentPublishedBlogEntries(Category category)
category
- a category
public java.util.List getRecentPublishedBlogEntries(java.lang.String author)
author
- the author's username
public java.util.List getRecentPublishedBlogEntries(Tag tag)
tag
- a tag
public java.util.List<Response> getRecentApprovedResponses()
public java.util.List<java.lang.String> getApprovedResponses()
public java.util.List<java.lang.String> getPendingResponses()
public java.util.List<java.lang.String> getRejectedResponses()
public int getNumberOfResponses()
public int getNumberOfApprovedResponses()
public int getNumberOfPendingResponses()
public int getNumberOfRejectedResponses()
public java.util.Date getLastModified()
getLastModified
in class AbstractBlog
public java.util.Date getDateOfLastResponse()
public BlogEntry getPreviousBlogEntry(BlogEntry blogEntry)
public BlogEntry getNextBlogEntry(BlogEntry blogEntry)
public java.util.List<Category> getCategories()
public Category getCategory(java.lang.String id)
public Category getRootCategory()
public void setRootCategory(Category category)
category
- a Category instancepublic void addCategory(Category category)
category
- the Category to be addedpublic void removeCategory(Category category)
category
- the Category to be removedpublic java.util.List<Tag> getTags()
public Tag getTag(java.lang.String name)
name
- the name as a String
public RefererFilterManager getRefererFilterManager()
public SearchIndex getSearchIndex()
public BlogEntryIndex getBlogEntryIndex()
public ResponseIndex getResponseIndex()
public TagIndex getTagIndex()
public CategoryIndex getCategoryIndex()
public AuthorIndex getAuthorIndex()
public StaticPageIndex getStaticPageIndex()
public void log(HttpServletRequest request, int status)
log
in class AbstractBlog
request
- the HttpServletRequest instance for this requestpublic Theme getEditableTheme()
public void setEditableTheme(Theme editableTheme)
editableTheme
- an EditableTheme instancepublic java.lang.String getFilesDirectory()
public java.lang.String getThemeDirectory()
public java.lang.String getPluginPropertiesFile()
public boolean isPublic()
public boolean isPrivate()
public AbstractLogger getLogger()
public java.lang.String getContentDecorators()
public ContentDecoratorChain getContentDecoratorChain()
public java.lang.String getBlogListeners()
public java.lang.String getBlogEntryListeners()
public java.lang.String getCommentListeners()
public java.lang.String getTrackBackListeners()
public java.lang.String getEventDispatcherName()
public EventDispatcher getEventDispatcher()
public EventListenerList getEventListenerList()
public PluginProperties getPluginProperties()
public java.lang.String getPermalinkProviderName()
public PermalinkProvider getPermalinkProvider()
public void setPermalinkProvider(PermalinkProvider provider)
provider
- PermalinkProvider instancepublic void reindex()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- the reference object with which to compare.
true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
Hashtable
public java.lang.String getCommentConfirmationStrategyName()
public CommentConfirmationStrategy getCommentConfirmationStrategy()
public java.lang.String getTrackBackConfirmationStrategyName()
public TrackBackConfirmationStrategy getTrackBackConfirmationStrategy()
public Cache getBlogEntryCache()
public void setBlogEntryCache(Cache blogEntryCache)
public boolean isRichTextEditorForCommentsEnabled()
public EmailSubscriptionList getEmailSubscriptionList()
public java.util.List<NewsFeedEntry> getNewsFeedEntries()
public java.util.List<NewsFeedEntry> getRecentNewsFeedEntries()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |