Xalan-C++ API Reference  1.12.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
xalanc::XalanLocator Class Referenceabstract

This class defines a base class for Locator derivations in Xalan. More...

#include <xalanc/PlatformSupport/XalanLocator.hpp>

Inheritance diagram for xalanc::XalanLocator:
[legend]
Collaboration diagram for xalanc::XalanLocator:
[legend]

Public Types

typedef Locator ParentType
 

Public Member Functions

 XalanLocator ()
 
virtual ~XalanLocator ()
 
virtual const XMLCh * getPublicId () const =0
 
virtual const XMLCh * getSystemId () const =0
 
virtual XalanFileLoc getLineNumber () const =0
 
virtual XalanFileLoc getColumnNumber () const =0
 

Static Public Member Functions

static const XalanDOMChar * getPublicId (const Locator *theLocator, const XalanDOMChar *theAlternateId=getEmptyPtr())
 Get the public identifier from a locator object. More...
 
static const XalanDOMChar * getSystemId (const Locator *theLocator, const XalanDOMChar *theAlternateId=getEmptyPtr())
 Get the system identifier from a locator object. More...
 
static XalanFileLoc getLineNumber (const ParentType *theLocator)
 Get the line number from a locator object. More...
 
static XalanFileLoc getColumnNumber (const ParentType *theLocator)
 Get the column number from a locator object. More...
 
static XalanFileLoc getUnknownValue ()
 
static XalanFileLoc getUnknownDisplayValue ()
 
static bool isUnknownValue (XalanFileLoc theLocation)
 

Detailed Description

This class defines a base class for Locator derivations in Xalan.

It was defined because Xerces made changes in their Locator class which caused turbulence.

Definition at line 44 of file XalanLocator.hpp.

Member Typedef Documentation

◆ ParentType

Definition at line 48 of file XalanLocator.hpp.

Constructor & Destructor Documentation

◆ XalanLocator()

xalanc::XalanLocator::XalanLocator ( )
inline

Definition at line 50 of file XalanLocator.hpp.

◆ ~XalanLocator()

virtual xalanc::XalanLocator::~XalanLocator ( )
inlinevirtual

Definition at line 53 of file XalanLocator.hpp.

Member Function Documentation

◆ getColumnNumber() [1/2]

virtual XalanFileLoc xalanc::XalanLocator::getColumnNumber ( ) const
pure virtual

◆ getColumnNumber() [2/2]

static XalanFileLoc xalanc::XalanLocator::getColumnNumber ( const ParentType theLocator)
inlinestatic

Get the column number from a locator object.

Definition at line 110 of file XalanLocator.hpp.

◆ getLineNumber() [1/2]

virtual XalanFileLoc xalanc::XalanLocator::getLineNumber ( ) const
pure virtual

◆ getLineNumber() [2/2]

static XalanFileLoc xalanc::XalanLocator::getLineNumber ( const ParentType theLocator)
inlinestatic

Get the line number from a locator object.

Definition at line 101 of file XalanLocator.hpp.

◆ getPublicId() [1/2]

virtual const XMLCh* xalanc::XalanLocator::getPublicId ( ) const
pure virtual

◆ getPublicId() [2/2]

static const XalanDOMChar* xalanc::XalanLocator::getPublicId ( const Locator *  theLocator,
const XalanDOMChar *  theAlternateId = getEmptyPtr() 
)
inlinestatic

Get the public identifier from a locator object.

Parameters
theLocatorA locator object inherited from Xerces.
theAlternateIdA default name for a public identifier.
Returns
a null terminated XalanDOMChar string.

Definition at line 74 of file XalanLocator.hpp.

◆ getSystemId() [1/2]

virtual const XMLCh* xalanc::XalanLocator::getSystemId ( ) const
pure virtual

◆ getSystemId() [2/2]

static const XalanDOMChar* xalanc::XalanLocator::getSystemId ( const Locator *  theLocator,
const XalanDOMChar *  theAlternateId = getEmptyPtr() 
)
inlinestatic

Get the system identifier from a locator object.

Parameters
theLocatorA locator object inherited from Xerces.
theAlternateIdA default name for a public identifier.
Returns
a null terminated XalanDOMChar string.

Definition at line 89 of file XalanLocator.hpp.

◆ getUnknownDisplayValue()

static XalanFileLoc xalanc::XalanLocator::getUnknownDisplayValue ( )
inlinestatic

Definition at line 124 of file XalanLocator.hpp.

◆ getUnknownValue()

static XalanFileLoc xalanc::XalanLocator::getUnknownValue ( )
inlinestatic

Definition at line 116 of file XalanLocator.hpp.

◆ isUnknownValue()

static bool xalanc::XalanLocator::isUnknownValue ( XalanFileLoc  theLocation)
inlinestatic

Definition at line 133 of file XalanLocator.hpp.


The documentation for this class was generated from the following file: