RetsXmlEvent Class Reference

(Internal) RetsXmlEvent is the super class from which the other Xml parsing classes inherit. More...

#include <librets/RetsXmlEvent.h>

Inheritance diagram for RetsXmlEvent:

RetsObject RetsXmlEndDocumentEvent RetsXmlEndElementEvent RetsXmlStartElementEvent RetsXmlTextEvent

List of all members.

Public Types

enum  Type { START_ELEMENT, END_ELEMENT, TEXT, END_DOCUMENT }
 Clasify the type of the Xml event. More...

Public Member Functions

 RetsXmlEvent ()
 Default constructor with default line and column numbers.
 RetsXmlEvent (int lineNumber, int columnNumber)
 Constructor specifying the line and column numbers for the element being parsed.
virtual ~RetsXmlEvent ()
virtual Type GetType () const =0
 Each chass inheriting from this class must provide this method.
int GetLineNumber () const
 Get the line number for this element.
int GetColumnNumber () const
 Get the column number for this element.
virtual std::ostream & Print (std::ostream &outputStream) const
std::string ToString () const
virtual bool Equals (const RetsObject *object) const

Protected Member Functions

std::ostream & PrintLineAndColumn (std::ostream &out) const

Protected Attributes

int mLineNumber
int mColumnNumber


Detailed Description

(Internal) RetsXmlEvent is the super class from which the other Xml parsing classes inherit.

Member Enumeration Documentation

enum Type

Clasify the type of the Xml event.

Enumerator:
START_ELEMENT  Indicates this is a start element (<RETS>).
END_ELEMENT  Indicates this is an end element (</RETS>).
TEXT  Indicates this is a text element.
END_DOCUMENT  Indicates this is the end of the XML document.


Constructor & Destructor Documentation

RetsXmlEvent (  ) 

Default constructor with default line and column numbers.

RetsXmlEvent ( int  lineNumber,
int  columnNumber 
)

Constructor specifying the line and column numbers for the element being parsed.

Parameters:
lineNumber An integer containing the line number
columnNumber An integer containing the column number

virtual ~RetsXmlEvent (  )  [virtual]


Member Function Documentation

virtual bool Equals ( const RetsObject object  )  const [virtual, inherited]

int GetColumnNumber (  )  const

Get the column number for this element.

Returns:
An integer containing the column number.

int GetLineNumber (  )  const

Get the line number for this element.

Returns:
An integer containing the line number.

virtual Type GetType (  )  const [pure virtual]

Each chass inheriting from this class must provide this method.

Implemented in RetsXmlEndDocumentEvent, RetsXmlEndElementEvent, RetsXmlStartElementEvent, and RetsXmlTextEvent.

virtual std::ostream& Print ( std::ostream &  outputStream  )  const [virtual, inherited]

std::ostream& PrintLineAndColumn ( std::ostream &  out  )  const [protected]

std::string ToString (  )  const [inherited]


Member Data Documentation

int mColumnNumber [protected]

int mLineNumber [protected]


Generated by  doxygen