Package de.uni_trier.wi2.procake.data.io.text

Class StringReader

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.text.StringReader

All Implemented Interfaces:

IO, Reader

public class StringReader
extends IOImpl
implements Reader

A generic reader to read a string from a file/input stream using java.io.BufferedReader

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 input stream used for reading data.
static String	READERNAME	Constant READERNAME="StringReader"

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

COMPONENT, COMPONENT_KEY, DEFAULT_ENCODING, LOG_CONTENTHANDLER_NOT_FOUND, LOG_FILE_NOT_FOUND, LOG_IO_EXCEPTION, LOG_READER_NOT_FOUND, LOG_SAX_EXCEPTION, LOG_UNKNOWN_PARAMETER, LOG_WRITER_NOT_FOUND, LOG_WRONG_PARAMATER_TYPE, RESOURCE_XML

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

COMPONENT, COMPONENT_KEY, LOG_ENTITY_NOT_FOUND, LOG_MISSING_ATTRIBUTE_IN_TAG, LOG_NO_READER_FOUND, LOG_SAX_EXCEPTION, LOG_UNKNOWN_ATTRIBUTE_IN_TAG, LOG_UNKNOWN_TAG

Constructor Summary

Constructors

Constructor	Description
StringReader()

Method Summary

Modifier and Type	Method	Description
IO	copy()	overwritten copy-method from Object; use it to copy a complete operator
String	getName()	Each io component must have a name that is used in IOFactory.newIO(String).
boolean	isHandlerFor(Class value)	Checks if the io component is capable to perform the operation for objects of this class.
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.

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

getDescription, 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, toString, wait, wait, wait

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

getDescription, getFamily, setFamily

Field Detail

READERNAME

public static final String READERNAME

Constant READERNAME="StringReader"

See Also:

Constant Field Values

filename

protected String filename

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

inputStream

protected InputStream inputStream

The internal input stream used for reading data.

Constructor Detail

StringReader

public StringReader()

Method Detail

setFilename

public void setFilename(String filename)

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

Specified by:

setFilename in interface Reader

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 Reader

Parameters:

inputStream - The that should be read.

read

public Object read()
            throws CakeIOException

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

Specified by:

read in interface Reader

Returns:

Returns the parsed object.

Throws:

CakeIOException

getName

public String getName()

Each io component must have a name that is used in IOFactory.newIO(String). The name must be unique thus it is usefull to use a short description or to the class name ( this.getClass().getName()).

Specified by:

getName in interface IO

Returns:

Returns the name of the io component.

isHandlerFor

public boolean isHandlerFor(Class value)

Checks if the io component is capable to perform the operation for objects of this class.

A typical implementation looks like:

 public boolean isHandlerFor(Class value) {
        if (DataObject.class.isAssignableFrom(value))
                return true;
        return false;
 }
 

Specified by:

isHandlerFor in interface IO

Parameters:

value - The class that has to be checked.

Returns:

Results true if the class can oeprate with the given class.

copy

public IO copy()

overwritten copy-method from Object; use it to copy a complete operator

Specified by:

copy in interface IO

Returns: