com.atlassian.confluence.content.render.xhtml.view.excerpt
Interface Excerpter

All Known Implementing Classes:

DefaultExcerpter

public interface Excerpter

Method Summary

java.lang.String	createExcerpt(ContentEntityObject contentEntityObject, java.lang.String outputType) Creates an excerpt of the contentEntityObject without any tags excluded including an implementation specific number of blocking
java.lang.String	createExcerpt(ContentEntityObject contentEntity, java.lang.String outputType, ExcerptConfig config) Creates an excerpt of the contentEntityObject excluding any html tags that are in the exclude set.
java.util.List<javax.activation.DataSource>	extractImageSrc(ContentEntityObject ceo, int numImages)
java.util.List<javax.activation.DataSource>	extractImageSrc(ContentEntityObject ceo, int numImages, boolean useThumbnails)
java.util.List<java.lang.String>	extractImageSrc(java.lang.String contentHtml, int numImages)
java.util.List<java.net.URI>	extractImageThumbnailUris(ContentEntityObject contentEntity, int maxUris) Returns the URIs of thumbnails for each of the images attached to the specified content entity.

Method Detail

createExcerpt

java.lang.String createExcerpt(ContentEntityObject contentEntityObject,
                               java.lang.String outputType)
                               throws java.lang.Exception

Creates an excerpt of the contentEntityObject without any tags excluded including an implementation specific number of blocking

Parameters:

contentEntityObject - - contentEntityObject to create an excerpt of

outputType - - the output type in which to render the content, @see RenderContextOutputType

Returns:

a html excerpt of the content entity object

Throws:

java.lang.Exception - - if an excerpt could not be created for this ContentEntityObject

createExcerpt

java.lang.String createExcerpt(ContentEntityObject contentEntity,
                               java.lang.String outputType,
                               ExcerptConfig config)
                               throws javax.xml.stream.XMLStreamException,
                                      com.atlassian.plugin.web.renderer.RendererException

Creates an excerpt of the contentEntityObject excluding any html tags that are in the exclude set. The number of blocks with content to be included in the excerpt is specified with the maxBlocksForExcerpt parameter. A block with content is any element with a

Parameters:

contentEntityObject - - contentEntityObject to create an excerpt of

outputType - - the output type in which to render the content, @see RenderContextOutputType

config - - a parameter object that allows the content of the excerpt to be customized. @see ExcerptConfig

Returns:

a html excerpt of the content entity object

Throws:

java.lang.Exception - - if an excerpt could not be created for this ContentEntityObject

javax.xml.stream.XMLStreamException

com.atlassian.plugin.web.renderer.RendererException

extractImageSrc

java.util.List<java.lang.String> extractImageSrc(java.lang.String contentHtml,
                                                 int numImages)
                                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

extractImageThumbnailUris

java.util.List<java.net.URI> extractImageThumbnailUris(ContentEntityObject contentEntity,
                                                       int maxUris)
                                                       throws XhtmlException

Returns the URIs of thumbnails for each of the images attached to the specified content entity. URIs are returned in order that the images appear in the document. Obviously only URIs for thumbnailable images will be returned.

Parameters:

contentEntity - the content entity

maxUris - the maximum URI's to return

Returns:

ordered list of thumbnails URIs

Throws:

XhtmlException - if there is an error parsing the contents for image references.

extractImageSrc

java.util.List<javax.activation.DataSource> extractImageSrc(ContentEntityObject ceo,
                                                            int numImages)
                                                            throws javax.xml.stream.XMLStreamException,
                                                                   XhtmlException

Throws:

javax.xml.stream.XMLStreamException

XhtmlException

extractImageSrc

java.util.List<javax.activation.DataSource> extractImageSrc(ContentEntityObject ceo,
                                                            int numImages,
                                                            boolean useThumbnails)
                                                            throws javax.xml.stream.XMLStreamException,
                                                                   XhtmlException

Throws:

javax.xml.stream.XMLStreamException

XhtmlException