Package com.logicaldoc.core.conversion
Class AbstractFormatConverter
java.lang.Object
com.logicaldoc.core.conversion.AbstractFormatConverter
- All Implemented Interfaces:
FormatConverter
- Direct Known Subclasses:
CompressedArchiveConverter
,GhostscriptConverter
,ImageConverter
,P7MConverter
,PstConverter
,XMLConverter
Abstract format converter.
- Since:
- 7.7
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
Template method that invokesconvert(String, Document, File, File)
final void
If the converter is enabled it invokes theinternalConvert(String, Document, File, File)
boolean
static String
getExtension
(String fileNameOrExtension) Gets the extension for the given filename, if an alias is found then the value of the alias is returned as well.getParameter
(String name) Gets the value of a parameterImplementations should return the list of the required parameters.Returns the map of parametersint
hashCode()
boolean
Checks if the converter is enabled or notvoid
Reads it's own parameters and stores them in the parameters mapvoid
setEnabled
(boolean enabled) Enables or disables the converter
-
Method Details
-
convert
Template method that invokesconvert(String, Document, File, File)
- Specified by:
convert
in interfaceFormatConverter
- Parameters:
src
- The source filedest
- The converted file, the extension of it's filename defines the output format- Throws:
IOException
- raised if the conversion resulted in an error
-
convert
If the converter is enabled it invokes theinternalConvert(String, Document, File, File)
- Specified by:
convert
in interfaceFormatConverter
- Parameters:
sid
- The actual Session ID (optional)document
- The document (optional)src
- The source filedest
- The converted file, the extension of it's filename defines the output format- Throws:
IOException
- raised if the conversion resulted in an error
-
loadParameters
public void loadParameters()Description copied from interface:FormatConverter
Reads it's own parameters and stores them in the parameters map- Specified by:
loadParameters
in interfaceFormatConverter
-
isEnabled
public boolean isEnabled()Description copied from interface:FormatConverter
Checks if the converter is enabled or not- Specified by:
isEnabled
in interfaceFormatConverter
- Returns:
- if the converter is enabled
-
setEnabled
public void setEnabled(boolean enabled) Description copied from interface:FormatConverter
Enables or disables the converter- Specified by:
setEnabled
in interfaceFormatConverter
- Parameters:
enabled
- the enabled flag
-
getParameters
Description copied from interface:FormatConverter
Returns the map of parameters- Specified by:
getParameters
in interfaceFormatConverter
- Returns:
- map param_name = param_value
-
getParameter
Description copied from interface:FormatConverter
Gets the value of a parameter- Specified by:
getParameter
in interfaceFormatConverter
- Parameters:
name
- name of the configuration parameter- Returns:
- the value of the configuration parameter
-
getParameterNames
Description copied from interface:FormatConverter
Implementations should return the list of the required parameters. A parameter is stored in the context as converter.SimpleClassName.parameter = value- Specified by:
getParameterNames
in interfaceFormatConverter
- Returns:
- list of the configuration parameters
-
hashCode
public int hashCode() -
equals
-
getExtension
Gets the extension for the given filename, if an alias is found then the value of the alias is returned as well. For instance if in the settings you haveconverter.alias.eft=txt
then a file named test.eft will be considered a txt.- Parameters:
fileNameOrExtension
- file name or just the extension- Returns:
- the real extension to use
-