de.unirostock.sems.cbarchive.gui.model

Class MainModel

java.lang.Object

de.unirostock.sems.cbarchive.gui.model.MainModel

public final class MainModel
extends Object

TODO - javadoc.

Author:

FloWela

Constructor Summary

Constructors

Constructor and Description
MainModel() Instantiates a new main model.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFile(File file, String targetName, File archiveFile) Add the specified file to the combine archive as targetName.
void	closeArchive(File archiveFile) Closes the specified archive file.
void	createArchive(File archiveFile) Creates the archive.
void	extractArchive(File destination, File archiveFile) Extracts the complete combine archive to the specified destination file.
void	extractArchiveEntries(File destination, File archiveFile, Collection<de.unirostock.sems.cbarchive.ArchiveEntry> archiveEntries) Extracts the specified subset of ArchiveEntries from the specified combine archive to destination.
Collection<File>	getArchives() XXX - needed?.
List<de.unirostock.sems.cbarchive.ArchiveEntry>	listEntries(File archiveFile) Retrieves the entries of the combine archive.
void	moveArchiveEntriesToArchive(File fromArchive, List<de.unirostock.sems.cbarchive.ArchiveEntry> entries, File toArchive, String newPath) Move archive entries to archive.
void	moveArchiveEntry(File archive, de.unirostock.sems.cbarchive.ArchiveEntry entry, String newPath) Move archive entry.
void	openArchive(File archiveFile) Opens a combine archive files using combine archive java library.

Methods inherited from class java.lang.Object

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

Constructor Detail

MainModel

public MainModel()

Instantiates a new main model.

Method Detail

createArchive

public void createArchive(File archiveFile)
                   throws Exception

Creates the archive.

Parameters:

archiveFile - the archive file

Throws:

Exception - the exception

openArchive

public void openArchive(File archiveFile)
                 throws IOException,
                        org.jdom2.JDOMException,
                        ParseException,
                        de.unirostock.sems.cbarchive.CombineArchiveException

Opens a combine archive files using combine archive java library.

Parameters:

archiveFile - the archive file

Throws:

IOException - Signals that an I/O exception has occurred.

org.jdom2.JDOMException - the jDOM exception

ParseException - the parse exception

de.unirostock.sems.cbarchive.CombineArchiveException - the combine archive exception

getArchives

public Collection<File> getArchives()

XXX - needed?.

Returns:

the archives

closeArchive

public void closeArchive(File archiveFile)
                  throws IOException,
                         TransformerException

Closes the specified archive file.

Parameters:

archiveFile - the archive file

Throws:

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

extractArchive

public void extractArchive(File destination,
                  File archiveFile)
                    throws IOException

Extracts the complete combine archive to the specified destination file. If destination is a directory, then all files are extracted into this directory. Otherwise, the files are extracted into the same directory as destination.

Parameters:

destination - - folder/file, files are extracted to

archiveFile - - combine archive file

Throws:

IOException - Signals that an I/O exception has occurred.

extractArchiveEntries

public void extractArchiveEntries(File destination,
                         File archiveFile,
                         Collection<de.unirostock.sems.cbarchive.ArchiveEntry> archiveEntries)
                           throws IOException

Extracts the specified subset of ArchiveEntries from the specified combine archive to destination. XXX - allow access via ArchiveEntry? what about string and then using getEntry(String location)?

Parameters:

destination - the destination

archiveFile - the archive file

archiveEntries - the archive entries

Throws:

IOException - Signals that an I/O exception has occurred.

addFile

public void addFile(File file,
           String targetName,
           File archiveFile)
             throws IOException,
                    TransformerException

Add the specified file to the combine archive as targetName.

Parameters:

file - the file

targetName - the target name

archiveFile - the archive file

Throws:

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

moveArchiveEntry

public void moveArchiveEntry(File archive,
                    de.unirostock.sems.cbarchive.ArchiveEntry entry,
                    String newPath)
                      throws IOException,
                             TransformerException

Move archive entry.

Parameters:

archive - the archive

entry - the entry

newPath - the new path

Throws:

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

moveArchiveEntriesToArchive

public void moveArchiveEntriesToArchive(File fromArchive,
                               List<de.unirostock.sems.cbarchive.ArchiveEntry> entries,
                               File toArchive,
                               String newPath)
                                 throws IOException,
                                        TransformerException

Move archive entries to archive.

Parameters:

fromArchive - the from archive

entries - the entries

toArchive - the to archive

newPath - the new path

Throws:

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

listEntries

public List<de.unirostock.sems.cbarchive.ArchiveEntry> listEntries(File archiveFile)

Retrieves the entries of the combine archive.

Parameters:

archiveFile - the archive file

Returns:

the list