org.wandora.topicmap.packageio

Class ZipPackageInput

java.lang.Object

org.wandora.topicmap.packageio.ZipPackageInput

All Implemented Interfaces:

PackageInput

public class ZipPackageInput
extends java.lang.Object
implements PackageInput

Reads entries from a zip file. Entries are stored in ZIP file in the same order they were entered with ZipPackageOutput. Searching entries is relatively smart, gotoEntry will scan the file from the current position for the requested entry, unless the entry has been seen already and it is known to be before the current file position. However it is always best to read entries in the order they appear in the file if possible. This avoids opening the file several times which in the case of a remote file means transferring the file several times over network.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
private int	currentEntry
private java.util.List<java.lang.String>	entries
private java.util.List<java.lang.String>	passedEntries
private java.net.URL	url
private java.util.zip.ZipInputStream	zis

Constructor Summary

Constructors

Constructor and Description
ZipPackageInput(java.io.File file) Creates a new instance of ZipPackageInput
ZipPackageInput(java.lang.String file)
ZipPackageInput(java.net.URL url)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file.
java.util.Collection<java.lang.String>	getEntries() Gets the names of all entries in the file.
java.io.InputStream	getInputStream() Gets the input stream for current entry.
java.lang.String	getSeparator() Returns file separator used by the PackageInput.
boolean	gotoEntry(java.lang.String name) Moves to the entry with the specified name.
boolean	gotoEntry(java.lang.String path, java.lang.String name) Moves to the entry that has the given path and name.
java.lang.String	gotoNextEntry() Goes to next entry in the file.
java.lang.String	joinPath(java.lang.String path, java.lang.String name) Joins path and name, and returns joined resource name.
private void	openStream()

Methods inherited from class java.lang.Object

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

Field Detail

url

private java.net.URL url

zis

private java.util.zip.ZipInputStream zis

entries

private java.util.List<java.lang.String> entries

passedEntries

private java.util.List<java.lang.String> passedEntries

currentEntry

private int currentEntry

Constructor Detail

ZipPackageInput

public ZipPackageInput(java.io.File file)
                throws java.io.IOException

Creates a new instance of ZipPackageInput

Throws:

java.io.IOException

ZipPackageInput

public ZipPackageInput(java.lang.String file)
                throws java.io.IOException

Throws:

java.io.IOException

ZipPackageInput

public ZipPackageInput(java.net.URL url)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

openStream

private void openStream()
                 throws java.io.IOException

Throws:

java.io.IOException

gotoEntry

public boolean gotoEntry(java.lang.String name)
                  throws java.io.IOException

Moves to the entry with the specified name. Returns true if that entry was found, false otherwise.

Specified by:

gotoEntry in interface PackageInput

Returns:

Throws:

java.io.IOException

gotoEntry

public boolean gotoEntry(java.lang.String path,
                         java.lang.String name)
                  throws java.io.IOException

Description copied from interface: PackageInput

Moves to the entry that has the given path and name.

Specified by:

gotoEntry in interface PackageInput

Returns:

Throws:

java.io.IOException

gotoNextEntry

public java.lang.String gotoNextEntry()
                               throws java.io.IOException

Goes to next entry in the file.

Specified by:

gotoNextEntry in interface PackageInput

Returns:

String

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Gets the input stream for current entry.

Specified by:

getInputStream in interface PackageInput

Returns:

InputStream

Throws:

java.io.IOException

getEntries

public java.util.Collection<java.lang.String> getEntries()
                                                  throws java.io.IOException

Gets the names of all entries in the file. This requires scanning of the entire file and then reopening the file after the entries are later actually read when gotoEntry or gotoNextEntry is called.

Specified by:

getEntries in interface PackageInput

Returns:

Collection of entries in the package.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes the file.

Specified by:

close in interface PackageInput

Throws:

java.io.IOException

getSeparator

public java.lang.String getSeparator()

Description copied from interface: PackageInput

Returns file separator used by the PackageInput.

Specified by:

getSeparator in interface PackageInput

Returns:

joinPath

public java.lang.String joinPath(java.lang.String path,
                                 java.lang.String name)

Description copied from interface: PackageInput

Joins path and name, and returns joined resource name. Usually Package input adds a separator string between the path and the name. For example, DirectoryPackageInput adds File.separator string between the path and the name.

Specified by:

joinPath in interface PackageInput

Returns: