IO::ExcelXmlReader Class Reference
#include <excelxmlreader.h>
Inheritance diagram for IO::ExcelXmlReader:
Detailed Description
A stream reader class which reads Excel XML files. NOTE: the strings returned by this class will be in UTF-8 format!(C) 2008 Radon Labs GmbH
Public Member Functions | |
| ExcelXmlReader () | |
| constructor | |
| virtual | ~ExcelXmlReader () |
| destructor | |
| virtual bool | Open () |
| begin reading from the stream | |
| virtual void | Close () |
| end reading from the stream | |
| SizeT | GetNumTables () const |
| get the number of tables in the file | |
| const Util::String & | GetTableName (IndexT tableIndex=0) const |
| get the name of the table at given table index | |
| IndexT | GetTableIndex (const Util::String &tableName) |
| get index of table by name | |
| SizeT | GetNumRows (IndexT tableIndex=0) const |
| get number of rows in table | |
| SizeT | GetNumColumns (IndexT tableIndex=0) const |
| get number of columns in table | |
| bool | HasColumn (const Util::String &columnName, IndexT tableIndex=0) const |
| return true if table has named column | |
| IndexT | FindColumnIndex (const Util::String &columnName, IndexT tableIndex=0) const |
| get column index by name, returns InvalidIndex if column doesn't exist | |
| const Util::String & | GetElement (IndexT rowIndex, IndexT columnIndex, IndexT tableIndex=0) const |
| get cell content by row index and column index | |
| const Util::String & | GetElement (IndexT rowIndex, const Util::String &columnName, IndexT tableIndex=0) const |
| get cell content by row index and column name (SLOW!) | |
| void | SetStream (const Ptr< Stream > &s) |
| set stream to read from | |
| const Ptr< Stream > & | GetStream () const |
| get currently set stream | |
| bool | HasStream () const |
| return true if a stream is set | |
| bool | Eof () const |
| return true if the stream has reached EOF | |
| bool | IsOpen () const |
| return true if currently open | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| bool IO::ExcelXmlReader::Open | ( | ) | [virtual] |
begin reading from the stream
Open the Excel-XML-stream and completely parse its content.
Reimplemented from IO::StreamReader.
| bool IO::ExcelXmlReader::HasColumn | ( | const Util::String & | columnName, | |
| IndexT | tableIndex = 0 | |||
| ) | const |
return true if table has named column
NOTE: this method is slow because it does a linear search over the column names.
| IndexT IO::ExcelXmlReader::FindColumnIndex | ( | const Util::String & | columnName, | |
| IndexT | tableIndex = 0 | |||
| ) | const |
get column index by name, returns InvalidIndex if column doesn't exist
NOTE: this method is slow because it does a linear search over the column names.
set stream to read from
Attaches the reader to a stream. This will imcrement the refcount of the stream.
Reimplemented in Messaging::MessageReader.
get currently set stream
Get pointer to the attached stream. If there is no stream attached, an assertion will be thrown. Use HasStream() to determine if a stream is attached.
| bool IO::StreamReader::HasStream | ( | ) | const [inherited] |
return true if a stream is set
Returns true if a stream is attached to the reader.
| int Core::RefCounted::GetRefCount | ( | ) | const [inline, inherited] |
get the current refcount
Return the current refcount of the object.
| void Core::RefCounted::AddRef | ( | ) | [inline, inherited] |
increment refcount by one
Increment the refcount of the object.
| void Core::RefCounted::Release | ( | ) | [inline, inherited] |
decrement refcount and destroy object if refcount is zero
Decrement the refcount and destroy object if refcount is zero.
| const Util::String & Core::RefCounted::GetClassName | ( | ) | const [inline, inherited] |
get the class name
Get the class name of the object.
| Util::FourCC Core::RefCounted::GetClassFourCC | ( | ) | const [inline, inherited] |
get the class FourCC code
Get the class FourCC of the object.
| void Core::RefCounted::DumpRefCountingLeaks | ( | ) | [static, inherited] |
dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)
This method should be called as the very last before an application exits.