|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.content.transform.AbstractContentTransformer
@Deprecated public abstract class AbstractContentTransformer
Provides basic services for ContentTransformer
implementations.
This class maintains the performance measures for the transformers as well, making sure that there is an extra penalty for transformers that fail regularly.
Constructor Summary | |
---|---|
protected |
AbstractContentTransformer()
Deprecated. All transformers start with an average transformation time of 0.0ms. |
Method Summary | |
---|---|
protected void |
checkReliability(org.alfresco.service.cmr.repository.ContentReader reader,
org.alfresco.service.cmr.repository.ContentWriter writer)
Deprecated. Convenience method to check the reliability of a transformation |
protected java.util.List |
getExplicitTransformations()
Deprecated. |
protected java.lang.String |
getMimetype(org.alfresco.service.cmr.repository.ContentAccessor content)
Deprecated. Convenience to fetch and check the mimetype for the given content |
protected org.alfresco.service.cmr.repository.MimetypeService |
getMimetypeService()
Deprecated. |
protected abstract double |
getReliability(java.lang.String sourceMimetype,
java.lang.String targetMimetype)
Deprecated. Added for backward compatibility of existing content transformers |
long |
getTransformationTime()
Deprecated. Provides an estimate, usually a worst case guess, of how long a transformation will take. |
boolean |
isExplicitTransformation(java.lang.String sourceMimetype,
java.lang.String targetMimetype,
TransformationOptions options)
Deprecated. Indicates whether given the provided transformation parmaters this transformer can prvide an explict transformation. |
boolean |
isTransformable(java.lang.String sourceMimetype,
java.lang.String targetMimetype,
TransformationOptions options)
Deprecated. Indicates whether the provided source mimetype can be transformed into the target mimetype with the options specified by this content transformer. |
protected void |
recordTime(long transformationTime)
Deprecated. Records and updates the average transformation time for this transformer. |
void |
register()
Deprecated. Registers this instance with the registry
if it is present. |
void |
setExplicitTransformations(java.util.List explicitTransformations)
Deprecated. Set the transformations that this transformer can do regardless of what it returns via the reliability check . |
void |
setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
Deprecated. Helper setter of the mimetype service. |
void |
setRegistry(ContentTransformerRegistry registry)
Deprecated. The registry to auto-register with |
java.lang.String |
toString()
Deprecated. |
void |
transform(org.alfresco.service.cmr.repository.ContentReader reader,
org.alfresco.service.cmr.repository.ContentWriter writer)
Deprecated. |
void |
transform(org.alfresco.service.cmr.repository.ContentReader reader,
org.alfresco.service.cmr.repository.ContentWriter writer,
java.util.Map options)
Deprecated. Performs the following: Times the transformation Ensures that the transformation is allowed Calls the subclass implementation of #transformInternal(ContentReader, ContentWriter)
Transforms any exceptions generated
Logs a successful transformation
Subclass need only be concerned with performing the transformation. |
void |
transform(org.alfresco.service.cmr.repository.ContentReader reader,
org.alfresco.service.cmr.repository.ContentWriter writer,
TransformationOptions options)
Deprecated. Transforms the content provided by the reader and source mimetype to the writer and target mimetype with the provided transformation options. |
protected abstract void |
transformInternal(org.alfresco.service.cmr.repository.ContentReader reader,
org.alfresco.service.cmr.repository.ContentWriter writer,
java.util.Map options)
Deprecated. Method to be implemented by subclasses wishing to make use of the common infrastructural code provided by this class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected AbstractContentTransformer()
Method Detail |
---|
public void setRegistry(ContentTransformerRegistry registry)
registry
- the transformer registrypublic void setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
mimetypeService
- protected org.alfresco.service.cmr.repository.MimetypeService getMimetypeService()
protected java.util.List getExplicitTransformations()
public void setExplicitTransformations(java.util.List explicitTransformations)
reliability check
.
explicitTransformations
- explicit key mappingspublic java.lang.String toString()
toString
in class java.lang.Object
public void register()
registry
if it is present.
protected java.lang.String getMimetype(org.alfresco.service.cmr.repository.ContentAccessor content)
content
- the reader/writer for the content
org.alfresco.error.AlfrescoRuntimeException
- if the content doesn't have a mimetypeprotected abstract double getReliability(java.lang.String sourceMimetype, java.lang.String targetMimetype)
sourceMimetype
- the source mimetypetargetMimetype
- the target mimetype
protected void checkReliability(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer)
reader
- writer
-
org.alfresco.error.AlfrescoRuntimeException
- if the reliability isn't > 0public boolean isTransformable(java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options)
ContentTransformer
isTransformable
in interface ContentTransformer
sourceMimetype
- the source mimetypeoptions
- the transformation options
ContentTransformer.isTransformable(java.lang.String, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions)
public boolean isExplicitTransformation(java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options)
ContentTransformer
isExplicitTransformation
in interface ContentTransformer
sourceMimetype
- the source mimetypetargetMimetype
- the target mimetypeoptions
- the transformation options
ContentTransformer.isTransformable(java.lang.String, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions)
protected abstract void transformInternal(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, java.util.Map options) throws java.lang.Exception
reader
- the source of the content to transformwriter
- the target to which to write the transformed contentoptions
- a map of options to use when performing the transformation. The map
will never be null.
java.lang.Exception
- exceptions will be handled by this class - subclasses can throw anythingpublic final void transform(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer) throws org.alfresco.service.cmr.repository.ContentIOException
transform
in interface ContentTransformer
org.alfresco.service.cmr.repository.ContentIOException
AbstractContentTransformer.transform(ContentReader, ContentWriter, Map)
,
AbstractContentTransformer.transformInternal(ContentReader, ContentWriter, Map)
public final void transform(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options) throws org.alfresco.service.cmr.repository.ContentIOException
ContentTransformer
The transformation viability can be determined by an up front call
to ContentTransformer.isTransformable(String, String, TransformationOptions)
.
The source and target mimetypes must be available on the
ContentAccessor.getMimetype()
methods of
both the reader and the writer.
Both reader and writer will be closed after the transformation completes.
The provided options can be null.
transform
in interface ContentTransformer
reader
- the source of the contentwriter
- the destination of the transformed contentoptions
- transformation options, these can be null
org.alfresco.service.cmr.repository.ContentIOException
- if an IO exception occursContentTransformer.transform(org.alfresco.service.cmr.repository.ContentReader, org.alfresco.service.cmr.repository.ContentWriter, org.alfresco.service.cmr.repository.TransformationOptions)
public final void transform(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, java.util.Map options) throws org.alfresco.service.cmr.repository.ContentIOException
#transformInternal(ContentReader, ContentWriter)
If the options provided are null, then an empty map will be created.
transform
in interface ContentTransformer
reader
- the source of the contentwriter
- the destination of the transformed contentoptions
- options to pass to the transformer. These are transformer dependent
and may be null.
org.alfresco.service.cmr.repository.ContentIOException
- if an IO exception occurspublic long getTransformationTime()
ContentTransformer
This method is used to determine, up front, which of a set of equally reliant transformers will be used for a specific transformation.
getTransformationTime
in interface ContentTransformer
protected final void recordTime(long transformationTime)
Subclasses should call this after every transformation in order to keep the running average of the transformation times up to date.
This method is thread-safe. The time spent in this method is negligible so the impact will be minor.
transformationTime
- the time it took to perform the transformation.
The value may be 0.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |