org.openimaj.data.dataset

Class VFSListDataset.FileObjectISReader<INSTANCE>

java.lang.Object

org.openimaj.data.dataset.VFSListDataset.FileObjectISReader<INSTANCE>

Type Parameters:

INSTANCE - The type of instance that the InputStreamObjectReader produces

All Implemented Interfaces:

ObjectReader<INSTANCE,org.apache.commons.vfs2.FileObject>

Enclosing class:

VFSListDataset<INSTANCE>

public static class VFSListDataset.FileObjectISReader<INSTANCE>
extends Object
implements ObjectReader<INSTANCE,org.apache.commons.vfs2.FileObject>

An adaptor that lets InputStreamObjectReaders be used as a ObjectReader with a FileObject source type.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
FileObjectISReader(InputStreamObjectReader<INSTANCE> reader) Construct with the given InputStreamObjectReader

Method Summary

Modifier and Type	Method and Description
boolean	canRead(org.apache.commons.vfs2.FileObject source, String name) Returns true if the stream can be read, or false otherwise.
INSTANCE	read(org.apache.commons.vfs2.FileObject source) Read an object from the source

Methods inherited from class java.lang.Object

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

Constructor Detail

FileObjectISReader

public FileObjectISReader(InputStreamObjectReader<INSTANCE> reader)

Construct with the given InputStreamObjectReader

Parameters:

reader - the InputStreamObjectReader

Method Detail

read

public INSTANCE read(org.apache.commons.vfs2.FileObject source)
              throws IOException

Description copied from interface: ObjectReader

Read an object from the source

Specified by:

read in interface ObjectReader<INSTANCE,org.apache.commons.vfs2.FileObject>

Parameters:

source - the source

Returns:

the object

Throws:

IOException - if an error occurs

canRead

public boolean canRead(org.apache.commons.vfs2.FileObject source,
                       String name)

Description copied from interface: ObjectReader

Returns true if the stream can be read, or false otherwise.

This method is not normally called directly; rather, IOUtils.canRead(ObjectReader, Object, String) should be used instead.

Specified by:

canRead in interface ObjectReader<INSTANCE,org.apache.commons.vfs2.FileObject>

Parameters:

source - the data source

name - the name of the file behind the stream (can be null).

Returns:

true if this ObjectReader can read the stream; false otherwise.

See Also:

IOUtils.canRead(ObjectReader, Object, String)