eu.esdihumboldt.hale.common.core.io.project.impl
Class DefaultProjectWriter
java.lang.Object
eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
eu.esdihumboldt.hale.common.core.io.impl.AbstractExportProvider
eu.esdihumboldt.hale.common.core.io.project.impl.AbstractProjectWriter
eu.esdihumboldt.hale.common.core.io.project.impl.DefaultProjectWriter
- All Implemented Interfaces:
- ExportProvider, IOProvider, ProjectWriter
- Direct Known Subclasses:
- XMLProjectWriter, ZipProjectWriter
public class DefaultProjectWriter
- extends AbstractProjectWriter
Writes a project file
- Author:
- Simon Templer
Field Summary |
static String |
PARAM_SEPARATE_FILES
The configuration parameter name for detailing if project files are to be
placed outside the project archive |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PARAM_SEPARATE_FILES
public static final String PARAM_SEPARATE_FILES
- The configuration parameter name for detailing if project files are to be
placed outside the project archive
- See Also:
- Constant Field Values
DefaultProjectWriter
public DefaultProjectWriter(boolean archive)
- Parameters:
archive
- if the project shall be saved to a ZIP archive
validate
public void validate()
throws IOProviderConfigurationException
- Description copied from interface:
IOProvider
- Validate the I/O provider configuration
- Specified by:
validate
in interface IOProvider
- Overrides:
validate
in class AbstractExportProvider
- Throws:
IOProviderConfigurationException
- if the I/O provider was not
configured properly- See Also:
AbstractExportProvider.validate()
storeConfiguration
public void storeConfiguration(Map<String,String> configuration)
- Description copied from class:
AbstractIOProvider
- Stores all parameters that were set using
AbstractIOProvider.setParameter(String, String)
in the configuration. For changing
the behavior please override this method.
- Specified by:
storeConfiguration
in interface IOProvider
- Overrides:
storeConfiguration
in class AbstractExportProvider
- Parameters:
configuration
- the configuration to populate- See Also:
AbstractExportProvider.storeConfiguration(Map)
setParameter
public void setParameter(String name,
String value)
- Description copied from interface:
IOProvider
- Set a parameter
- Specified by:
setParameter
in interface IOProvider
- Overrides:
setParameter
in class AbstractExportProvider
- Parameters:
name
- the parameter namevalue
- the parameter value- See Also:
AbstractExportProvider.setParameter(String, String)
execute
protected IOReport execute(ProgressIndicator progress,
IOReporter reporter)
throws IOProviderConfigurationException,
IOException
- Description copied from class:
AbstractIOProvider
- Execute the I/O provider.
- Specified by:
execute
in class AbstractIOProvider
- Parameters:
progress
- the progress indicatorreporter
- the reporter to use for the execution report
- Returns:
- the execution report
- Throws:
IOProviderConfigurationException
- if the I/O provider was not
configured properly
IOException
- if an I/O operation fails- See Also:
AbstractIOProvider.execute(ProgressIndicator, IOReporter)
isUseSeparateFiles
public boolean isUseSeparateFiles()
- Returns:
- the useSeparateFiles
setUseSeparateFiles
public void setUseSeparateFiles(boolean useSeparateFiles)
- Parameters:
useSeparateFiles
- the useSeparateFiles to set
Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d