Package de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl

Class AbstractXMLReader

java.lang.Object

de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

de.uni_trier.wi2.procake.data.io.IOImpl

de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl.AbstractXMLReader

All Implemented Interfaces:

IO, ProCAKEReader

Direct Known Subclasses:

AdaptationConfigReader, DependencyReader, ModelReader, NESTGraphReader, ObjectPoolReader, ObjectReader, SimilarityModelReader, TrainingObjectPoolReader, TransformationConfigReaderImpl

public abstract class AbstractXMLReader
extends IOImpl
implements ProCAKEReader

Base class for all XML-reader-implementations.

Author:

Alexander Stromer

Field Summary

Fields

Modifier and Type	Field	Description
protected String	filename	The filename/filepath which should be used to read from.
protected InputStream	inputStream	The internal reader-object used for reading data.

Fields inherited from interface de.uni_trier.wi2.procake.utils.io.IO

DEFAULT_ENCODING, LOG_FILE_NOT_FOUND, LOG_IO_EXCEPTION, LOG_READER_NOT_FOUND, LOG_SAX_EXCEPTION, LOG_UNKNOWN_PARAMETER, LOG_WRONG_PARAMATER_TYPE, RESOURCE_XML

Fields inherited from interface de.uni_trier.wi2.procake.utils.io.ProCAKEReader

LOG_ENTITY_NOT_FOUND, LOG_UNKNOWN_ATTRIBUTE_IN_TAG

Constructor Summary

Constructors

Constructor	Description
AbstractXMLReader()

Method Summary

Modifier and Type	Method	Description
String	getFilename()	Returns the name of the file, which was set to be read.
protected abstract AbstractXMLHandler	provideHandler()	Provides a handler by the subclass in order to be used to create the parser.
Object	read()	Reads the give filename or input source and returns the parsed object.
void	setFilename(String filename)	Each reader must be able to read a file from a specified path.
void	setInputStream(InputStream inputStream)	Each reader must be able to read from an input stream.
String	toString()

Methods inherited from class de.uni_trier.wi2.procake.data.io.IOImpl

getFamily, getParameters, postInit, preInit, setFamily

Methods inherited from class de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

getParameter, initParametersBasedOn

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_trier.wi2.procake.utils.io.IO

copy, getFamily, getName, isHandlerFor, setFamily

Field Details

filename

protected String filename

The filename/filepath which should be used to read from.

inputStream

protected InputStream inputStream

The internal reader-object used for reading data.

Constructor Details

AbstractXMLReader

public AbstractXMLReader()

Method Details

getFilename

public String getFilename()

Returns the name of the file, which was set to be read.

Returns:

The name of the file.

setFilename

public void setFilename(String filename)

Each reader must be able to read a file from a specified path.

Specified by:

setFilename in interface ProCAKEReader

Parameters:

filename - The filename that should be read.

setInputStream

public void setInputStream(InputStream inputStream)

Each reader must be able to read from an input stream.

Specified by:

setInputStream in interface ProCAKEReader

Parameters:

inputStream - The that should be read.

toString

public String toString()

Overrides:

toString in class Object

provideHandler

protected abstract AbstractXMLHandler provideHandler()

Provides a handler by the subclass in order to be used to create the parser. This should reduce code duplicates.

Returns:

the provided content handler

read

public Object read()
            throws CAKEIOException

Reads the give filename or input source and returns the parsed object.

Specified by:

read in interface ProCAKEReader

Returns:

Returns the parsed object.

Throws:

CAKEIOException