blob: dec40cf9160527cb570a036a020c80b89120af6b [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XalanMatchPatternData Class Reference</h1>This class contains information concerning a match pattern in a stylesheet.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XalanMatchPatternData_8hpp-source.html">XalanMatchPatternData.hpp</a>&gt;</code>
<p>
Collaboration diagram for XalanMatchPatternData:<p><center><img src="classXalanMatchPatternData__coll__graph.gif" border="0" usemap="#XalanMatchPatternData_coll_map" alt="Collaboration graph"></center>
<map name="XalanMatchPatternData_coll_map">
<area href="classXalanDOMString.html" shape="rect" coords="308,42,425,18">
<area href="classXPath.html" shape="rect" coords="271,133,324,109">
<area href="classElemTemplateElement.html" shape="rect" coords="529,344,678,320">
<area href="classXalanQName.html" shape="rect" coords="437,133,533,109">
<area href="classElemTemplate.html" shape="rect" coords="416,237,517,213">
<area href="classXPathFunctionTable.html" shape="rect" coords="7,42,140,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXalanMatchPatternData-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XPath::eMatchScore <a class="el" href="classXalanMatchPatternData.html#s0">eMatchScore</a>
<li>typedef size_t <a class="el" href="classXalanMatchPatternData.html#s1">size_type</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXalanMatchPatternData.html#a0">XalanMatchPatternData</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, const <a class="el" href="classElemTemplate.html">ElemTemplate</a> &amp;theTemplate, <a class="el" href="classXalanMatchPatternData.html#s1">size_type</a> thePosition, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theTargetString, const <a class="el" href="classXPath.html">XPath</a> &amp;theMatchPattern, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;thePatternString, <a class="el" href="classXalanMatchPatternData.html#s0">eMatchScore</a> thePriority)
<dl class="el"><dd><font size=-1><em>Construct a XalanMatchPatternData from a pattern and template.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXalanMatchPatternData.html#a1">~XalanMatchPatternData</a> ()
<li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXalanMatchPatternData.html#a2">getTargetString</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve string for target.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXPath.html">XPath</a>* <a class="el" href="classXalanMatchPatternData.html#a3">getExpression</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve the match pattern associated with pattern.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXalanMatchPatternData.html#s1">size_type</a> <a class="el" href="classXalanMatchPatternData.html#a4">getPosition</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve position of pattern in stylesheet.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>* <a class="el" href="classXalanMatchPatternData.html#a5">getPattern</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve pattern string.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classElemTemplate.html">ElemTemplate</a>* <a class="el" href="classXalanMatchPatternData.html#a6">getTemplate</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve node that contains the template for this pattern.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXalanMatchPatternData.html#s0">eMatchScore</a> <a class="el" href="classXalanMatchPatternData.html#a7">getDefaultPriority</a> () const
<li>double <a class="el" href="classXalanMatchPatternData.html#a8">getPriorityOrDefault</a> () const
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class contains information concerning a match pattern in a stylesheet.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XalanMatchPatternData::eMatchScore"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XPath::eMatchScore XalanMatchPatternData::eMatchScore
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="s1" doxytag="XalanMatchPatternData::size_type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef size_t XalanMatchPatternData::size_type
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XalanMatchPatternData::XalanMatchPatternData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanMatchPatternData::XalanMatchPatternData (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classElemTemplate.html">ElemTemplate</a> &amp; <em>theTemplate</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanMatchPatternData.html#s1">size_type</a> <em>thePosition</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theTargetString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXPath.html">XPath</a> &amp; <em>theMatchPattern</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>thePatternString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanMatchPatternData.html#s0">eMatchScore</a> <em>thePriority</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a XalanMatchPatternData from a pattern and template.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theTemplate</em>
&nbsp;</td><td>
The <a class="el" href="classElemTemplate.html">ElemTemplate</a> node that contains the template for this pattern </td></tr>
<tr><td valign=top><em>thePosition</em>
&nbsp;</td><td>
The position in the stylesheet </td></tr>
<tr><td valign=top><em>theTargetString</em>
&nbsp;</td><td>
The target string for match pattern </td></tr>
<tr><td valign=top><em>TheMatchPattern</em>
&nbsp;</td><td>
The match pattern </td></tr>
<tr><td valign=top><em>thePatternString</em>
&nbsp;</td><td>
the pattern string </td></tr>
<tr><td valign=top><em>thePriority</em>
&nbsp;</td><td>
The priority for the match pattern. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="XalanMatchPatternData::~XalanMatchPatternData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanMatchPatternData::~XalanMatchPatternData (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a7" doxytag="XalanMatchPatternData::getDefaultPriority"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanMatchPatternData.html#s0">eMatchScore</a> XalanMatchPatternData::getDefaultPriority (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="XalanMatchPatternData::getExpression"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXPath.html">XPath</a> * XalanMatchPatternData::getExpression (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve the match pattern associated with pattern.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
<a class="el" href="classXPath.html">XPath</a> for pattern </dl> </td>
</tr>
</table>
<a name="a5" doxytag="XalanMatchPatternData::getPattern"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> * XalanMatchPatternData::getPattern (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve pattern string.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
string that contains element pattern </dl> </td>
</tr>
</table>
<a name="a4" doxytag="XalanMatchPatternData::getPosition"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanMatchPatternData.html#s1">size_type</a> XalanMatchPatternData::getPosition (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve position of pattern in stylesheet.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
The position in the stylesheet </dl> </td>
</tr>
</table>
<a name="a8" doxytag="XalanMatchPatternData::getPriorityOrDefault"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
double XalanMatchPatternData::getPriorityOrDefault (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="XalanMatchPatternData::getTargetString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; XalanMatchPatternData::getTargetString (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve string for target.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
target string </dl> </td>
</tr>
</table>
<a name="a6" doxytag="XalanMatchPatternData::getTemplate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classElemTemplate.html">ElemTemplate</a> * XalanMatchPatternData::getTemplate (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve node that contains the template for this pattern.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
template node </dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanMatchPatternData_8hpp-source.html">XalanMatchPatternData.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>