blob: 4de6ff5f3003d6db9e57e0418607fb98407b1acb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:18:07 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>QNamedPuzzleComponent (Schema2template v0.8.9-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QNamedPuzzleComponent (Schema2template v0.8.9-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/QNamedPuzzleComponent.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-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../schema2template/model/QNamed.html" title="interface in schema2template.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../schema2template/model/QNameValue.html" title="class in schema2template.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?schema2template/model/QNamedPuzzleComponent.html" target="_top">Frames</a></li>
<li><a href="QNamedPuzzleComponent.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">schema2template.model</div>
<h2 title="Interface QNamedPuzzleComponent" class="title">Interface QNamedPuzzleComponent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../schema2template/model/PuzzleComponent.html" title="interface in schema2template.model">PuzzleComponent</a>, <a href="../../schema2template/model/QNamed.html" title="interface in schema2template.model">QNamed</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../schema2template/model/PuzzlePiece.html" title="class in schema2template.model">PuzzlePiece</a>, <a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">QNamedPuzzleComponent</span>
extends <a href="../../schema2template/model/QNamed.html" title="interface in schema2template.model">QNamed</a>, <a href="../../schema2template/model/PuzzleComponent.html" title="interface in schema2template.model">PuzzleComponent</a></pre>
<div class="block">By using this interface you declare that:
<ul>
<li>you don't care if a QNamedPuzzleComponent is a Collection of Jigsaw pieces
or one single Jigsaw piece.</li>
<li>you expect one single name. If the QNamedPuzzleComponent is a Collection of definitions,
all definitions have to be equally named. Calling getQName(), toString(), getLocalName() or
getNamespace() on a Collection of differently named definitions will throw a
RuntimeException.
For example:
A multiple definition of an attribute is frequently used in an XML schema.
</li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../schema2template/model/QNamedPuzzleComponent.html#isMandatory(schema2template.model.QNamedPuzzleComponent)">isMandatory</a></strong>(<a href="../../schema2template/model/QNamedPuzzleComponent.html" title="interface in schema2template.model">QNamedPuzzleComponent</a>&nbsp;child)</code>
<div class="block">ELEMENT Definition only: Determine solely by child type and name
whether child is mandatory.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_schema2template.model.QNamed">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;schema2template.model.<a href="../../schema2template/model/QNamed.html" title="interface in schema2template.model">QNamed</a></h3>
<code><a href="../../schema2template/model/QNamed.html#getLocalName()">getLocalName</a>, <a href="../../schema2template/model/QNamed.html#getNamespace()">getNamespace</a>, <a href="../../schema2template/model/QNamed.html#getQName()">getQName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_schema2template.model.PuzzleComponent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;schema2template.model.<a href="../../schema2template/model/PuzzleComponent.html" title="interface in schema2template.model">PuzzleComponent</a></h3>
<code><a href="../../schema2template/model/PuzzleComponent.html#canHaveText()">canHaveText</a>, <a href="../../schema2template/model/PuzzleComponent.html#getAttributes()">getAttributes</a>, <a href="../../schema2template/model/PuzzleComponent.html#getChildElements()">getChildElements</a>, <a href="../../schema2template/model/PuzzleComponent.html#getCollection()">getCollection</a>, <a href="../../schema2template/model/PuzzleComponent.html#getDatatypes()">getDatatypes</a>, <a href="../../schema2template/model/PuzzleComponent.html#getParents()">getParents</a>, <a href="../../schema2template/model/PuzzleComponent.html#getType()">getType</a>, <a href="../../schema2template/model/PuzzleComponent.html#getValues()">getValues</a>, <a href="../../schema2template/model/PuzzleComponent.html#isSingleton(schema2template.model.PuzzleComponent)">isSingleton</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isMandatory(schema2template.model.QNamedPuzzleComponent)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isMandatory</h4>
<pre>boolean&nbsp;isMandatory(<a href="../../schema2template/model/QNamedPuzzleComponent.html" title="interface in schema2template.model">QNamedPuzzleComponent</a>&nbsp;child)</pre>
<div class="block">ELEMENT Definition only: Determine solely by child type and name
whether child is mandatory.
<p>Here's why we're not using the child Definition object(s) for this:
An element often has a mandatory attribute, but two (or more) different content definitions
for this attribute. This is done by defining this attribute twice and creating a
CHOICE between both Definitions. If you'd ask whether one of these definitions is mandatory,
you'd always get false as answer as you have the choice between the two definitions.
Mostly this is not the answer you're looking for.</p>
<p>Contract: If 'this' is a Collection, mandatory means mandatory for one member of 'this'.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - The child Definition(s) of type ELEMENT or ATTRIBUTE</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if child is a defined child of this and if it's mandatory. False otherwise.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/QNamedPuzzleComponent.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-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../schema2template/model/QNamed.html" title="interface in schema2template.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../schema2template/model/QNameValue.html" title="class in schema2template.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?schema2template/model/QNamedPuzzleComponent.html" target="_top">Frames</a></li>
<li><a href="QNamedPuzzleComponent.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All 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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>