de.contecon.picapport.plugins.otherformats

Class OtherFormatsDescriptor

java.lang.Object

de.contecon.picapport.plugins.PluginDescriptor

de.contecon.picapport.plugins.otherformats.OtherFormatsDescriptor

public class OtherFormatsDescriptor
extends PluginDescriptor

This Class is use by a PicApport plugin to describe the supported file-types. For every file type supported one OtherFormatsDescriptor instance must be created
10.02.2015

Author:

Eric

Constructor Summary

Constructors

Constructor and Description
OtherFormatsDescriptor(java.lang.String fileExtension, java.lang.String mimeType, boolean hideSubstitutes, java.lang.String name, java.lang.String copyRightString, java.lang.String version, java.util.Properties props) This Class is use by a PicApport plugin to describe the supported file-types.

Method Summary

Modifier and Type	Method and Description
void	createSubstitute(java.io.File substitute, java.io.File file) PicApport internal method author Eric 09.02.2015
void	dump() PicApport internal method to display info of this plugin on console(logfile)
java.lang.String	getCopyRightString()
java.lang.String	getDownloadText(java.util.Locale locale) author Eric 11.09.2020
java.lang.String	getFileExtension()
IOtherFileFormat	getFileFormatPlugin() PicApport internal method author Eric 09.02.2015
de.contecon.picapport.plugins.otherformats.IOtherImageFormat	getImageFormatPlugin() PicApport internal method author Eric 09.02.2015
java.lang.String	getLocalisedText(java.lang.String id, java.lang.String defaultText) PicApport internal method author Eric 09.02.2015
java.lang.String	getLocalisedText(java.lang.String isoLanguage, java.lang.String id, java.lang.String defaultText) PicApport internal method author Eric 09.02.2015
java.lang.String	getMimeType()
java.lang.String	getName()
java.util.Properties	getProps()
java.io.File	getSubstituteFile(java.io.File file) PicApport internal method author Eric 09.02.2015
java.lang.String	getVersion()
boolean	hideSubstitutes()
boolean	isOtherFileFormatPlugin() PicApport internal method author Eric 09.02.2015
boolean	isOtherImageFormatPlugin() PicApport internal method author Eric 09.02.2015

Methods inherited from class de.contecon.picapport.plugins.PluginDescriptor

getPluginImpl, setPluginImpl

Methods inherited from class java.lang.Object

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

Constructor Detail

OtherFormatsDescriptor

public OtherFormatsDescriptor(java.lang.String fileExtension,
                              java.lang.String mimeType,
                              boolean hideSubstitutes,
                              java.lang.String name,
                              java.lang.String copyRightString,
                              java.lang.String version,
                              java.util.Properties props)

This Class is use by a PicApport plugin to describe the supported file-types. For every file type supported one OtherFormatsDescriptor instance must be created
Throws NullPointerException if a parameter is null

 
 public List<OtherFormatsDescriptor> init(File pluginDirectory, Properties props, IPicApportPlugInLogger logger) {
 this.logger = logger;
 
 if(props != null) {
  setResolutionFromString(props.getProperty("pdf.resolution"));
  }
     
 return  Arrays.asList(
               new OtherFormatsDescriptor[] {
                   new OtherFormatsDescriptor(".pdf", 
                       "application/pdf", 
                       true, 
                       "PicApport PDF plugin", 
                       "(c) 2015 Contecon Software GmbH", 
                       "1.0", 
                       props),
               });   
   }
 
 

Parameters:

fileExtension - File extension e.g. "gif" or "png"

mimeType - Mime-type of original file "image/gif" or "image/png"

hideSubstitutes - if true the created substitute files will have the hidden attribute set (we recommend to set this to true)

name - The name of the plugin. It will be visible in the logfiles. E.g. "PicApport PNG plugin"

copyRightString - The copyright String for the plugin. It will be visible in the logfiles. E.g. "(c) 2014 Contecon Software GmbH"

version - The plugin version. It will be visible in the logfiles. E.g. "1.0"

props - The Properties passed to the init() method of the plugin

Method Detail

getFileExtension

public java.lang.String getFileExtension()

Returns:

fileExtension

getMimeType

public java.lang.String getMimeType()

Returns:

mimeType

hideSubstitutes

public boolean hideSubstitutes()

Returns:

true if substitute file should be hidden (depend on operating system support of the server)

getName

public java.lang.String getName()

Returns:

name

getCopyRightString

public java.lang.String getCopyRightString()

Returns:

copyRightString

getVersion

public java.lang.String getVersion()

Returns:

version

getProps

public java.util.Properties getProps()

Returns:

properties. Null is allowed.

getDownloadText

public java.lang.String getDownloadText(java.util.Locale locale)

author Eric 11.09.2020

Parameters:

locale - locale that should be used

Returns:

the menue text for download

dump

public void dump()

PicApport internal method to display info of this plugin on console(logfile)

isOtherFileFormatPlugin

public boolean isOtherFileFormatPlugin()

PicApport internal method author Eric 09.02.2015

Returns:

true if instance of IOtherFileFormat

getFileFormatPlugin

public IOtherFileFormat getFileFormatPlugin()

PicApport internal method author Eric 09.02.2015

Returns:

IOtherFileFormat

isOtherImageFormatPlugin

public boolean isOtherImageFormatPlugin()

PicApport internal method author Eric 09.02.2015

Returns:

true if instance of IOtherImageFormat

getImageFormatPlugin

public de.contecon.picapport.plugins.otherformats.IOtherImageFormat getImageFormatPlugin()

PicApport internal method author Eric 09.02.2015

Returns:

IOtherImageFormat

getSubstituteFile

public java.io.File getSubstituteFile(java.io.File file)

PicApport internal method author Eric 09.02.2015

Parameters:

file - the original file

Returns:

The substitute file (origfile.$.jpg file")

createSubstitute

public void createSubstitute(java.io.File substitute,
                             java.io.File file)
                      throws java.lang.Exception

PicApport internal method author Eric 09.02.2015

Parameters:

substitute - substitute file

file - original file

Throws:

java.lang.Exception - if an error occurs

getLocalisedText

public java.lang.String getLocalisedText(java.lang.String isoLanguage,
                                         java.lang.String id,
                                         java.lang.String defaultText)

PicApport internal method author Eric 09.02.2015

Parameters:

isoLanguage - isoLanguage (es, de, fr etc...)

id - id of text

defaultText - should be English

Returns:

translated text

getLocalisedText

public java.lang.String getLocalisedText(java.lang.String id,
                                         java.lang.String defaultText)

PicApport internal method author Eric 09.02.2015

Parameters:

id - id of text

defaultText - should be English

Returns:

translated text