org.alfresco.repo.content.transform

Class TransformerPropertyNameExtractor

java.lang.Object

org.alfresco.repo.content.transform.TransformerPropertyNameExtractor

Direct Known Subclasses:

TransformerConfigDynamicTransformers, TransformerConfigLimits, TransformerConfigProperty, TransformerConfigSupported

public abstract class TransformerPropertyNameExtractor
extends Object

Provides access to transformer property names and values.

Author:

Alan Davis

Constructor Summary

Constructors

Constructor and Description
TransformerPropertyNameExtractor()

Method Summary

Modifier and Type	Method and Description
protected String	getProperty(String transformerName, String sourceExt, String targetExt, String suffix, String use, Map<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixKey,org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue> transformerSourceTargetSuffixValues) Returns a transformer property value if it exists from the supplied map.
protected Collection<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue>	getTransformerSourceTargetValues(Collection<String> suffixes, boolean includeSummary, boolean includeUse, TransformerProperties transformerProperties, org.alfresco.service.cmr.repository.MimetypeService mimetypeService) Returns a set of transformer name, source extension, target extension and value from property names that defined transformation limits.
protected Map<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixKey,org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue>	getTransformerSourceTargetValuesMap(Collection<String> suffixes, boolean includeSummary, boolean includeExtensions, boolean includeUse, TransformerProperties transformerProperties, org.alfresco.service.cmr.repository.MimetypeService mimetypeService) Returns a map to access transformer name, source extension and target extension to transformer name, source extension, target extension and value, created from property names that defined transformation limits.
protected void	handleProperty(String transformerName, String separator, String firstExpression, String secondExpression, String suffix, String use, String value, String propertyName, Map<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixKey,org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue> transformerSourceTargetSuffixValues, org.alfresco.service.cmr.repository.MimetypeService mimetypeService) Handles a property to add values to the supplied transformerSourceTargetSuffixValues.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransformerPropertyNameExtractor

public TransformerPropertyNameExtractor()

Method Detail

getTransformerSourceTargetValues

protected Collection<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue> getTransformerSourceTargetValues(Collection<String> suffixes,
                                                                                                                              boolean includeSummary,
                                                                                                                              boolean includeUse,
                                                                                                                              TransformerProperties transformerProperties,
                                                                                                                              org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

Returns a set of transformer name, source extension, target extension and value from property names that defined transformation limits. When the separator indicates it is followed by a regular expression that matches multiple mimetypes, more than one value may be added. When there is a value defined for specific extensions it wins over any regular expression value.

Parameters:

suffixes - possible endings to the property names after the target mimetype extension. Must start with a '.' if there is a suffix.

includeSummary - if true will also look for property names without the separator, source mimetype and target mimetype.

includeUse - if true, additionally checks for specific usage values that override the normal defaults. Such properties have a suffix of ".use." where is a value such as "index", "webpreview", "doclib", "syncRule", "aysncRule".

transformerProperties - that provides the properties

mimetypeService - MimetypeService

getTransformerSourceTargetValuesMap

protected Map<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixKey,org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue> getTransformerSourceTargetValuesMap(Collection<String> suffixes,
                                                                                                                                                                                               boolean includeSummary,
                                                                                                                                                                                               boolean includeExtensions,
                                                                                                                                                                                               boolean includeUse,
                                                                                                                                                                                               TransformerProperties transformerProperties,
                                                                                                                                                                                               org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

Returns a map to access transformer name, source extension and target extension to transformer name, source extension, target extension and value, created from property names that defined transformation limits. When the separator indicates it is followed by a regular expression that matches multiple mimetypes, more than one value may be added. When there is a value defined for specific extensions it wins over any regular expression value.

Parameters:

suffixes - possible endings to the property names after the target mimetype extension. Must start with a '.' if there is a suffix.

includeSummary - if true will include property names without the separator to source mimetype and target mimetype.

includeExtensions - if false will exclude property names with the separator to source mimetype and target mimetype.

includeUse - if true, additionally checks for specific usage values that override the normal defaults. Such properties have a suffix of ".use." where is a value such as "index", "webpreview", "doclib", "syncRule", "aysncRule".

transformerProperties - that provides the properties

mimetypeService - MimetypeService

handleProperty

protected void handleProperty(String transformerName,
                              String separator,
                              String firstExpression,
                              String secondExpression,
                              String suffix,
                              String use,
                              String value,
                              String propertyName,
                              Map<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixKey,org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue> transformerSourceTargetSuffixValues,
                              org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

Handles a property to add values to the supplied transformerSourceTargetSuffixValues. If the separator is null, this indicates that the property provides a transformer wide value, so firstExpression and secondExpression should also be ignored.

getProperty

protected String getProperty(String transformerName,
                             String sourceExt,
                             String targetExt,
                             String suffix,
                             String use,
                             Map<org.alfresco.repo.content.transform.TransformerSourceTargetSuffixKey,org.alfresco.repo.content.transform.TransformerSourceTargetSuffixValue> transformerSourceTargetSuffixValues)

Returns a transformer property value if it exists from the supplied map.

Parameters:

transformerName - of the transformer

sourceExt - null indicates this is a transformer wide property.

targetExt - String

suffix - String

use - String

transformerSourceTargetSuffixValues - map of values

Returns:

the value or null if not set.