|
Humboldt Alignment Editor 2.5.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecteu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
eu.esdihumboldt.hale.common.core.io.impl.AbstractImportProvider
public abstract class AbstractImportProvider
Abstract ImportProvider
implementation
Field Summary |
---|
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.ImportProvider |
---|
PARAM_RESOURCE_ID, PARAM_SOURCE |
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider |
---|
PARAM_CONTENT_TYPE |
Constructor Summary | |
---|---|
AbstractImportProvider()
Default constructor |
Method Summary | |
---|---|
IOReporter |
createReporter()
Create a reporter configured for the execution of this I/O provider. |
IOReport |
execute(ProgressIndicator progress)
Execute the I/O provider. |
protected String |
generateResourceId()
Generate the unique resource identifier. |
String |
getResourceIdentifier()
Get the resource identifier. |
LocatableInputSupplier<? extends InputStream> |
getSource()
Get the import source |
void |
setParameter(String name,
String value)
Set a parameter |
void |
setSource(LocatableInputSupplier<? extends InputStream> source)
Set the import source |
void |
storeConfiguration(Map<String,String> configuration)
Stores all parameters that were set using AbstractIOProvider.setParameter(String, String) in the configuration. |
void |
validate()
Validate the I/O provider configuration |
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider |
---|
addSupportedParameter, execute, fail, getContentType, getDefaultTypeName, getParameter, getSupportedParameters, getTypeName, loadConfiguration, setContentType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider |
---|
getContentType, getParameter, getSupportedParameters, isCancelable, loadConfiguration, setContentType |
Constructor Detail |
---|
public AbstractImportProvider()
Method Detail |
---|
public IOReport execute(ProgressIndicator progress) throws IOProviderConfigurationException, IOException
IOProvider
execute
in interface IOProvider
execute
in class AbstractIOProvider
progress
- the progress indicator, may be null
IOProviderConfigurationException
- if the I/O provider was not
configured properly
IOException
- if an I/O operation failsAbstractIOProvider.execute(ProgressIndicator)
protected String generateResourceId()
public void setSource(LocatableInputSupplier<? extends InputStream> source)
ImportProvider
setSource
in interface ImportProvider
source
- the source input supplierImportProvider.setSource(LocatableInputSupplier)
public LocatableInputSupplier<? extends InputStream> getSource()
ImportProvider
getSource
in interface ImportProvider
ImportProvider.getSource()
public void validate() throws IOProviderConfigurationException
IOProvider
validate
in interface IOProvider
validate
in class AbstractIOProvider
IOProviderConfigurationException
- if the I/O provider was not
configured properlyAbstractIOProvider.validate()
public void storeConfiguration(Map<String,String> configuration)
AbstractIOProvider
AbstractIOProvider.setParameter(String, String)
in the configuration. For changing
the behavior please override this method.
storeConfiguration
in interface IOProvider
storeConfiguration
in class AbstractIOProvider
configuration
- the configuration to populateAbstractIOProvider.storeConfiguration(Map)
public void setParameter(String name, String value)
IOProvider
setParameter
in interface IOProvider
setParameter
in class AbstractIOProvider
name
- the parameter namevalue
- the parameter valueAbstractIOProvider.setParameter(String, String)
public IOReporter createReporter()
IOProvider
IOProvider.execute(ProgressIndicator)
.
createReporter
in interface IOProvider
IOProvider.createReporter()
public String getResourceIdentifier()
ImportProvider
getResourceIdentifier
in interface ImportProvider
null
if the provider
was not executed yetImportProvider.getResourceIdentifier()
|
Humboldt Alignment Editor 2.5.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |