<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>wsdlpull: /builddir/build/BUILD/wsdlpull-1.23/src/wsdlparser/WsdlExtension.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_02f058d422e7266632662d1436e7c90d.html">src</a> » <a class="el" href="dir_cc7944105668626785e4a1a985510ef5.html">wsdlparser</a>
</div>
</div>
<div class="contents">
<h1>WsdlExtension.h</h1><a href="WsdlExtension_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* </span>
<a name="l00002"></a>00002 <span class="comment"> * wsdlpull - A C++ parser for WSDL (Web services description language)</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2005-2007 Vivek Krishna</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> * modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> * Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment"> * License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment"> * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _WSDLEXTENSIONH</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _WSDLEXTENSIONH</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="XmlPullParser_8h.html">xmlpull/XmlPullParser.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="SchemaParser_8h.html">schemaparser/SchemaParser.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="wsdlpull__export_8h.html">xmlpull/wsdlpull_export.h</a>"</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">using namespace </span>Schema;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#if (defined _WIN32) && !(defined SCHEMADIR)</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define SCHEMADIR "src/schemas/"</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>WsdlPull {
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">class </span>WsdlParser;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">//This class is the generic interface that all extensibility namespaces must derive from</span>
<a name="l00041"></a><a class="code" href="classWsdlPull_1_1WsdlExtension.html">00041</a> <span class="keyword">class </span><a class="code" href="wsdlpull__export_8h.html#ad360158cff99879c80a7072c29529f50">WSDLPULL_EXPORT</a> <a class="code" href="classWsdlPull_1_1WsdlExtension.html">WsdlExtension</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keyword">public</span>:
<a name="l00044"></a><a class="code" href="classWsdlPull_1_1WsdlExtension.html#a4e28356123ec6b8ae710abd605dce53d">00044</a> <a class="code" href="classWsdlPull_1_1WsdlExtension.html#a4e28356123ec6b8ae710abd605dce53d">WsdlExtension</a>(){};
<a name="l00045"></a><a class="code" href="classWsdlPull_1_1WsdlExtension.html#acb7685f0f749701a4e4cea71468dc1c8">00045</a> <span class="keyword">virtual</span> <a class="code" href="classWsdlPull_1_1WsdlExtension.html#acb7685f0f749701a4e4cea71468dc1c8">~WsdlExtension</a>(){};
<a name="l00046"></a>00046 <span class="keyword">virtual</span> std::string getNamespace()<span class="keyword">const</span> = 0;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">//returns the namespace Uri of the wsdl extensibility elements that it can handle.</span>
<a name="l00049"></a>00049 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setNamespacePrefix(std::string) = 0;
<a name="l00050"></a>00050 <span class="keyword">virtual</span> std::string getNamespacePrefix()<span class="keyword">const</span> = 0;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">//does this extensibility handler handle the given namespace</span>
<a name="l00053"></a>00053 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isNamespaceHandler(<span class="keyword">const</span> std::string &)<span class="keyword">const</span> = 0;
<a name="l00054"></a>00054 <span class="keyword">virtual</span> std::string getExtensibilitySchema()<span class="keyword">const</span> = 0;
<a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSchemaParser(<a class="code" href="classSchema_1_1SchemaParser.html">SchemaParser</a> * spe) = 0;
<a name="l00056"></a><a class="code" href="classWsdlPull_1_1WsdlExtension.html#a0987a842222104f0904a9be8a68a0df3">00056</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWsdlPull_1_1WsdlExtension.html#a0987a842222104f0904a9be8a68a0df3">setSchemaPath</a>(<span class="keyword">const</span> std::string & <span class="comment">/* schemaPath */</span>){};
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// parent is the Wsdl parent element type under which the extensibility element has come</span>
<a name="l00059"></a>00059 <span class="comment">// the id returned must be non zero if the extensibility handler has handled the element correctly</span>
<a name="l00060"></a>00060 <span class="keyword">virtual</span> <span class="keywordtype">int</span> handleElement(<span class="keywordtype">int</span> parent, <a class="code" href="classXmlPullParser.html">XmlPullParser</a> *) = 0;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">//attName is the extensibility attribute</span>
<a name="l00063"></a>00063 <span class="comment">// the id returned must be non zero if the extensibility handler has handled the attribute correctly</span>
<a name="l00064"></a>00064 <span class="keyword">virtual</span> <span class="keywordtype">int</span> handleAttribute(<span class="keywordtype">int</span> parent, std::string attName,
<a name="l00065"></a>00065 <a class="code" href="classXmlPullParser.html">XmlPullParser</a> *) = 0;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">//returns a valid extensibilty element</span>
<a name="l00068"></a>00068 <span class="comment">//must return a non zero integer if the element was present in the wsdl</span>
<a name="l00069"></a>00069 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getElementName(<span class="keywordtype">int</span> <span class="keywordtype">id</span>)<span class="keyword">const</span> = 0;
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">//returns a valid extensibility attribute</span>
<a name="l00072"></a>00072 <span class="comment">//must return a non zero integer if the attribute was present in the wsdl</span>
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getAttributeName(<span class="keywordtype">int</span> <span class="keywordtype">id</span>)<span class="keyword">const</span> = 0;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">//this is the start of all ids that must be used for elems/attributes in this namespace</span>
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStartId(<span class="keywordtype">int</span>) = 0;
<a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getStartId() <span class="keyword">const</span>= 0;
<a name="l00078"></a><a class="code" href="classWsdlPull_1_1WsdlExtension.html#a2467a42866918f290ae5f0e134e58a21">00078</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWsdlPull_1_1WsdlExtension.html#a2467a42866918f290ae5f0e134e58a21">setWsdlParser</a>(<a class="code" href="classWsdlPull_1_1WsdlParser.html">WsdlParser</a> *){};
<a name="l00079"></a><a class="code" href="classWsdlPull_1_1WsdlExtension.html#ab311defaf057594e156dedbaa62451af">00079</a> <span class="keyword">virtual</span> <a class="code" href="classWsdlPull_1_1WsdlParser.html">WsdlParser</a> * <a class="code" href="classWsdlPull_1_1WsdlExtension.html#ab311defaf057594e156dedbaa62451af">wsdlParser</a>()<span class="keyword">const </span>{ <span class="keywordflow">return</span> 0;} ;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="comment">//this method returns true if the Wsdl file had extensibility elements parsed by this extensibility handler</span>
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> wasUsed()<span class="keyword">const</span> = 0;
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084 }
<a name="l00085"></a>00085 <span class="preprocessor">#endif </span><span class="comment">/* */</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
