Module platform.core

Package de.grogra.pf.io

Class LazyFilter

java.lang.Object

de.grogra.pf.io.FilterBase

de.grogra.pf.io.LazyFilter

All Implemented Interfaces:

DOMSource, FileReaderSource, FileWriterSource, Filter, FilterSource, InputStreamSource, ObjectSource, OutputStreamSource, ReaderSource, SAXSource, VirtualFileReaderSource, VirtualFileWriterSource, WriterSource, RegistryContext, Configurable, Map

public abstract class LazyFilter
extends FilterBase
implements InputStreamSource, OutputStreamSource, ReaderSource, WriterSource, FileReaderSource, FileWriterSource, ObjectSource, SAXSource, DOMSource, Configurable, VirtualFileReaderSource, VirtualFileWriterSource

Nested Class Summary

Nested classes/interfaces inherited from interface de.grogra.pf.io.FilterSource

FilterSource.MetaDataKey<V>

Nested classes/interfaces inherited from interface de.grogra.util.Map

Map.Chain

Field Summary

Fields inherited from class de.grogra.pf.io.FilterBase

item, source

Fields inherited from interface de.grogra.pf.io.FilterSource

AUTO_PROGRESS, DESTINATION_FILE, DESTINATION_URL

Fields inherited from interface de.grogra.util.Map

DEFAULT_VALUE, EMPTY_MAP

Fields inherited from interface de.grogra.pf.io.SAXSource

NAMESPACE_PREFIXES, NAMESPACES

Constructor Summary

Constructors

Constructor	Description
LazyFilter(FilterItem item, FilterSource source, IOFlavor flavor)

Method Summary

Modifier and Type	Method	Description
void	addConfigurations(ConfigurationSet set)	This method is invoked to obtain the configurable options of this Configurable object.
protected abstract FilterSource	createFilterSource()
Document	getDocument()	Returns the data as a DOM document.
boolean	getFeature(String name)
Object	getFile()	Returns the file from which the data can be obtained.
FileSystem	getFileSystem()	Returns the file system in which the file is contained.
protected final FilterSource	getFilterSource()
File	getInputFile()	Returns the file from which the data can be obtained.
InputStream	getInputStream()	Returns a stream to obtain the data as a stream of bytes.
Object	getObject()	Returns the data as an object of a class which is compatible which the flavor.
Reader	getReader()	Returns a reader to obtain the data as a stream of characters.
long	length()	Returns the total number of bytes of this stream.
void	parse(ContentHandler ch, ErrorHandler eh, LexicalHandler lh, DTDHandler dh, EntityResolver er)
void	setFeature(String name, boolean value)
void	write(FileSystem fs, Object out)	This method writes the data to out.
void	write(File out)	This method writes the data to out.
void	write(OutputStream out)	This method writes the data to out.
void	write(Writer out)	This method writes the data to out.

Methods inherited from class de.grogra.pf.io.FilterBase

get, getFilter, getFlavor, getImpl, getMetaData, getRegistry, getSource, getSystemId, initProgressMonitor, setFlavor, setMetaData, setMetaData, setProgress, setSystemId, toString, toURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.grogra.pf.io.FilterSource

getFilter, getFlavor, getMetaData, getSystemId, initProgressMonitor, setMetaData, setProgress

Methods inherited from interface de.grogra.pf.registry.RegistryContext

getRegistry

Constructor Details

LazyFilter

public LazyFilter(FilterItem item,
 FilterSource source,
 IOFlavor flavor)

Method Details

createFilterSource

protected abstract FilterSource createFilterSource()

getFilterSource

protected final FilterSource getFilterSource()

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: InputStreamSource

Returns a stream to obtain the data as a stream of bytes.

Specified by:

getInputStream in interface InputStreamSource

Returns:

an input stream for the data

Throws:

IOException

length

public long length()

Description copied from interface: InputStreamSource

Returns the total number of bytes of this stream. A negative values indicates that this number is unknown.

Specified by:

length in interface InputStreamSource

Returns:

number of bytes

write

public void write(OutputStream out)
           throws IOException

Description copied from interface: OutputStreamSource

This method writes the data to out.

Specified by:

write in interface OutputStreamSource

Parameters:

out - the stream to which data is written

Throws:

IOException

getReader

public Reader getReader()
                 throws IOException

Description copied from interface: ReaderSource

Returns a reader to obtain the data as a stream of characters.

Specified by:

getReader in interface ReaderSource

Returns:

a reader for the data

Throws:

IOException

write

public void write(Writer out)
           throws IOException

Description copied from interface: WriterSource

This method writes the data to out.

Specified by:

write in interface WriterSource

Parameters:

out - the writer to which data is written

Throws:

IOException

getInputFile

public File getInputFile()

Description copied from interface: FileReaderSource

Returns the file from which the data can be obtained.

Specified by:

getInputFile in interface FileReaderSource

Returns:

file representing the data

write

public void write(File out)
           throws IOException

Description copied from interface: FileWriterSource

This method writes the data to out.

Specified by:

write in interface FileWriterSource

Parameters:

out - the file to which data is written

Throws:

IOException

getFileSystem

public FileSystem getFileSystem()

Description copied from interface: VirtualFileReaderSource

Returns the file system in which the file is contained.

Specified by:

getFileSystem in interface VirtualFileReaderSource

Returns:

file system

getFile

public Object getFile()

Description copied from interface: VirtualFileReaderSource

Returns the file from which the data can be obtained.

Specified by:

getFile in interface VirtualFileReaderSource

Returns:

file representing the data

write

public void write(FileSystem fs,
 Object out)
           throws IOException

Description copied from interface: VirtualFileWriterSource

This method writes the data to out.

Specified by:

write in interface VirtualFileWriterSource

Parameters:

fs - the file system to which data is written

out - the file to which data is written

Throws:

IOException

getObject

public Object getObject()
                 throws IOException

Description copied from interface: ObjectSource

Returns the data as an object of a class which is compatible which the flavor.

Specified by:

getObject in interface ObjectSource

Returns:

the data

Throws:

IOException

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
SAXNotSupportedException

Specified by:

getFeature in interface SAXSource

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setFeature

public void setFeature(String name,
 boolean value)
                throws SAXNotRecognizedException,
SAXNotSupportedException

Specified by:

setFeature in interface SAXSource

Throws:

SAXNotRecognizedException

SAXNotSupportedException

parse

public void parse(ContentHandler ch,
 ErrorHandler eh,
 LexicalHandler lh,
 DTDHandler dh,
 EntityResolver er)
           throws IOException,
SAXException

Specified by:

parse in interface SAXSource

Throws:

IOException

SAXException

getDocument

public Document getDocument()
                     throws IOException,
DOMException

Description copied from interface: DOMSource

Returns the data as a DOM document.

Specified by:

getDocument in interface DOMSource

Returns:

the data

Throws:

IOException

DOMException

addConfigurations

public void addConfigurations(ConfigurationSet set)

Description copied from interface: Configurable

This method is invoked to obtain the configurable options of this Configurable object. The method has to add all Configurations of this object to the specified set.

Specified by:

addConfigurations in interface Configurable

Parameters:

set - a set to which configurations of this object are added