org.alfresco.repo.content.transform

Class MediaWikiContentTransformer

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

org.alfresco.repo.content.transform.AbstractContentTransformerLimits

org.alfresco.repo.content.transform.AbstractContentTransformer2

org.alfresco.repo.content.transform.MediaWikiContentTransformer

All Implemented Interfaces:

ContentWorker, ContentTransformer, org.springframework.beans.factory.BeanNameAware

public class MediaWikiContentTransformer
extends AbstractContentTransformer2

MediaWiki content transformer. Converts mediawiki markup into HTML.

See Also:

Tika Note - Tika doesn't currently support mediawiki markup, so this transformer cannot currently be converted to use Tika.

Field Summary

Fields inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

transformerDebug

Fields inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

transformerConfig

Constructor Summary

Constructors

Constructor and Description
MediaWikiContentTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getComments(boolean available) Overridden to supply a comment or String of commented out transformation properties that specify any (hard coded or implied) supported transformations.
boolean	isTransformableMimetype(java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Only transform from mediawiki to html
void	setFileFolderService(FileFolderService fileFolderService) Sets the file folder service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Sets the node service
void	transformInternal(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options) Method to be implemented by subclasses wishing to make use of the common infrastructural code provided by this class.

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformer2

checkTransformable, getTransformationTime, getTransformationTime, recordError, recordTime, recordTime, register, setRegisterTransformer, setRegistry, toString, transform, transform, transform

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

getLimits, getLimits, getLimits, getMaxPages, getMaxSourceSizeKBytes, getMaxSourceSizeKBytes, getPageLimit, getReadLimitKBytes, getReadLimitTimeMs, getTimeoutMs, isPageLimitSupported, isTransformable, isTransformable, isTransformableSize, setLimits, setMaxPages, setMaxSourceSizeKBytes, setMimetypeLimits, setPageLimit, setPageLimitsSupported, setReaderLimits, setReadLimitKBytes, setReadLimitTimeMs, setTimeoutMs, setTransformerDebug

Methods inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

deprecatedSetter, equals, getBeanName, getCommentsOnlySupports, getExtensionOrAny, getMimetype, getMimetypeService, getName, getSimpleName, hashCode, isExplicitTransformation, isSupportedTransformation, onlySupports, setBeanName, setExplicitTransformations, setMimetypeService, setSupportedTransformations, setTransformerConfig, setUnsupportedTransformations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.content.transform.ContentTransformer

getName, isExplicitTransformation

Constructor Detail

MediaWikiContentTransformer

public MediaWikiContentTransformer()

Method Detail

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

Sets the file folder service

Parameters:

fileFolderService - the file folder service

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Sets the node service

Parameters:

nodeService - the node service

isTransformableMimetype

public boolean isTransformableMimetype(java.lang.String sourceMimetype,
                              java.lang.String targetMimetype,
                              TransformationOptions options)

Only transform from mediawiki to html

Specified by:

isTransformableMimetype in interface ContentTransformer

Overrides:

isTransformableMimetype in class AbstractContentTransformerLimits

Parameters:

sourceMimetype - the source mimetype

targetMimetype - the target mimetype

options - the transformation options

Returns:

boolean true if this content transformer can satify the mimetypes, false otherwise

See Also:

ContentTransformer.isTransformable(java.lang.String, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions)

getComments

public java.lang.String getComments(boolean available)

Description copied from class: ContentTransformerHelper

Overridden to supply a comment or String of commented out transformation properties that specify any (hard coded or implied) supported transformations. Used when providing a list of properties to an administrators who may be setting other transformation properties, via JMX. Consider overriding if {link AbstractContentTransformerLimits.isTransformableMimetype(String, String, TransformationOptions) or ContentTransformerWorker.isTransformable(String, String, TransformationOptions) have been overridden. See ContentTransformerHelper.getCommentsOnlySupports(List, List, boolean) which may be used to help construct a comment.

Specified by:

getComments in interface ContentTransformer

Overrides:

getComments in class ContentTransformerHelper

Parameters:

available - indicates if the transformer has been registered and is available to be selected. false indicates that the transformer is only available as a component of a complex transformer.

Returns:

one line per property. The simple transformer name is returned by default as a comment.

transformInternal

public void transformInternal(org.alfresco.service.cmr.repository.ContentReader reader,
                     org.alfresco.service.cmr.repository.ContentWriter writer,
                     TransformationOptions options)
                       throws java.lang.Exception

Description copied from class: AbstractContentTransformer2

Method to be implemented by subclasses wishing to make use of the common infrastructural code provided by this class.

Specified by:

transformInternal in class AbstractContentTransformer2

Parameters:

reader - the source of the content to transform

writer - the target to which to write the transformed content

options - a map of options to use when performing the transformation. The map will never be null.

Throws:

java.lang.Exception - exceptions will be handled by this class - subclasses can throw anything

See Also:

AbstractContentTransformer2.transformInternal(org.alfresco.service.cmr.repository.ContentReader, org.alfresco.service.cmr.repository.ContentWriter, org.alfresco.service.cmr.repository.TransformationOptions)