org.jboss.wiki
Interface AttachmentDataSource

public interface AttachmentDataSource

Author:

Tomasz Szymanski

Field Summary

static java.lang.String

attTrashName

Method Summary

void	addAttachment(java.io.File attFile, java.lang.String attName, org.jboss.wiki.WikiPage page, java.lang.String user) Add atachment to a given page.
boolean	deleteAttachment(java.lang.String pageName, java.lang.String attachmentName) Deletes (or moves to trash) given attachment from a given page.
boolean	deleteAttachments(java.lang.String pageName) Deletes (or moves to trash) all attachments from a given page.
org.jboss.wiki.WikiAttachment	getAttachment(java.lang.String pageName, java.lang.String attachmentName) Get appropriate attachment for a given page.
org.jboss.wiki.WikiAttachment	getAttachment(java.lang.String pageName, java.lang.String attachmentName, int version) Get appropriate attachment for a given page at given version.
long	getAttachmentSize(java.lang.String pageName, java.lang.String attachmentName, int version) Gets size of attachment at given version.
java.util.Set<java.lang.String>	getAttachmentsSet(org.jboss.wiki.WikiPage page) Gets attachment list for a given page.
int	getLastAttachmentVersion(java.lang.String pageName, java.lang.String attachmentName) Gets last version of the given attachment.
void	setWikiEngine(org.jboss.wiki.WikiEngine wikiEngine) Sets wikiEngine reference

Field Detail

attTrashName

static final java.lang.String attTrashName

See Also:

Constant Field Values

Method Detail

addAttachment

void addAttachment(java.io.File attFile,
                   java.lang.String attName,
                   org.jboss.wiki.WikiPage page,
                   java.lang.String user)

Add atachment to a given page.

Parameters:

attFile - File of the attachment.

attName - Name of the attachment.

page - Page to add atachment to.

user - Username of user adding the attachment.

getAttachmentsSet

java.util.Set<java.lang.String> getAttachmentsSet(org.jboss.wiki.WikiPage page)

Gets attachment list for a given page.

Parameters:

page - Page to get list for.

Returns:

Set of all attachment names.

getAttachment

org.jboss.wiki.WikiAttachment getAttachment(java.lang.String pageName,
                                            java.lang.String attachmentName)

Get appropriate attachment for a given page.

Parameters:

pageName - Name of the page to get attachment from.

attachmentName - Name of the attachment.

Returns:

Desired attachment or null if it doesn't exists.

getAttachment

org.jboss.wiki.WikiAttachment getAttachment(java.lang.String pageName,
                                            java.lang.String attachmentName,
                                            int version)

Get appropriate attachment for a given page at given version.

Parameters:

pageName - Name of the page to get attachment from.

attachmentName - Name of the attachment.

version - Desired version of attachment.

Returns:

Desired attachment or null if it doesn't exists.

getLastAttachmentVersion

int getLastAttachmentVersion(java.lang.String pageName,
                             java.lang.String attachmentName)

Gets last version of the given attachment.

Parameters:

pageName - Name of the page to get attachment's version from.

attachmentName - Name of the attachment.

Returns:

attachment version

getAttachmentSize

long getAttachmentSize(java.lang.String pageName,
                       java.lang.String attachmentName,
                       int version)

Gets size of attachment at given version.

Parameters:

pageName - Name of the page to get attachment's size from.

attachmentName - Name of the attachment.

version - Version of the attachment to count size for.

Returns:

attachment size

deleteAttachment

boolean deleteAttachment(java.lang.String pageName,
                         java.lang.String attachmentName)

Deletes (or moves to trash) given attachment from a given page.

Parameters:

pageName - Name of the page to delete attachment from.

attachmentName - Attachment name.

Returns:

true if attachemnt was deleted. False otherwise.

deleteAttachments

boolean deleteAttachments(java.lang.String pageName)

Deletes (or moves to trash) all attachments from a given page.

Parameters:

pageName - Name of the page to delete attachments from.

Returns:

true if attachemnts were deleted. False otherwise.

setWikiEngine

void setWikiEngine(org.jboss.wiki.WikiEngine wikiEngine)

Sets wikiEngine reference

Parameters:

wikiEngine -