Xalan-C++ API Reference  1.12.0
Public Member Functions | List of all members
xalanc::NodeSortKey Class Reference

Simple data structure class for use by the NodeSorter class. More...

#include <xalanc/XSLT/NodeSortKey.hpp>

Public Member Functions

 NodeSortKey (ExecutionContext &executionContext, const XPath *selectPat, bool treatAsNumbers, bool descending, XalanCollationServices::eCaseOrder caseOrder, const XalanDOMString &langValue, const PrefixResolver &resolver)
 Construct a node sort key. More...
 
 NodeSortKey ()
 
 NodeSortKey (const NodeSortKey &theSource)
 
 ~NodeSortKey ()
 
NodeSortKeyoperator= (const NodeSortKey &theRHS)
 
const XPathgetSelectPattern () const
 Retrieve the selection XPath. More...
 
bool getTreatAsNumbers () const
 Whether to treat values as numbers. More...
 
bool getDescending () const
 Whether to sort in descending order. More...
 
XalanCollationServices::eCaseOrder getCaseOrder () const
 Get the enumeration value for the case order. More...
 
const PrefixResolvergetPrefixResolver () const
 Retrieve the resolver for namespaces. More...
 
const XalanDOMStringgetLanguageString () const
 

Detailed Description

Simple data structure class for use by the NodeSorter class.

Definition at line 49 of file NodeSortKey.hpp.

Constructor & Destructor Documentation

◆ NodeSortKey() [1/3]

xalanc::NodeSortKey::NodeSortKey ( ExecutionContext executionContext,
const XPath selectPat,
bool  treatAsNumbers,
bool  descending,
XalanCollationServices::eCaseOrder  caseOrder,
const XalanDOMString langValue,
const PrefixResolver resolver 
)

Construct a node sort key.

Parameters
executionContextcurrent execution context
selectPatXPath for selection
treatAsNumberstreat as numeric values if true
descendingsort in descending order if true
caseOrdercase sort order enum
langValuelanguage
resolverresolver for namespace resolution

◆ NodeSortKey() [2/3]

xalanc::NodeSortKey::NodeSortKey ( )

◆ NodeSortKey() [3/3]

xalanc::NodeSortKey::NodeSortKey ( const NodeSortKey theSource)

◆ ~NodeSortKey()

xalanc::NodeSortKey::~NodeSortKey ( )

Member Function Documentation

◆ getCaseOrder()

XalanCollationServices::eCaseOrder xalanc::NodeSortKey::getCaseOrder ( ) const
inline

Get the enumeration value for the case order.

Returns
sort upper case before lower case if true

Definition at line 121 of file NodeSortKey.hpp.

◆ getDescending()

bool xalanc::NodeSortKey::getDescending ( ) const
inline

Whether to sort in descending order.

Returns
sort in descending order if true

Definition at line 110 of file NodeSortKey.hpp.

◆ getLanguageString()

const XalanDOMString& xalanc::NodeSortKey::getLanguageString ( ) const
inline

Definition at line 138 of file NodeSortKey.hpp.

◆ getPrefixResolver()

const PrefixResolver* xalanc::NodeSortKey::getPrefixResolver ( ) const
inline

Retrieve the resolver for namespaces.

Returns
object for namespace resolution

Definition at line 132 of file NodeSortKey.hpp.

◆ getSelectPattern()

const XPath* xalanc::NodeSortKey::getSelectPattern ( ) const
inline

Retrieve the selection XPath.

Returns
XPath for selection

Definition at line 88 of file NodeSortKey.hpp.

◆ getTreatAsNumbers()

bool xalanc::NodeSortKey::getTreatAsNumbers ( ) const
inline

Whether to treat values as numbers.

Returns
treat as numeric values if true

Definition at line 99 of file NodeSortKey.hpp.

◆ operator=()

NodeSortKey& xalanc::NodeSortKey::operator= ( const NodeSortKey theRHS)

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