zipios::FileCollection Class Reference

#include <fcoll.h>

Inheritance diagram for zipios::FileCollection:

Public Types
enum	MatchPath { IGN, MATCH }
Public Member Functions
virtual FileCollection *	clone () const =0
	Create a heap allocated clone of the object this method is called for.
virtual void	close ()=0
	Closes the FileCollection.
virtual ConstEntries	entries () const
	FileCollection (const FileCollection &src)
	Copy constructor.
	FileCollection ()
	FileCollection constructor.
virtual ConstEntryPointer	getEntry (const string &name, MatchPath matchpath=MATCH) const
virtual istream *	getInputStream (const string &entry_name, MatchPath matchpath=MATCH)=0
	Returns a pointer to an opened istream for the specified entry name.
virtual istream *	getInputStream (const ConstEntryPointer &entry)=0
virtual string	getName () const
	Returns the name of the FileCollection.
bool	isValid () const
	The member function returns true if the collection is valid.
const FileCollection &	operator= (const FileCollection &src)
	Copy assignment operator.
virtual int	size () const
	Returns the number of entries in the FileCollection.
virtual	~FileCollection ()
	FileCollection destructor.
Protected Attributes
Entries	_entries
string	_filename
bool	_valid

Detailed Description

FileCollection is an abstract baseclass that represents a collection of files. The specializations of FileCollection represents different origins of file collections, such as directories, simple filename lists and compressed archives.

Definition at line 21 of file fcoll.h.

Member Enumeration Documentation

enum zipios::FileCollection::MatchPath

Enumerator:

IGN
MATCH

Definition at line 38 of file fcoll.h.

Constructor & Destructor Documentation

zipios::FileCollection::FileCollection ( ) [inline, explicit]

FileCollection constructor.

Definition at line 24 of file fcoll.h.

zipios::FileCollection::FileCollection ( const FileCollection & src )

Copy constructor.

Definition at line 14 of file fcoll.cpp.

References _entries.

zipios::FileCollection::~FileCollection ( ) [virtual]

FileCollection destructor.

Definition at line 87 of file fcoll.cpp.

Member Function Documentation

virtual FileCollection* zipios::FileCollection::clone ( ) const [pure virtual]

Create a heap allocated clone of the object this method is called for.

The caller is responsible for deallocating the clone when he is done with it.

Returns:: A heap allocated copy of the object this method is called for.

Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.

Referenced by zipios::CollectionCollection::addCollection().

virtual void zipios::FileCollection::close ( ) [pure virtual]

Closes the FileCollection.

Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.

ConstEntries zipios::FileCollection::entries ( ) const [virtual]

Returns a vector of const pointers to the entries in the FileCollection.

Returns:: a ConstEntries containing the entries of the FileCollection.

Exceptions:

InvalidStateException

Thrown if the collection is invalid.

Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.

Definition at line 41 of file fcoll.cpp.

References _entries, and _valid.

Referenced by Gui::OnlineDocumentation::OnlineDocumentation(), and zipios::operator<<().

ConstEntryPointer zipios::FileCollection::getEntry	(	const string &	name,
		MatchPath	matchpath = `MATCH`
	)			const `[virtual]`

Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. To ignore the path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.

Parameters:

	name	A string containing the name of the entry to get.
	matchpath	Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored.

Returns:: A ConstEntryPointer to the found entry. The returned pointer equals zero if no entry is found.

Exceptions:

InvalidStateException

Thrown if the collection is invalid.

Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.

Definition at line 58 of file fcoll.cpp.

References _entries, _valid, and MATCH.

Referenced by zipios::ZipFile::getInputStream(), and Gui::OnlineDocumentation::loadResource().

virtual istream* zipios::FileCollection::getInputStream	(	const string &	entry_name,
		MatchPath	matchpath = `MATCH`
	)			`[pure virtual]`

Returns a pointer to an opened istream for the specified entry name.

It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the FileCollection.

Parameters:

	entry_name
	matchpath	Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored.

Returns:: an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.

Exceptions:

InvalidStateException

Thrown if the collection is invalid.

Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.

virtual istream* zipios::FileCollection::getInputStream ( const ConstEntryPointer & entry ) [pure virtual]

Returns a pointer to an opened istream for the specified FileEntry. It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the FileCollection.

Parameters:

entry

A ConstEntryPointer to the FileEntry to get an istream to.

Returns:: an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.

Exceptions:

InvalidStateException

Thrown if the collection is invalid.

Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.

string zipios::FileCollection::getName ( ) const [virtual]

Returns the name of the FileCollection.