Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.io.project.jaxb.reader
Class ProjectParser

java.lang.Object
  extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
      extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractImportProvider
          extended by eu.esdihumboldt.hale.io.project.jaxb.reader.ProjectParser
All Implemented Interfaces:
ImportProvider, IOProvider, ProjectReader

public class ProjectParser
extends AbstractImportProvider
implements ProjectReader

The project parser reads a given project XML file and populates a Project instance accordingly.

Author:
Thorsten Reitz, Simon Templer

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
ProjectParser()
           
 
Method Summary
protected  IOReport execute(ProgressIndicator progress, IOReporter reporter)
          Execute the I/O provider.
protected  String getDefaultTypeName()
          Get the default type name if no content type is provided
 Project getProject()
          Get the loaded main project
 Map<String,ProjectFile> getProjectFiles()
          Get the additional project files
 boolean isCancelable()
          States if the execution of the provider is cancelable
 void setProjectFiles(Map<String,ProjectFile> projectFiles)
          Set the project files to read if applicable.
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractImportProvider
createReporter, execute, generateResourceId, getResourceIdentifier, getSource, setParameter, setSource, storeConfiguration, validate
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
addSupportedParameter, fail, getContentType, 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.ImportProvider
getResourceIdentifier, getSource, setSource
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider
createReporter, execute, getContentType, getParameter, getSupportedParameters, loadConfiguration, setContentType, setParameter, storeConfiguration, validate
 

Constructor Detail

ProjectParser

public ProjectParser()
Method Detail

isCancelable

public boolean isCancelable()
Description copied from interface: IOProvider
States if the execution of the provider is cancelable

Specified by:
isCancelable in interface IOProvider
Returns:
if the execution is cancelable
See Also:
IOProvider.isCancelable()

setProjectFiles

public void setProjectFiles(Map<String,ProjectFile> projectFiles)
Description copied from interface: ProjectReader
Set the project files to read if applicable.

Specified by:
setProjectFiles in interface ProjectReader
Parameters:
projectFiles - the project files to read (file name mapped to project file)
See Also:
ProjectReader.setProjectFiles(Map)

getProjectFiles

public Map<String,ProjectFile> getProjectFiles()
Description copied from interface: ProjectReader
Get the additional project files

Specified by:
getProjectFiles in interface ProjectReader
Returns:
the project files (file name mapped to project file)
See Also:
ProjectReader.getProjectFiles()

getProject

public Project getProject()
Description copied from interface: ProjectReader
Get the loaded main project

Specified by:
getProject in interface ProjectReader
Returns:
the project or null if it has not been loaded
See Also:
ProjectReader.getProject()

getDefaultTypeName

protected String getDefaultTypeName()
Description copied from class: AbstractIOProvider
Get the default type name if no content type is provided

Specified by:
getDefaultTypeName in class AbstractIOProvider
Returns:
the default content type
See Also:
AbstractIOProvider.getDefaultTypeName()

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 indicator
reporter - 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)

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d