Package csv.impl

Class XmlReader

java.lang.Object

csv.impl.AbstractTableReader

csv.impl.AbstractStreamTableReader

csv.impl.XmlReader

All Implemented Interfaces:

TableReader, Iterable<Object[]>, Iterator<Object[]>

public class XmlReader
extends AbstractStreamTableReader

Reads from a XML file.

Author:

ralph

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	END_OF_FILE_INDEX

Constructor Summary

Constructors

Constructor	Description
XmlReader()	Constructor.
XmlReader(File file)	Constructor.
XmlReader(InputStream in)	Constructor.
XmlReader(String file)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the stream.
protected void	deliverComments()	Handles all comments that were registered for current row.
protected void	deliverComments(int rowIndex)	Handles all comments that were registered for current row.
String	getColumnNameAttribute()	Returns the attribute name of column tag that will contain the attribute name.
String	getColumnTagName()	Returns the column tag name.
String	getColumnTypeAttribute()	Returns the attribute name of column tag that contains the type of value.
String	getRowTagName()	Returns the row tag name.
boolean	hasNext()	Returns true if there are more rows.
protected void	initParser()	Initializes the XML parser thread.
boolean	isUseColumnNameTags()	Returns whether column names will be used as column tag names.
Object[]	next()	Returns the next row.
protected void	readHeaderRow()	Reads the header row.
protected void	readNextRow()	Reads the next row.
void	reset()	Resets the reader.
void	setColumnNameAttribute(String columnNameAttribute)	Sets the attribute name of column tag that will contain the attribute name.
void	setColumnTagName(String columnTagName)	Sets the column tag name.
void	setColumnTypeAttribute(String columnTypeAttribute)	Sets the attribute name of column tag that contains the type of value.
void	setRowTagName(String rowTagName)	Sets the row tag name.
void	setUseColumnNameTags(boolean useColumnNameTags)	Sets whether column names will be used as column tag names.

Methods inherited from class csv.impl.AbstractStreamTableReader

createInputStreamReader, createReader, getCharsetDecoder, getInputStream, getReader, remove, setCharset, setCharset, setCharsetDecoder, setInputStream

Methods inherited from class csv.impl.AbstractTableReader

addCommentCallBack, convert, convert, convertArray, convertArray, get, getColumnIndex, getColumnType, getHeaderRow, getLineCount, getMinimumColumnCount, getRowCount, getTypeConversionHandler, hasHeaderRow, incrementLineCount, incrementRowCount, isHeaderRowRead, iterator, notifyComment, open, registerCommentCallBack, registerTypeConversionHandler, removeCommentCallBack, setColumnType, setHasHeaderRow, setHeaderRow, setHeaderRowRead, setMinimumColumnCount, unregisterCommentCallBack, unregisterTypeConversionHandler

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from class java.lang.Object

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

Field Detail

END_OF_FILE_INDEX

protected static final int END_OF_FILE_INDEX

See Also:

Constant Field Values

Constructor Detail

XmlReader

public XmlReader()

Constructor.

XmlReader

public XmlReader(InputStream in)

Constructor.

Parameters:

in - stream to read

XmlReader

public XmlReader(File file)
          throws FileNotFoundException

Constructor.

Parameters:

file - fiel to read

Throws:

FileNotFoundException - when the file cannot be found

XmlReader

public XmlReader(String file)
          throws FileNotFoundException

Constructor.

Parameters:

file - file to read

Throws:

FileNotFoundException - when the file cannot be found

Method Detail

close

public void close()

Closes the stream.

Specified by:

close in interface TableReader

Overrides:

close in class AbstractStreamTableReader

See Also:

AbstractStreamTableReader.close()

reset

public void reset()

Resets the reader.

Specified by:

reset in interface TableReader

Overrides:

reset in class AbstractStreamTableReader

See Also:

AbstractStreamTableReader.reset()

hasNext

public boolean hasNext()

Returns true if there are more rows.

See Also:

Iterator.hasNext()

next

public Object[] next()

Returns the next row.

See Also:

Iterator.next()

readNextRow

protected void readNextRow()

Reads the next row.

readHeaderRow

protected void readHeaderRow()

Reads the header row.

Overrides:

readHeaderRow in class AbstractTableReader

See Also:

AbstractTableReader.readHeaderRow()

initParser

protected void initParser()

Initializes the XML parser thread.

deliverComments

protected void deliverComments()

Handles all comments that were registered for current row.

deliverComments

protected void deliverComments(int rowIndex)

Handles all comments that were registered for current row.

Parameters:

rowIndex - the index of the row to be processed

getRowTagName

public String getRowTagName()

Returns the row tag name.

Returns:

the rowTagName

setRowTagName

public void setRowTagName(String rowTagName)

Sets the row tag name.

Parameters:

rowTagName - the rowTagName to set

getColumnTagName

public String getColumnTagName()

Returns the column tag name.

Returns:

the columnTagName

setColumnTagName

public void setColumnTagName(String columnTagName)

Sets the column tag name.

Parameters:

columnTagName - the columnTagName to set

isUseColumnNameTags

public boolean isUseColumnNameTags()

Returns whether column names will be used as column tag names.

Returns:

the useColumnNameTags

setUseColumnNameTags

public void setUseColumnNameTags(boolean useColumnNameTags)

Sets whether column names will be used as column tag names.

Parameters:

useColumnNameTags - the useColumnNameTags to set

getColumnNameAttribute

public String getColumnNameAttribute()

Returns the attribute name of column tag that will contain the attribute name. This information is required only when isUseColumnNameTags() returns false.

Returns:

the columnNameAttribute

setColumnNameAttribute

public void setColumnNameAttribute(String columnNameAttribute)

Sets the attribute name of column tag that will contain the attribute name. This information is required only when isUseColumnNameTags() returns false.

Parameters:

columnNameAttribute - the columnNameAttribute to set

getColumnTypeAttribute

public String getColumnTypeAttribute()

Returns the attribute name of column tag that contains the type of value. The type is the value class and usually being used for type conversion.

Returns:

the columnTypeAttribute

setColumnTypeAttribute

public void setColumnTypeAttribute(String columnTypeAttribute)

Sets the attribute name of column tag that contains the type of value. The type is the value class and usually being used for type conversion.

Parameters:

columnTypeAttribute - the columnTypeAttribute to set