org.openestate.is24.restapi.utils

Class ExportPool

java.lang.Object

org.openestate.is24.restapi.utils.ExportPool

public class ExportPool
extends Object

A pool of exportable real estates, attachments and contacts.

The ExportPool is part of the high level API for bulk exports of real estate data.

Multiple real estates and contacts (including attachments) can be collected in the ExportPool. The corresponding data is stored into a temporary folder on the local harddisk. After the ExportPool was created and initialized with some data, the bulk export can be started via ExportHandler.

Since:

0.2

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
ExportPool() Creates an empty ExportPool.
ExportPool(File baseDir) Creates an empty ExportPool.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Clear settings and empty the local directory.
File	getBaseDir() Returns directory, where local files are stored.
RealtorContactDetails	getContact(String pooledContactId) Returns a pooled contact.
String[]	getContactIds() Returns ID's of pooled contacts.
File	getContactsDir() Returns directory, where pooled contacts are stored.
long	getContactSize(String pooledContactId, boolean completely) Returns size of a pooled contact.
RealEstate	getObject(String pooledObjectId) Returns a pooled real estate.
Attachment	getObjectAttachment(String pooledObjectId, String attachmentId) Returns a pooled attachment for a real estate.
File	getObjectAttachmentFile(String pooledObjectId, Attachment attachment) Returns the file of a pooled attachment for a real estate.
File	getObjectAttachmentFile(String pooledObjectId, String name) Returns the file of a pooled attachment for a real estate.
File	getObjectAttachmentFile(String pooledObjectId, URL href) Returns the file of a pooled attachment for a real estate.
String[]	getObjectAttachmentIds(String pooledObjectId) Returns attachment ID's of a pooled real estate.
long	getObjectAttachmentSize(String pooledObjectId, String attachmentId) Returns size of a pooled attachment for a real estate.
URL	getObjectAttachmentURL(String pooledObjectId, String attachmentId) Returns the URL of a pooled attachment for a real estate.
String[]	getObjectIds() Returns ID's of pooled real estates.
String[]	getObjectIdsForRemoval() Returns ID's of real estates, that were pooled for removal.
File	getObjectsDir() Returns directory, where pooled real estates are stored.
long	getObjectSize(String pooledObjectId, boolean completely) Returns size of a pooled real estate.
String	getSetting(String key) Returns a settings from the export pool.
String	getSetting(String key, String defaultValue) Returns a settings from the export pool.
long	getTotalSize() Returns the total size of the local pool directory.
boolean	hasContactForExport(String pooledContactId) Checks, if a contact was pooled for export.
boolean	hasObjectForExport(String pooledObjectId) Checks, if a real estate was pooled for export.
boolean	hasObjectForRemoval(String externalObjectId) Checks, if a real estate was pooled for removal.
void	putContact(RealtorContactDetails contact) Adds a contact to export pool.
void	putContact(RealtorContactDetails contact, String pooledContactId) Adds a contact to export pool.
void	putObject(RealEstate object) Adds a real estate to export pool.
void	putObject(RealEstate object, String pooledObjectId) Adds a real estate to export pool.
void	putObjectAttachedFile(String pooledObjectId, Attachment attachment, File file) Adds an attachment for a real estate to export pool.
void	putObjectAttachedFile(String pooledObjectId, Attachment attachment, URL file) Adds an attachment for a real estate to export pool.
void	putObjectAttachedLink(String pooledObjectId, Attachment link) Adds an web link for a real estate to export pool.
void	putObjectForRemoval(String externalObjectId) Registers an real estate object for removal.
void	putSetting(String key, String value) Puts a settings to the export pool.
void	readSettings() Read export pool settings from local directory.
void	writeSettings() Writes export pool settings to local directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportPool

public ExportPool()

Creates an empty ExportPool.

Files are stored into the default temporary directory of the Java runtime environment.

ExportPool

public ExportPool(File baseDir)

Creates an empty ExportPool.

Parameters:

baseDir - directory, where pooled files are stored

Method Detail

cleanup

public void cleanup()

Clear settings and empty the local directory.

getBaseDir

public final File getBaseDir()

Returns directory, where local files are stored.

Returns:

directory

getContact

public RealtorContactDetails getContact(String pooledContactId)
                                 throws IOException

Returns a pooled contact.

Parameters:

pooledContactId - ID of the contact within the pool

Returns:

contact

Throws:

IOException - if object is not readable from local directory

getContactIds

public String[] getContactIds()

Returns ID's of pooled contacts.

Returns:

contact ID's within the pool

getContactSize

public long getContactSize(String pooledContactId,
                  boolean completely)

Returns size of a pooled contact.

Parameters:

pooledContactId - ID of the contact within the pool

completely - calculate the complete size (including attachments)

Returns:

size in bytes

getContactsDir

public final File getContactsDir()

Returns directory, where pooled contacts are stored.

Returns:

directory

getObject

public RealEstate getObject(String pooledObjectId)
                     throws IOException

Returns a pooled real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

Returns:

real estate

Throws:

IOException - if object is not readable from local directory

getObjectAttachment

public Attachment getObjectAttachment(String pooledObjectId,
                             String attachmentId)
                               throws IOException

Returns a pooled attachment for a real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

attachmentId - ID of the attachment

Returns:

attachment

Throws:

IOException - if object is not readable from local directory

getObjectAttachmentFile

public File getObjectAttachmentFile(String pooledObjectId,
                           Attachment attachment)

Returns the file of a pooled attachment for a real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

attachment - attachment to lookup

Returns:

file

getObjectAttachmentFile

public File getObjectAttachmentFile(String pooledObjectId,
                           URL href)

Returns the file of a pooled attachment for a real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

href - attachment href

Returns:

file

getObjectAttachmentFile

public File getObjectAttachmentFile(String pooledObjectId,
                           String name)

Returns the file of a pooled attachment for a real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

name - file name

Returns:

file

getObjectAttachmentSize

public long getObjectAttachmentSize(String pooledObjectId,
                           String attachmentId)

Returns size of a pooled attachment for a real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

attachmentId - ID of the attachment

Returns:

size in bytes

getObjectAttachmentURL

public URL getObjectAttachmentURL(String pooledObjectId,
                         String attachmentId)
                           throws IOException

Returns the URL of a pooled attachment for a real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

attachmentId - ID of the attachment

Returns:

file

Throws:

IOException - if object is not readable from local directory

getObjectAttachmentIds

public String[] getObjectAttachmentIds(String pooledObjectId)

Returns attachment ID's of a pooled real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

Returns:

attachment ID's

getObjectIds

public String[] getObjectIds()

Returns ID's of pooled real estates.

Returns:

real estate ID's within the pool

getObjectIdsForRemoval

public String[] getObjectIdsForRemoval()

Returns ID's of real estates, that were pooled for removal.

Returns:

real estate ID's

getObjectSize

public long getObjectSize(String pooledObjectId,
                 boolean completely)

Returns size of a pooled real estate.

Parameters:

pooledObjectId - ID of the real estate within the pool

completely - calculate the complete size (including attachments)

Returns:

size in bytes

getObjectsDir

public final File getObjectsDir()

Returns directory, where pooled real estates are stored.

Returns:

directory

getSetting

public String getSetting(String key)

Returns a settings from the export pool.

Parameters:

key - setting key

Returns:

setting value

getSetting

public String getSetting(String key,
                String defaultValue)

Returns a settings from the export pool.

Parameters:

key - setting key

defaultValue - default value, if the setting is not defined

Returns:

setting value or the provided default value

getTotalSize

public long getTotalSize()

Returns the total size of the local pool directory.

Returns:

size in bytes

hasContactForExport

public boolean hasContactForExport(String pooledContactId)

Checks, if a contact was pooled for export.

Parameters:

pooledContactId - ID of the contact within the pool

Returns:

true, if the object with the provided ID is already pooled

hasObjectForExport

public boolean hasObjectForExport(String pooledObjectId)

Checks, if a real estate was pooled for export.

Parameters:

pooledObjectId - ID of the real estate within the pool

Returns:

true, if the object with the provided ID is already pooled

hasObjectForRemoval

public boolean hasObjectForRemoval(String externalObjectId)

Checks, if a real estate was pooled for removal.

Parameters:

externalObjectId - real estate ID

Returns:

true, if the object with the provided ID is already pooled for removal

putContact

public void putContact(RealtorContactDetails contact)
                throws IOException

Adds a contact to export pool.

Parameters:

contact - contact

Throws:

IOException - if pooling failed

putContact

public void putContact(RealtorContactDetails contact,
              String pooledContactId)
                throws IOException

Adds a contact to export pool.

Parameters:

contact - contact

pooledContactId - ID of the contact within the pool

Throws:

IOException - if pooling failed

putObject

public void putObject(RealEstate object)
               throws IOException

Adds a real estate to export pool.

Parameters:

object - real estate

Throws:

IOException - if pooling failed

putObject

public void putObject(RealEstate object,
             String pooledObjectId)
               throws IOException

Adds a real estate to export pool.

Parameters:

object - real estate

pooledObjectId - ID of the real estate within the pool

Throws:

IOException - if pooling failed

putObjectAttachedFile

public void putObjectAttachedFile(String pooledObjectId,
                         Attachment attachment,
                         File file)
                           throws IOException

Adds an attachment for a real estate to export pool.

Parameters:

pooledObjectId - ID of the real estate within the pool

attachment - attachment informations

file - attached file

Throws:

IOException - if pooling failed

putObjectAttachedFile

public void putObjectAttachedFile(String pooledObjectId,
                         Attachment attachment,
                         URL file)
                           throws IOException

Adds an attachment for a real estate to export pool.

Parameters:

pooledObjectId - ID of the real estate within the pool

attachment - attachment informations

file - URL, that points to the attached file

Throws:

IOException - if pooling failed

putObjectAttachedLink

public void putObjectAttachedLink(String pooledObjectId,
                         Attachment link)
                           throws IOException

Adds an web link for a real estate to export pool.

Parameters:

pooledObjectId - ID of the real estate within the pool

link - web link

Throws:

IOException - if pooling failed

putObjectForRemoval

public void putObjectForRemoval(String externalObjectId)

Registers an real estate object for removal.

Parameters:

externalObjectId - real estate ID

putSetting

public void putSetting(String key,
              String value)

Puts a settings to the export pool.

Parameters:

key - setting key

value - setting value

readSettings

public void readSettings()
                  throws IOException

Read export pool settings from local directory.

Throws:

IOException - if settings are not loadable

writeSettings

public void writeSettings()
                   throws IOException

Writes export pool settings to local directory.

Throws:

IOException - if settings are not wriable