|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.solidstategroup.cms.Article
public class Article
Implements an Article
| Field Summary | |
|---|---|
static int |
DEFAULT_TEMPLATE
|
protected float |
searchScore
|
static int |
STORE_CHECK_IN
|
static int |
STORE_CHECK_OUT
|
static int |
STORE_DELETE_ARTICLE
|
static int |
STORE_DELETE_SECTION
|
static int |
STORE_NOT_GIVEN
|
static int |
STORE_PUBLISH
|
static int |
STORE_REORDER_ARTICLES
|
static int |
STORE_REORDER_SECTIONS
|
static int |
STORE_RESTORE_PREVIOUS_VERSION
|
static int |
STORE_UNPUBLISH
|
static int |
STORE_USER_EDIT
|
| Constructor Summary | |
|---|---|
Article()
|
|
Article(int newArticleId,
java.lang.String newTitle,
int newRootArticleTypeId,
java.util.Date createdOn,
java.util.Date lastModified,
int lastModifiedBy,
int lockedBy,
boolean newpublish,
int newpriority,
int rootArticleId,
boolean includeInSearch,
boolean adhereToPublishDates,
java.lang.String articleTemplateId,
java.lang.String templateLocation,
java.lang.String templateTitle,
java.lang.String rssDescription,
java.lang.String metaDataDescription,
java.lang.String metaDataKeywords,
java.lang.String metaDataAuthor,
java.lang.String metaDataTitle,
boolean inheritMetaDataDescription,
boolean inheritMetaDataKeywords,
boolean inheritMetaDataAuthor,
boolean inheritMetaDataTitle,
int sessionType)
|
|
| Method Summary | |
|---|---|
boolean |
checkIn(com.solidstategroup.user.CMSUser checkingInUser)
|
boolean |
checkOut(com.solidstategroup.user.CMSUser checkingInUser)
|
void |
clear()
Removes all data from the Article. |
int |
compareTo(java.lang.Object a)
Used for sorting a Vector of Articles Natural sorting is by "created date" in reverse order, ie. |
boolean |
containsTag(int rootTagId)
|
boolean |
delete(int uniqueId)
Deletes the Article |
boolean |
deleteChunk(int chunkId)
Deletes a specific Chunk from within the Article |
boolean |
destroy(boolean deleteHistory)
Removes all versions of this article, all associate chunks and all associated assets. |
com.solidstategroup.cms.Chunks |
execute()
|
com.solidstategroup.cms.Chunks |
execute(boolean isPreview)
|
com.solidstategroup.cms.Chunks |
execute(boolean isPreview,
java.sql.Connection conn)
Retrieves the Article from the database |
com.solidstategroup.cms.Chunks |
execute(java.sql.Connection conn)
|
com.solidstategroup.cms.Chunks |
execute(int articleId)
Retreives the Article from the database |
void |
executeTags()
|
void |
executeTags(java.sql.Connection conn)
|
java.lang.String |
generateEditTag(javax.servlet.http.HttpServletRequest thisRequest)
|
com.solidstategroup.cms.Assets |
getArticleAssets()
Gets all the Assets within an article (in logical, Chunk order) |
com.solidstategroup.cms.Chunks |
getArticleChunks()
|
int |
getArticleId()
|
com.solidstategroup.cms.ArticleTemplate |
getArticleTemplate()
|
int |
getArticleTemplateId()
|
ArticleType |
getArticleType()
|
int |
getArticleTypeId()
|
java.lang.String |
getAssetData(java.lang.String thisAssetDescription)
Returns the data associated with the Asset |
java.util.Date |
getCreatedDate()
|
com.solidstategroup.cms.Tag |
getFirstChildOfParentTag(int parentRootTagId)
Works well if you have a collection of tags under a parent and generatlly only one will be tagged |
com.solidstategroup.user.CMSUser |
getLastModifiedBy()
|
java.util.Date |
getLastModifiedDate()
|
com.solidstategroup.user.CMSUser |
getLockedBy()
|
java.lang.String |
getMetaDataAuthor()
|
java.lang.String |
getMetaDataDescription()
|
java.lang.String |
getMetaDataKeywords()
|
java.lang.String |
getMetaDataTitle()
|
int |
getNextAvailablePriority(java.sql.Connection conn)
Returns the priority number of the next available chunk in the article |
int |
getNextPageNumber()
Returns The next page number of this article. |
int |
getNumberOfPages()
Returns the total number of pages that this article contains. |
int |
getPageNumber()
|
com.solidstategroup.cms.Chunks |
getPageOfChunks(int pageNumber)
Retrieves a 'page' of chunks from the article. |
int |
getPreviousPageNumber()
Returns the previous page number of this article. |
int |
getPriority()
|
java.util.Date |
getPublishFromDate()
|
java.util.Date |
getPublishToDate()
|
com.solidstategroup.cms.ArticleRating |
getRating()
|
java.lang.String |
getReasonForStore()
|
int |
getReasonForStoreId()
|
javax.servlet.http.HttpServletRequest |
getRequest()
|
int |
getRootArticleId()
|
int |
getRootArticleTypeId()
|
java.lang.String |
getRootTagsIdAsString()
Returns a comma separated list of rootTagIds |
java.lang.String |
getRssDescription()
|
float |
getSearchScore()
|
java.lang.String |
getSearchScore(int numberOfSignificantDigits)
|
int |
getSessionType()
|
com.solidstategroup.cms.Tag |
getTag(int rootTagId)
|
java.util.Vector |
getTags()
|
java.util.Vector |
getTags(int parentRootTagId)
returns a Vector of all the tags a article has until this parent |
java.lang.String |
getTitle()
|
java.lang.String |
getURL()
Returns the complete URL for this article |
boolean |
hasTag(int rootTagId)
|
boolean |
isAdhereToPublishDates()
|
boolean |
isCheckNewChunkAssets()
|
boolean |
isDeleted()
|
boolean |
isIncludeInSearch()
|
boolean |
isInheritMetaDataAuthor()
|
boolean |
isInheritMetaDataDescription()
|
boolean |
isInheritMetaDataKeywords()
|
boolean |
isInheritMetaDataTitle()
|
boolean |
isLocked()
|
boolean |
isLockedTransactional(java.sql.Connection conn)
Checks to see if the current Article is stale. |
boolean |
isPublish()
|
boolean |
isRipeForDateOnlyPublishing(java.util.Date baseDate)
|
boolean |
isStale()
Checks to see if the current Article is stale. |
boolean |
isStale(java.sql.Connection conn)
|
void |
lockArticle(com.solidstategroup.user.CMSUser thisUser,
java.sql.Connection conn)
Lock the article from being edited by another user |
java.lang.String |
render()
|
java.lang.String |
render(com.solidstategroup.cms.Chunk chunkToRender)
|
java.lang.String |
render(int renderType)
Generates the HTML for the every Asset in every Chunk in the Article up to the next page break |
java.lang.String |
renderPlainText()
Renders the entire article in plain text. |
java.lang.String |
renderPlainText(int numberOfCharactersToRender)
Renders the article in plain text. |
java.lang.String |
renderPlainText(int numberOfCharactersToRender,
int characterOffset)
Renders the article in plain text. |
java.lang.String |
renderPlainText(java.lang.String focusOnWord,
int numberOfCharsPadding)
Renders a fragment of the article in plain text, centered on the first instance of focus word encountered. |
java.lang.String |
renderSearch()
|
java.lang.String |
renderSearchResults(java.lang.String searchTerms,
int numberOfCharsPadding)
Displays the results of a search, focused on the first search term in the (space seperated) searchTerms String. |
java.lang.String |
renderSearchResults(java.lang.String searchTerms,
int numberOfCharsPadding,
java.lang.String prependString,
java.lang.String appendString)
Displays the results of a search, focused on the first search term in the (space seperated) searchTerms String. |
java.lang.String |
renderSummary()
|
void |
requestCheckedOutArticle(com.solidstategroup.user.CMSUser requestingUser)
Sends an email to the user locking the current Article, requesting it to be checked in |
void |
setAdhereToPublishDates(boolean adhereToPublishDates)
|
void |
setArticleChunks(com.solidstategroup.cms.Chunks articleChunks)
|
void |
setArticleId(int articleId)
|
void |
setArticleTemplate(com.solidstategroup.cms.ArticleTemplate articleTemplate)
|
void |
setArticleTemplateId(int articleTemplateId)
|
void |
setArticleType(ArticleType articleType)
|
void |
setArticleTypeId(int articleTypeId)
|
void |
setCheckNewChunkAssets(boolean checkNewChunkAssets)
|
void |
setCreatedDate(java.util.Date createdDate)
|
void |
setCreatedDateWithString(java.lang.String createdDate,
java.lang.String createdTime)
|
void |
setDeleted(boolean deleted)
|
void |
setIncludeInSearch(boolean includeInSearch)
|
void |
setInheritMetaDataAuthor(boolean inheritMetaDataAuthor)
|
void |
setInheritMetaDataDescription(boolean inheritMetaDataDescription)
|
void |
setInheritMetaDataKeywords(boolean inheritMetaDataKeywords)
|
void |
setInheritMetaDataTitle(boolean inheritMetaDataTitle)
|
void |
setLastModifiedBy(com.solidstategroup.user.CMSUser lastModifiedBy)
|
void |
setLastModifiedDate(java.util.Date lastModifiedDate)
|
void |
setLockedBy(com.solidstategroup.user.CMSUser lockedBy)
|
void |
setMetaDataAuthor(java.lang.String metaDataAuthor)
|
void |
setMetaDataDescription(java.lang.String metaDataDescription)
|
void |
setMetaDataKeywords(java.lang.String metaDataKeywords)
|
void |
setMetaDataTitle(java.lang.String metaDataTitle)
|
void |
setPageNumber(int pageNumber)
|
void |
setPriority(int priority)
|
void |
setPublish(boolean publish)
|
void |
setPublishFromDate(java.util.Date publishFromDate)
|
void |
setPublishFromDateWithString(java.lang.String publishFromDate,
java.lang.String publishFromTime)
|
void |
setPublishToDate(java.util.Date publishToDate)
|
void |
setPublishToDateWithString(java.lang.String publishToDate,
java.lang.String publishToTime)
|
void |
setRating(com.solidstategroup.cms.ArticleRating rating)
|
void |
setReasonForStore(java.lang.String reasonForStore)
|
void |
setReasonForStoreId(int reasonForStoreId)
|
void |
setRequest(javax.servlet.http.HttpServletRequest request)
|
void |
setRootArticleId(int rootArticleId)
|
void |
setRootArticleTypeId(int rootArticleTypeId)
|
void |
setRssDescription(java.lang.String rssDescription)
|
void |
setSessionType(int sessionType)
|
void |
setTags(java.util.Vector tags)
|
void |
setTitle(java.lang.String thistitle)
|
boolean |
store()
Stores the Article in the database |
boolean |
store(boolean isCheckOut)
|
boolean |
store(boolean isCheckOut,
java.sql.Connection conn)
Stores the Article in the database |
java.lang.String |
toString()
|
void |
unlockArticle(java.sql.Connection conn)
Unlocks the current Article |
com.solidstategroup.cms.Asset |
updateAssetData(com.solidstategroup.cms.Asset newAsset,
int chunkId)
Stores an updated asset in the article |
com.solidstategroup.cms.Asset |
updateAssetData(com.solidstategroup.cms.Asset newAsset,
java.lang.String data,
int chunkId)
|
boolean |
updateTags(java.sql.Connection conn)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int STORE_USER_EDIT
public static final int STORE_PUBLISH
public static final int STORE_UNPUBLISH
public static final int STORE_CHECK_IN
public static final int STORE_CHECK_OUT
public static final int STORE_DELETE_ARTICLE
public static final int STORE_REORDER_SECTIONS
public static final int STORE_REORDER_ARTICLES
public static final int STORE_DELETE_SECTION
public static final int STORE_RESTORE_PREVIOUS_VERSION
public static final int STORE_NOT_GIVEN
public static final int DEFAULT_TEMPLATE
protected float searchScore
| Constructor Detail |
|---|
public Article()
public Article(int newArticleId,
java.lang.String newTitle,
int newRootArticleTypeId,
java.util.Date createdOn,
java.util.Date lastModified,
int lastModifiedBy,
int lockedBy,
boolean newpublish,
int newpriority,
int rootArticleId,
boolean includeInSearch,
boolean adhereToPublishDates,
java.lang.String articleTemplateId,
java.lang.String templateLocation,
java.lang.String templateTitle,
java.lang.String rssDescription,
java.lang.String metaDataDescription,
java.lang.String metaDataKeywords,
java.lang.String metaDataAuthor,
java.lang.String metaDataTitle,
boolean inheritMetaDataDescription,
boolean inheritMetaDataKeywords,
boolean inheritMetaDataAuthor,
boolean inheritMetaDataTitle,
int sessionType)
| Method Detail |
|---|
public int compareTo(java.lang.Object a)
compareTo in interface java.lang.Comparablepublic void clear()
public void executeTags()
public void executeTags(java.sql.Connection conn)
public boolean updateTags(java.sql.Connection conn)
public boolean containsTag(int rootTagId)
public java.lang.String render(int renderType)
public java.lang.String render()
public java.lang.String renderSummary()
public java.lang.String renderSearch()
public java.lang.String render(com.solidstategroup.cms.Chunk chunkToRender)
public java.lang.String renderPlainText(int numberOfCharactersToRender,
int characterOffset)
numberOfCharactersToRender - The number of characters to render from the beginning of the articlecharacterOffset - the number of characters to ignore at the start of the article
public java.lang.String renderPlainText(int numberOfCharactersToRender)
numberOfCharactersToRender - The number of characters to render from the beginning of the article
public java.lang.String renderPlainText()
public java.lang.String renderPlainText(java.lang.String focusOnWord,
int numberOfCharsPadding)
focusOnWord - The word to center on (case of word is ignored)numberOfCharsPadding - The number of characters to render each side of the focus word
public java.lang.String renderSearchResults(java.lang.String searchTerms,
int numberOfCharsPadding,
java.lang.String prependString,
java.lang.String appendString)
searchTerms - numberOfCharsPadding - prependString - appendString -
public java.lang.String renderSearchResults(java.lang.String searchTerms,
int numberOfCharsPadding)
searchTerms - numberOfCharsPadding - public com.solidstategroup.cms.Chunks execute(int articleId)
articleId - The desired ID of the Article to retrieve
public com.solidstategroup.cms.Chunks execute()
public com.solidstategroup.cms.Chunks execute(java.sql.Connection conn)
public com.solidstategroup.cms.Chunks execute(boolean isPreview)
public com.solidstategroup.cms.Chunks execute(boolean isPreview,
java.sql.Connection conn)
public com.solidstategroup.cms.Asset updateAssetData(com.solidstategroup.cms.Asset newAsset,
java.lang.String data,
int chunkId)
newAsset - The original asset that is to be updateddata - The new piece of data
public com.solidstategroup.cms.Chunks getPageOfChunks(int pageNumber)
pageNumber - The current page number to retrieve
public int getNumberOfPages()
public int getNextPageNumber()
public int getPreviousPageNumber()
public com.solidstategroup.cms.Asset updateAssetData(com.solidstategroup.cms.Asset newAsset,
int chunkId)
newAsset - The updated assetchunkId - the Chunk ID that this Asset belongs to
public boolean store()
public boolean store(boolean isCheckOut)
public boolean store(boolean isCheckOut,
java.sql.Connection conn)
isCheckOut - Boolean stating whether we are simply checking out this Article
public boolean deleteChunk(int chunkId)
chunkId - The Chunk ID to be deleted
public boolean delete(int uniqueId)
uniqueId - The ID of the Article to be deleted
public boolean destroy(boolean deleteHistory)
public java.lang.String getAssetData(java.lang.String thisAssetDescription)
thisAssetDescription - The description of the Asset Data (as defined by the type of Asset)
public com.solidstategroup.cms.Assets getArticleAssets()
public int getNextAvailablePriority(java.sql.Connection conn)
public void lockArticle(com.solidstategroup.user.CMSUser thisUser,
java.sql.Connection conn)
thisUser - The User locking the Articlepublic void unlockArticle(java.sql.Connection conn)
public boolean isStale()
public boolean isStale(java.sql.Connection conn)
public boolean isLockedTransactional(java.sql.Connection conn)
public void requestCheckedOutArticle(com.solidstategroup.user.CMSUser requestingUser)
requestingUser - The User requesting the Article to be unlocked.public java.lang.String generateEditTag(javax.servlet.http.HttpServletRequest thisRequest)
public java.lang.String getURL()
public java.lang.String getTitle()
public void setTitle(java.lang.String thistitle)
public void setArticleChunks(com.solidstategroup.cms.Chunks articleChunks)
public com.solidstategroup.cms.Chunks getArticleChunks()
public void setArticleId(int articleId)
public int getArticleId()
public void setCreatedDate(java.util.Date createdDate)
public java.util.Date getCreatedDate()
public void setCreatedDateWithString(java.lang.String createdDate,
java.lang.String createdTime)
public void setLastModifiedDate(java.util.Date lastModifiedDate)
public java.util.Date getLastModifiedDate()
public void setArticleTypeId(int articleTypeId)
public int getArticleTypeId()
public void setRootArticleTypeId(int rootArticleTypeId)
public int getRootArticleTypeId()
public void setPublish(boolean publish)
public boolean isPublish()
public void setDeleted(boolean deleted)
public boolean isDeleted()
public void setPriority(int priority)
public int getPriority()
public ArticleType getArticleType()
public void setArticleType(ArticleType articleType)
public int getRootArticleId()
public void setRootArticleId(int rootArticleId)
public int getPageNumber()
public void setPageNumber(int pageNumber)
public com.solidstategroup.user.CMSUser getLastModifiedBy()
public void setLastModifiedBy(com.solidstategroup.user.CMSUser lastModifiedBy)
public com.solidstategroup.user.CMSUser getLockedBy()
public void setLockedBy(com.solidstategroup.user.CMSUser lockedBy)
public boolean isLocked()
public java.util.Date getPublishFromDate()
public void setPublishFromDate(java.util.Date publishFromDate)
public void setPublishFromDateWithString(java.lang.String publishFromDate,
java.lang.String publishFromTime)
public java.util.Date getPublishToDate()
public void setPublishToDate(java.util.Date publishToDate)
public void setPublishToDateWithString(java.lang.String publishToDate,
java.lang.String publishToTime)
public int getReasonForStoreId()
public void setReasonForStoreId(int reasonForStoreId)
public java.lang.String getReasonForStore()
public void setReasonForStore(java.lang.String reasonForStore)
public boolean isCheckNewChunkAssets()
public void setCheckNewChunkAssets(boolean checkNewChunkAssets)
public boolean isIncludeInSearch()
public void setIncludeInSearch(boolean includeInSearch)
public boolean isAdhereToPublishDates()
public void setAdhereToPublishDates(boolean adhereToPublishDates)
public com.solidstategroup.cms.ArticleTemplate getArticleTemplate()
public void setArticleTemplate(com.solidstategroup.cms.ArticleTemplate articleTemplate)
public void setArticleTemplateId(int articleTemplateId)
public int getArticleTemplateId()
public float getSearchScore()
public java.lang.String getSearchScore(int numberOfSignificantDigits)
public java.lang.String getRssDescription()
public void setRssDescription(java.lang.String rssDescription)
public int getSessionType()
public void setSessionType(int sessionType)
public java.lang.String toString()
toString in class java.lang.Objectpublic boolean checkIn(com.solidstategroup.user.CMSUser checkingInUser)
public boolean checkOut(com.solidstategroup.user.CMSUser checkingInUser)
public com.solidstategroup.cms.ArticleRating getRating()
public void setRating(com.solidstategroup.cms.ArticleRating rating)
public javax.servlet.http.HttpServletRequest getRequest()
public void setRequest(javax.servlet.http.HttpServletRequest request)
public java.lang.String getMetaDataTitle()
public void setMetaDataTitle(java.lang.String metaDataTitle)
public java.lang.String getMetaDataAuthor()
public void setMetaDataAuthor(java.lang.String metaDataAuthor)
public java.lang.String getMetaDataDescription()
public void setMetaDataDescription(java.lang.String metaDataDescription)
public java.lang.String getMetaDataKeywords()
public void setMetaDataKeywords(java.lang.String metaDataKeywords)
public boolean isInheritMetaDataAuthor()
public void setInheritMetaDataAuthor(boolean inheritMetaDataAuthor)
public boolean isInheritMetaDataDescription()
public void setInheritMetaDataDescription(boolean inheritMetaDataDescription)
public boolean isInheritMetaDataKeywords()
public void setInheritMetaDataKeywords(boolean inheritMetaDataKeywords)
public boolean isInheritMetaDataTitle()
public void setInheritMetaDataTitle(boolean inheritMetaDataTitle)
public java.util.Vector getTags()
public java.lang.String getRootTagsIdAsString()
public boolean hasTag(int rootTagId)
public com.solidstategroup.cms.Tag getTag(int rootTagId)
public void setTags(java.util.Vector tags)
public com.solidstategroup.cms.Tag getFirstChildOfParentTag(int parentRootTagId)
public java.util.Vector getTags(int parentRootTagId)
public boolean isRipeForDateOnlyPublishing(java.util.Date baseDate)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||