Google Git
Sign in
apache / axis-site / 2b448aaf8af6d8627cda9329c82917139bc73b4a / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / dataretrieval / SchemaDataLocator.html
blob: 7f85dddd0a12916ab26558dad62d42eb0b1f6de6 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SchemaDataLocator (Apache Axis2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SchemaDataLocator (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SchemaDataLocator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.axis2.dataretrieval</a></div>
<h2 title="Class SchemaDataLocator" class="title">Class SchemaDataLocator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">org.apache.axis2.dataretrieval.BaseAxisDataLocator</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.dataretrieval.SchemaDataLocator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="AxisDataLocator.html" title="interface in org.apache.axis2.dataretrieval">AxisDataLocator</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SchemaDataLocator</span>
extends <a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">BaseAxisDataLocator</a>
implements <a href="AxisDataLocator.html" title="interface in org.apache.axis2.dataretrieval">AxisDataLocator</a></pre>
<div class="block">Axis 2 Data Locator responsibles for retrieving Schema metadata. The class is
created as model for schema specific data locator; and also easier for any
future implementation schema specific data retrieval logic.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.axis2.dataretrieval.BaseAxisDataLocator">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.axis2.dataretrieval.<a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">BaseAxisDataLocator</a></h3>
<code><a href="BaseAxisDataLocator.html#dataList">dataList</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SchemaDataLocator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axis2.dataretrieval.ServiceData%5B%5D)">SchemaDataLocator</a></span>&#8203;(<a href="ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Constructor</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getData(org.apache.axis2.dataretrieval.DataRetrievalRequest,org.apache.axis2.context.MessageContext)">getData</a></span>&#8203;(<a href="DataRetrievalRequest.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalRequest</a>&nbsp;request,
<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code></th>
<td class="colLast">
<div class="block">The default Axis2 Data locator getData API
Checks data information configured in ServiceData.xml for the supported
output forms: inline, url, EndpointReference.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outputInlineForm(org.apache.axis2.context.MessageContext,org.apache.axis2.dataretrieval.ServiceData%5B%5D)">outputInlineForm</a></span>&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext,
<a href="ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outputLocationForm(org.apache.axis2.dataretrieval.ServiceData%5B%5D)">outputLocationForm</a></span>&#8203;(<a href="ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.axis2.dataretrieval.BaseAxisDataLocator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.dataretrieval.<a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">BaseAxisDataLocator</a></h3>
<code><a href="BaseAxisDataLocator.html#getOutputForm()">getOutputForm</a>, <a href="BaseAxisDataLocator.html#outputReferenceForm(org.apache.axis2.context.MessageContext,org.apache.axis2.dataretrieval.ServiceData%5B%5D)">outputReferenceForm</a>, <a href="BaseAxisDataLocator.html#setServiceData(org.apache.axis2.dataretrieval.ServiceData%5B%5D)">setServiceData</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SchemaDataLocator</h4>
<pre>protected&nbsp;SchemaDataLocator()</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SchemaDataLocator</h4>
<pre>protected&nbsp;SchemaDataLocator&#8203;(<a href="ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;data)</pre>
<div class="block">Constructor</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getData(org.apache.axis2.dataretrieval.DataRetrievalRequest,org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getData</h4>
<pre class="methodSignature">public&nbsp;<a href="Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;getData&#8203;(<a href="DataRetrievalRequest.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalRequest</a>&nbsp;request,
<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="BaseAxisDataLocator.html#getData(org.apache.axis2.dataretrieval.DataRetrievalRequest,org.apache.axis2.context.MessageContext)">BaseAxisDataLocator</a></code></span></div>
<div class="block">The default Axis2 Data locator getData API
Checks data information configured in ServiceData.xml for the supported
output forms: inline, url, EndpointReference.
<p/>
Note: Subclass that has its implementation of outInlineForm, outputLocationForm,
and outputReferenceForm logic must implement the getData API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AxisDataLocator.html#getData(org.apache.axis2.dataretrieval.DataRetrievalRequest,org.apache.axis2.context.MessageContext)">getData</a></code>&nbsp;in interface&nbsp;<code><a href="AxisDataLocator.html" title="interface in org.apache.axis2.dataretrieval">AxisDataLocator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="BaseAxisDataLocator.html#getData(org.apache.axis2.dataretrieval.DataRetrievalRequest,org.apache.axis2.context.MessageContext)">getData</a></code>&nbsp;in class&nbsp;<code><a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">BaseAxisDataLocator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - The <a href="DataRetrievalRequest.html" title="class in org.apache.axis2.dataretrieval"><code>DataRetrievalRequest</code></a> allow to specify parameters
about the request, and additional information to process the
request.</dd>
<dd><code>msgContext</code> - The <a href="../context/MessageContext.html" title="class in org.apache.axis2.context"><code>MessageContext</code></a> from the original request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="Data.html" title="class in org.apache.axis2.dataretrieval"><code>Data</code></a>[] for the request.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd>
</dl>
</li>
</ul>
<a id="outputInlineForm(org.apache.axis2.context.MessageContext,org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputInlineForm</h4>
<pre class="methodSignature">protected&nbsp;<a href="Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;outputInlineForm&#8203;(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext,
<a href="ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)
throws <a href="DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="BaseAxisDataLocator.html#outputInlineForm(org.apache.axis2.context.MessageContext,org.apache.axis2.dataretrieval.ServiceData%5B%5D)">outputInlineForm</a></code>&nbsp;in class&nbsp;<code><a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">BaseAxisDataLocator</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd>
</dl>
</li>
</ul>
<a id="outputLocationForm(org.apache.axis2.dataretrieval.ServiceData[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>outputLocationForm</h4>
<pre class="methodSignature">protected&nbsp;<a href="Data.html" title="class in org.apache.axis2.dataretrieval">Data</a>[]&nbsp;outputLocationForm&#8203;(<a href="ServiceData.html" title="class in org.apache.axis2.dataretrieval">ServiceData</a>[]&nbsp;serviceData)
throws <a href="DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="BaseAxisDataLocator.html#outputLocationForm(org.apache.axis2.dataretrieval.ServiceData%5B%5D)">outputLocationForm</a></code>&nbsp;in class&nbsp;<code><a href="BaseAxisDataLocator.html" title="class in org.apache.axis2.dataretrieval">BaseAxisDataLocator</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DataRetrievalException.html" title="class in org.apache.axis2.dataretrieval">DataRetrievalException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SchemaDataLocator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>