Package com.openindex.openestate.tool.agency.export

Class AbstractFormat

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,String>

com.openindex.openestate.tool.agency.export.AbstractFormat

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>

Direct Known Subclasses:

AbstractCsvFormat, AbstractPhpFormat, AbstractXmlFormat, Is24RestFormat, WebsiteHtmlFormat

public abstract class AbstractFormat
extends HashMap<String,String>

AbstractFormat.

Author:

Andreas Rudolph

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractFormat.AttachmentMarker
static class	AbstractFormat.AttachmentMode
static class	AbstractFormat.Compression
static class	AbstractFormat.DefaultMessageCode
static class	AbstractFormat.HashCalculationException
static class	AbstractFormat.ImageWatermarkPosition
static class	AbstractFormat.NotExportableException
static class	AbstractFormat.TransferMode

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFormat()

Method Summary

Modifier and Type	Method	Description
String	calculateHashForObject(long estateId, EstateImpl estateItem)
protected boolean	canPublishAttachment(String estateId, EstateAttachmentImpl attachment)
protected boolean	canPublishLink(String estateId, EstateLinkImpl link)
ExportProcess	createExportProcess()
AbstractTransportRequest[]	createExportRequests(AbstractTransport transport, File exportFile, AbstractFormat.TransferMode transferMode)
abstract AbstractFormatPanel	createSetupPanel()
boolean	equals(Object o)
String	getAgentId()
String	getAgentMail()
protected File	getAttachmentDirectory(long objectId, EstateAttachmentImpl attachment, File workDirectory)
int	getAttachmentImageScaleHeight()
int	getAttachmentImageScaleWidth()
String[]	getAttachmentMimeTypes()
AbstractFormat.AttachmentMode	getAttachmentMode()
protected String	getCompressedFileName(AbstractFormat.Compression c, ExportContext context)
AbstractFormat.Compression	getCompression()
static AbstractFormat	getFormat(String name)
static Map<String,AbstractFormat>	getFormats()
Locale	getLanguage()
Locale[]	getLanguages()
String	getMessageCodeTranslation(String code)
String	getMessageCodeTranslation(String code, Locale locale)
abstract String	getName()
String	getObjectKey(long id, String publicId)
protected String	getObjectKey(ExportEntry entry)
protected String[]	getPreferredMimeTypes()
PublishingMode	getPropertyAddressPublication()
PublishingMode	getPropertyFilePublication()
int	getPropertyImageLimit()
int	getPropertyImageWatermarkAlpha()
int	getPropertyImageWatermarkHeight()
int	getPropertyImageWatermarkMargin()
AbstractFormat.ImageWatermarkPosition	getPropertyImageWatermarkPosition()
int	getPropertyImageWatermarkWidth()
PublishingMode	getPropertyLinkPublication()
String	getPropertyPrefix()
PublishingMode	getPropertyPricePublication()
int	getPropertyVideoLimit()
String[]	getSupportedMimeTypes()	Liefert die von der Export-Schnittstelle fest vorgeschriebenen MIME-Types.
abstract AbstractFormat.TransferMode[]	getSupportedTransferModes()
abstract AbstractTransport[]	getSupportedTransports()
abstract String	getTitle()
String	getVersion()
int	hashCode()
boolean	hasLanguage(Locale l)
void	initDefaults()
boolean	isAttachmentImageScale()
boolean	isFullTransferSupported()
boolean	isFullTransportWarningShown()
boolean	isIncrementalTransferSupported()
boolean	isPropertyAddressHiddenIfUnpublished()
boolean	isPropertyDescriptionWithEnergyCertificate()
boolean	isPropertyFileHiddenIfUnpublished()
boolean	isPropertyImageWatermark()
boolean	isPropertyLinkHiddenIfUnpublished()
boolean	isPropertyPriceHiddenIfUnpublished()
boolean	isPropertyPublicId()
static Map<String,AbstractFormat>	listAvailableExports()	Deprecated.
boolean	prepareObjectForExport(long estateId, EstateImpl estate)
void	setAgentId(String val)
void	setAgentMail(String val)
void	setAttachmentImageScale(boolean val)
void	setAttachmentImageScaleHeight(int val)
void	setAttachmentImageScaleWidth(int val)
void	setAttachmentMimeTypes(String[] val)
void	setAttachmentMode(AbstractFormat.AttachmentMode val)
void	setCompression(AbstractFormat.Compression val)
void	setLanguage(Locale val)
void	setLanguages(Locale[] val)
void	setPropertyAddressHiddenIfUnpublished(boolean val)
void	setPropertyAddressPublication(PublishingMode val)
void	setPropertyDescriptionWithEnergyCertificate(boolean val)
void	setPropertyFileHiddenIfUnpublished(boolean val)
void	setPropertyFilePublication(PublishingMode val)
void	setPropertyImageLimit(int val)
void	setPropertyImageWatermark(boolean val)
void	setPropertyImageWatermarkAlpha(int val)
void	setPropertyImageWatermarkHeight(int val)
void	setPropertyImageWatermarkMargin(int val)
void	setPropertyImageWatermarkPosition(AbstractFormat.ImageWatermarkPosition val)
void	setPropertyImageWatermarkWidth(int val)
void	setPropertyLinkHiddenIfUnpublished(boolean val)
void	setPropertyLinkPublication(PublishingMode val)
void	setPropertyPrefix(String val)
void	setPropertyPriceHiddenIfUnpublished(boolean val)
void	setPropertyPricePublication(PublishingMode val)
void	setPropertyPublicId(boolean val)
void	setPropertyVideoLimit(int val)
abstract File	writeToDisk(File workDir, TransferImpl transfer, ExportContext context)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFormat

protected AbstractFormat()

Method Detail

calculateHashForObject

public String calculateHashForObject(long estateId,
                                     EstateImpl estateItem)
                              throws AbstractFormat.NotExportableException,
                                     AbstractFormat.HashCalculationException

Throws:

AbstractFormat.NotExportableException

AbstractFormat.HashCalculationException

canPublishAttachment

protected boolean canPublishAttachment(String estateId,
                                       EstateAttachmentImpl attachment)

canPublishLink

protected boolean canPublishLink(String estateId,
                                 EstateLinkImpl link)

createExportProcess

public ExportProcess createExportProcess()

createExportRequests

public AbstractTransportRequest[] createExportRequests(AbstractTransport transport,
                                                       File exportFile,
                                                       AbstractFormat.TransferMode transferMode)

createSetupPanel

public abstract AbstractFormatPanel createSetupPanel()

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,String>

Overrides:

equals in class AbstractMap<String,String>

getAgentId

public String getAgentId()

getAgentMail

public String getAgentMail()

getAttachmentDirectory

protected File getAttachmentDirectory(long objectId,
                                      EstateAttachmentImpl attachment,
                                      File workDirectory)

getAttachmentImageScaleHeight

public int getAttachmentImageScaleHeight()

getAttachmentImageScaleWidth

public int getAttachmentImageScaleWidth()

getAttachmentMimeTypes

public String[] getAttachmentMimeTypes()

getAttachmentMode

public AbstractFormat.AttachmentMode getAttachmentMode()

getCompressedFileName

protected String getCompressedFileName(AbstractFormat.Compression c,
                                       ExportContext context)

getCompression

public AbstractFormat.Compression getCompression()

getFormat

public static AbstractFormat getFormat(String name)

getFormats

public static Map<String,AbstractFormat> getFormats()

getLanguage

public Locale getLanguage()

getLanguages

public Locale[] getLanguages()

getMessageCodeTranslation

public final String getMessageCodeTranslation(String code)

getMessageCodeTranslation

public String getMessageCodeTranslation(String code,
                                        Locale locale)

getName

public abstract String getName()

getObjectKey

protected final String getObjectKey(ExportEntry entry)

getObjectKey

public String getObjectKey(long id,
                           String publicId)

getPreferredMimeTypes

protected String[] getPreferredMimeTypes()

getPropertyAddressPublication

public PublishingMode getPropertyAddressPublication()

getPropertyFilePublication

public PublishingMode getPropertyFilePublication()

getPropertyImageLimit

public int getPropertyImageLimit()

getPropertyImageWatermarkAlpha

public int getPropertyImageWatermarkAlpha()

getPropertyImageWatermarkHeight

public int getPropertyImageWatermarkHeight()

getPropertyImageWatermarkMargin

public int getPropertyImageWatermarkMargin()

getPropertyImageWatermarkPosition

public AbstractFormat.ImageWatermarkPosition getPropertyImageWatermarkPosition()

getPropertyImageWatermarkWidth

public int getPropertyImageWatermarkWidth()

getPropertyLinkPublication

public PublishingMode getPropertyLinkPublication()

getPropertyPrefix

public String getPropertyPrefix()

getPropertyPricePublication

public PublishingMode getPropertyPricePublication()

getPropertyVideoLimit

public int getPropertyVideoLimit()

getSupportedMimeTypes

public String[] getSupportedMimeTypes()

Liefert die von der Export-Schnittstelle fest vorgeschriebenen MIME-Types.

Returns:

Liste der fest vorgeschriebenen MIME-Types, oder null wenn keine Vorgaben existieren.

public String[] getRequiredMimeTypes() { return null; }

getSupportedTransferModes

public abstract AbstractFormat.TransferMode[] getSupportedTransferModes()

getSupportedTransports

public abstract AbstractTransport[] getSupportedTransports()

getTitle

public abstract String getTitle()

getVersion

public String getVersion()

hasLanguage

public boolean hasLanguage(Locale l)

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,String>

Overrides:

hashCode in class AbstractMap<String,String>

initDefaults

public void initDefaults()

isAttachmentImageScale

public boolean isAttachmentImageScale()

isFullTransferSupported

public boolean isFullTransferSupported()

isFullTransportWarningShown

public boolean isFullTransportWarningShown()

isIncrementalTransferSupported

public boolean isIncrementalTransferSupported()

isPropertyAddressHiddenIfUnpublished

public boolean isPropertyAddressHiddenIfUnpublished()

isPropertyDescriptionWithEnergyCertificate

public boolean isPropertyDescriptionWithEnergyCertificate()

isPropertyFileHiddenIfUnpublished

public boolean isPropertyFileHiddenIfUnpublished()

isPropertyImageWatermark

public boolean isPropertyImageWatermark()

isPropertyLinkHiddenIfUnpublished

public boolean isPropertyLinkHiddenIfUnpublished()

isPropertyPriceHiddenIfUnpublished

public boolean isPropertyPriceHiddenIfUnpublished()

isPropertyPublicId

public boolean isPropertyPublicId()

listAvailableExports

@Deprecated
public static Map<String,AbstractFormat> listAvailableExports()

Deprecated.

prepareObjectForExport

public boolean prepareObjectForExport(long estateId,
                                      EstateImpl estate)

setAgentId

public void setAgentId(String val)

setAgentMail

public void setAgentMail(String val)

setAttachmentImageScale

public void setAttachmentImageScale(boolean val)

setAttachmentImageScaleHeight

public void setAttachmentImageScaleHeight(int val)

setAttachmentImageScaleWidth

public void setAttachmentImageScaleWidth(int val)

setAttachmentMimeTypes

public void setAttachmentMimeTypes(String[] val)

setAttachmentMode

public void setAttachmentMode(AbstractFormat.AttachmentMode val)

setCompression

public void setCompression(AbstractFormat.Compression val)

setLanguage

public void setLanguage(Locale val)

setLanguages

public void setLanguages(Locale[] val)

setPropertyAddressHiddenIfUnpublished

public void setPropertyAddressHiddenIfUnpublished(boolean val)

setPropertyAddressPublication

public void setPropertyAddressPublication(PublishingMode val)

setPropertyDescriptionWithEnergyCertificate

public void setPropertyDescriptionWithEnergyCertificate(boolean val)

setPropertyFileHiddenIfUnpublished

public void setPropertyFileHiddenIfUnpublished(boolean val)

setPropertyFilePublication

public void setPropertyFilePublication(PublishingMode val)

setPropertyImageLimit

public void setPropertyImageLimit(int val)

setPropertyImageWatermark

public void setPropertyImageWatermark(boolean val)

setPropertyImageWatermarkAlpha

public void setPropertyImageWatermarkAlpha(int val)

setPropertyImageWatermarkHeight

public void setPropertyImageWatermarkHeight(int val)

setPropertyImageWatermarkMargin

public void setPropertyImageWatermarkMargin(int val)

setPropertyImageWatermarkPosition

public void setPropertyImageWatermarkPosition(AbstractFormat.ImageWatermarkPosition val)

setPropertyImageWatermarkWidth

public void setPropertyImageWatermarkWidth(int val)

setPropertyLinkHiddenIfUnpublished

public void setPropertyLinkHiddenIfUnpublished(boolean val)

setPropertyLinkPublication

public void setPropertyLinkPublication(PublishingMode val)

setPropertyPrefix

public void setPropertyPrefix(String val)

setPropertyPublicId

public void setPropertyPublicId(boolean val)

setPropertyPriceHiddenIfUnpublished

public void setPropertyPriceHiddenIfUnpublished(boolean val)

setPropertyPricePublication

public void setPropertyPricePublication(PublishingMode val)

setPropertyVideoLimit

public void setPropertyVideoLimit(int val)

writeToDisk

public abstract File writeToDisk(File workDir,
                                 TransferImpl transfer,
                                 ExportContext context)
                          throws IOException,
                                 SQLException

Throws:

IOException

SQLException