com.atlassian.confluence.pages
Class AbstractPage

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.core.AbstractVersionedEntityObject
              com.atlassian.confluence.core.AbstractLabelableEntityObject
                  com.atlassian.confluence.core.ContentEntityObject
                      com.atlassian.confluence.core.SpaceContentEntityObject
                          com.atlassian.confluence.pages.AbstractPage

All Implemented Interfaces:

com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, HasLinkWikiMarkup, Versioned, EditableLabelable, Labelable, Spaced, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

BlogPost, Page

public abstract class AbstractPage
extends SpaceContentEntityObject
implements HasLinkWikiMarkup

Parent of the concrete Page and BlogPost classes

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.core.ContentEntityObject

CREATED, CURRENT, DELETED, MODIFIED

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

INITIAL_VERSION

Constructor Summary

AbstractPage()

Method Summary

void	convertToHistoricalVersion() Remove all data from the object that does not need to be saved by historical versions.
java.lang.String	getAttachmentsUrlPath()
java.lang.String	getAttachmentUrlPath(Attachment attachment) Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments).
ContentEntityObject	getContentEntityObject()
AbstractPage	getLatestVersion() Get the latest, current version of this versioned object.
AbstractPage	getOriginalVersionPage() if this page is a historical version, then this method returns the current/latest version of this page if this page is the latest version, then this returns null this method name should really be refactored to getCurrentVersionOfPage()
java.util.List<Comment>	getPageLevelComments()
int	getPreviousVersion() Convenience method to get the immediately prior version since we can't perform arithmetic in velocity (assume that versions are sequential) Method is used in email templates where session is not available.
java.util.Collection<com.atlassian.bonnie.Searchable>	getSearchableDependants()
java.util.List<Comment>	getTopLevelComments()
java.lang.String	getUrlPath()
static boolean	hasInvalidTitleCharacters(java.lang.String title) Deprecated.
static boolean	isValidPageTitle(java.lang.String title)
static boolean	isValidPageTitleCharacter(char c) Deprecated.
static boolean	isValidTitleLength(java.lang.String title)
void	remove(PageManager pageManager) Remove this page from the world.
void	setContentPropertiesFromDraft(Draft draft) Initialises the ContentProperties of this AbstractPage by performing a deep clone of the Draft object's properties.
void	setOriginalVersionPage(AbstractPage originalVersionPage)
void	setTitle(java.lang.String title)

Methods inherited from class com.atlassian.confluence.core.SpaceContentEntityObject

addTrackbackLink, getNameForComparison, getSpace, getSpaceKey, hashCode, isIndexable, isInSpace, setSpace

Methods inherited from class com.atlassian.confluence.core.ContentEntityObject

addAttachment, addComment, addCustomContent, addOutgoingLink, addPermission, addReferralLink, clone, compareTo, ensureAttachmentBelongsToContent, equals, getAttachmentNamed, getAttachments, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getBodyContents, getComments, getContentId, getContentPermission, getContentPermissionSet, getContentStatus, getDefaultBodyType, getDisplayTitle, getEntity, getExcerpt, getIdAsString, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getProperties, getReferralLinks, getRenderedVersionComment, getTitle, getTrackbackLinks, getType, getTypeEnum, getUserAccessor, getVersionComment, hasContentPermissions, hasPermissions, isCurrent, isDeleted, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeCustomContent, removeOutgoingLink, removeReferralLink, removeTrackbackLink, replaceContentProperties, restore, restoreDependents, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setComments, setContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, toString, trash, trashDependents

Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject

addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, isFavourite, removeLabelling, setLabellings

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

getOriginalVersion, getVersion, isLatestVersion, isNew, setOriginalVersion, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.core.HasLinkWikiMarkup

getLinkWikiMarkup

Methods inherited from interface com.atlassian.bonnie.Searchable

getId

Methods inherited from interface com.atlassian.confluence.core.Addressable

getId

Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable

getId, isPersistent

Constructor Detail

AbstractPage

public AbstractPage()

Method Detail

isValidPageTitle

public static boolean isValidPageTitle(java.lang.String title)

isValidTitleLength

public static boolean isValidTitleLength(java.lang.String title)

hasInvalidTitleCharacters

@Deprecated
public static boolean hasInvalidTitleCharacters(java.lang.String title)

Deprecated.

isValidPageTitleCharacter

@Deprecated
public static boolean isValidPageTitleCharacter(char c)

Deprecated.

getContentEntityObject

public ContentEntityObject getContentEntityObject()

setTitle

public void setTitle(java.lang.String title)

Overrides:

setTitle in class ContentEntityObject

convertToHistoricalVersion

public void convertToHistoricalVersion()

Description copied from interface: Versioned

Remove all data from the object that does not need to be saved by historical versions. For versioned objects that are persisted, this includes removing associations with other persisted objects that may otherwise cause us to break the expected arity of the database relations.

When using Hibernate to persist versioned objects, take special care to null any field that might contain a Hibernate-persisted collection, as Hibernate does not allow two different persistent objects to refer to the same persisted collection at the same time.

Specified by:

convertToHistoricalVersion in interface Versioned

Overrides:

convertToHistoricalVersion in class SpaceContentEntityObject

getOriginalVersionPage

public AbstractPage getOriginalVersionPage()

if this page is a historical version, then this method returns the current/latest version of this page if this page is the latest version, then this returns null this method name should really be refactored to getCurrentVersionOfPage()

setOriginalVersionPage

public void setOriginalVersionPage(AbstractPage originalVersionPage)

getPreviousVersion

public int getPreviousVersion()

Convenience method to get the immediately prior version since we can't perform arithmetic in velocity (assume that versions are sequential) Method is used in email templates where session is not available. Hence we cannot load previousVersions to return a page object

remove

public void remove(PageManager pageManager)

Remove this page from the world. This method should sever any inverse relationships this page may have with other objects.

getSearchableDependants

public java.util.Collection<com.atlassian.bonnie.Searchable> getSearchableDependants()

Specified by:

getSearchableDependants in interface com.atlassian.bonnie.Searchable

Overrides:

getSearchableDependants in class ContentEntityObject

getUrlPath

public java.lang.String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Specified by:

getUrlPath in class ContentEntityObject

getPageLevelComments

public java.util.List<Comment> getPageLevelComments()

Returns:

List of page-level (i.e. not inline) comments.

Since:

5.6

getTopLevelComments

public java.util.List<Comment> getTopLevelComments()

getAttachmentsUrlPath

public java.lang.String getAttachmentsUrlPath()

Overrides:

getAttachmentsUrlPath in class ContentEntityObject

getAttachmentUrlPath

public java.lang.String getAttachmentUrlPath(Attachment attachment)

Description copied from class: ContentEntityObject

Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments). Generally you will want to call Attachment.getUrlPath() instead of this method: if we ever implement view pages for individual attachments, that's the method that will be changed to point to them. The default implementation just returns the view page for this content.

Overrides:

getAttachmentUrlPath in class ContentEntityObject

Parameters:

attachment - one of this content's attachments

Returns:

the path relative to the base url to view the attachment in the context of this content.

getLatestVersion

public AbstractPage getLatestVersion()

Get the latest, current version of this versioned object. If this object is the current version, return this object.

Specified by:

getLatestVersion in interface Versioned

Overrides:

getLatestVersion in class AbstractVersionedEntityObject

Returns:

the current version of this object.

setContentPropertiesFromDraft

public void setContentPropertiesFromDraft(Draft draft)

Initialises the ContentProperties of this AbstractPage by performing a deep clone of the Draft object's properties.