com.revolsys.data.io

Class AbstractDirectoryReader<T>

java.lang.Object

com.revolsys.io.AbstractObjectWithProperties

com.revolsys.io.AbstractReader<T>

com.revolsys.data.io.AbstractDirectoryReader<T>

All Implemented Interfaces:

ObjectWithProperties, Reader<T>, AutoCloseable, Iterable<T>, Iterator<T>

Direct Known Subclasses:

RecordDirectoryReader

public abstract class AbstractDirectoryReader<T>
extends AbstractReader<T>
implements Iterator<T>

Constructor Summary

Constructors

Constructor and Description
AbstractDirectoryReader() Construct a new AbstractDirectoryReader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the reader.
protected abstract Reader<T>	createReader(org.springframework.core.io.Resource file) Create a new Reader to read the file.
List<String>	getBaseFileNames() Get the list of base file names to read.
File	getDirectory() Get the directory containing the files to read.
FilenameFilter	getFileNameFilter() Get the filter used to select files from the directory.
protected List<File>	getFiles() Get the files that are to be read by this reader.
boolean	hasNext() Check to see if the reader has more data objects to be read.
Iterator<T>	iterator() Get the iterator.
T	next() Get the next data object read by this reader.
void	open() Open the reader so that it is ready to be read from.
void	remove() Removing data objects is not supported.
void	setBaseFileNames(Collection<String> baseFileNames) Set the list of base file names to read.
void	setDirectory(File directory) Set the directory containing the files to read.
void	setFileExtensions(Collection<String> fileExtensions)
void	setFileExtensions(String... fileExtensions)
void	setFileNameFilter(FilenameFilter fileNameFilter) Set the filter used to select files from the directory.

Methods inherited from class com.revolsys.io.AbstractReader

read, visit

Methods inherited from class com.revolsys.io.AbstractObjectWithProperties

clearProperties, getProperties, getProperty, getProperty, removeProperty, setProperties, setProperty, setPropertySoft, setPropertyWeak

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.revolsys.io.ObjectWithProperties

clearProperties, getProperties, getProperty, getProperty, removeProperty, setProperties, setProperty, setPropertySoft, setPropertyWeak

Constructor Detail

AbstractDirectoryReader

public AbstractDirectoryReader()

Construct a new AbstractDirectoryReader.

Method Detail

close

public void close()

Close the reader.

Specified by:

close in interface Reader<T>

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractObjectWithProperties

createReader

protected abstract Reader<T> createReader(org.springframework.core.io.Resource file)

Create a new Reader to read the file.

Parameters:

file - The file to read.

Returns:

The reader for the file.

getBaseFileNames

public List<String> getBaseFileNames()

Get the list of base file names to read.

Returns:

The list of base file names to read.

getDirectory

public File getDirectory()

Get the directory containing the files to read.

Returns:

The directory containing the files to read.

getFileNameFilter

public FilenameFilter getFileNameFilter()

Get the filter used to select files from the directory.

Returns:

The filter used to select files from the directory.

getFiles

protected List<File> getFiles()

Get the files that are to be read by this reader. This must be overwritten in sub classes to return the files in the working directory that are to be read by instances of the write returned by #createReader(File).

Returns:

The list of files.

hasNext

public boolean hasNext()

Check to see if the reader has more data objects to be read.

Specified by:

hasNext in interface Iterator<T>

Returns:

True if the reader has more data objects to be read.

iterator

public Iterator<T> iterator()

Get the iterator.

Specified by:

iterator in interface Reader<T>

Specified by:

iterator in interface Iterable<T>

Returns:

The iterator.

next

public T next()

Get the next data object read by this reader.

Specified by:

next in interface Iterator<T>

Returns:

The next Record.

Throws:

NoSuchElementException - If the reader has no more data objects.

open

@PostConstruct
public void open()

Description copied from interface: Reader

Open the reader so that it is ready to be read from.

Specified by:

open in interface Reader<T>

remove

public void remove()

Removing data objects is not supported.

Specified by:

remove in interface Iterator<T>

setBaseFileNames

public void setBaseFileNames(Collection<String> baseFileNames)

Set the list of base file names to read.

Parameters:

baseFileNames - The list of base file names to read.

setDirectory

public void setDirectory(File directory)

Set the directory containing the files to read.

Parameters:

directory - The directory containing the files to read.

setFileExtensions

public void setFileExtensions(Collection<String> fileExtensions)

setFileExtensions

public void setFileExtensions(String... fileExtensions)

setFileNameFilter

public void setFileNameFilter(FilenameFilter fileNameFilter)

Set the filter used to select files from the directory.

Parameters:

fileNameFilter - The filter used to select files from the directory.