| <!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>PuzzleComponent (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="PuzzleComponent (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/PuzzleComponent.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/NamespaceDictionary.html" title="class in schema2template.model"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../schema2template/model/PuzzlePiece.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/PuzzleComponent.html" target="_top">Frames</a></li> |
| <li><a href="PuzzleComponent.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 PuzzleComponent" class="title">Interface PuzzleComponent</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../schema2template/model/QNamedPuzzleComponent.html" title="interface in schema2template.model">QNamedPuzzleComponent</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">PuzzleComponent</span></pre> |
| <div class="block"><p>The first purpose of this interface is to provide a kind of "piece of a puzzle" |
| representing the key definitions of a schema and their relationship:</p> |
| <ul> |
| <li>Element PuzzlePiece</li> |
| <li>Attribute PuzzlePiece</li> |
| <li>Attribute Value PuzzlePiece</li> |
| <li>Attribute Datatype PuzzlePiece</li> |
| </ul> |
| <p>The second purpose of this interface is to hide the differences between one |
| definition and a Collection of definitions. By this you will be able |
| to use single definitions and collections of definitions as method |
| parameters. The method getCollection() is a helper method for this.</p></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"> </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/PuzzleComponent.html#canHaveText()">canHaveText</a></strong>()</code> |
| <div class="block">Determines whether this PuzzleComponent allows a text node as child.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getAttributes()">getAttributes</a></strong>()</code> |
| <div class="block">ELEMENT PuzzlePiece only: Get all attribute Definitions</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getChildElements()">getChildElements</a></strong>()</code> |
| <div class="block">ELEMENT PuzzlePiece only: Get all child element Definitions</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../schema2template/model/PuzzlePiece.html" title="class in schema2template.model">PuzzlePiece</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getCollection()">getCollection</a></strong>()</code> |
| <div class="block">Method to treat NamedDefined as a Collection of PuzzlePiece</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getDatatypes()">getDatatypes</a></strong>()</code> |
| <div class="block">ATTRIBUTE PuzzlePiece only: Get all datatype Definitions</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getParents()">getParents</a></strong>()</code> |
| <div class="block">Get all parent Definitions</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../schema2template/model/MSVExpressionType.html" title="enum in schema2template.model">MSVExpressionType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getType()">getType</a></strong>()</code> |
| <div class="block">Get type of PuzzlePiece [ELEMENT, ATTRIBUTE, VALUE, DATA]</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#getValues()">getValues</a></strong>()</code> |
| <div class="block">ATTRIBUTE PuzzlePiece only: Get all value Definitions</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../schema2template/model/PuzzleComponent.html#isSingleton(schema2template.model.PuzzleComponent)">isSingleton</a></strong>(<a href="../../schema2template/model/PuzzleComponent.html" title="interface in schema2template.model">PuzzleComponent</a> child)</code> |
| <div class="block">Determines whether the child PuzzlePiece(s) is/are singleton(s) |
| |
| Convention: If child is a collection this method returns false if one child element is no singleton.</div> |
| </td> |
| </tr> |
| </table> |
| </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="getChildElements()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildElements</h4> |
| <pre><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a> getChildElements()</pre> |
| <div class="block">ELEMENT PuzzlePiece only: Get all child element Definitions</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The child Definitions of this PuzzleComponent</dd></dl> |
| </li> |
| </ul> |
| <a name="getAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributes</h4> |
| <pre><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a> getAttributes()</pre> |
| <div class="block">ELEMENT PuzzlePiece only: Get all attribute Definitions</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The attribute Definitions of this PuzzleComponent</dd></dl> |
| </li> |
| </ul> |
| <a name="getDatatypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatatypes</h4> |
| <pre><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a> getDatatypes()</pre> |
| <div class="block">ATTRIBUTE PuzzlePiece only: Get all datatype Definitions</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The datatype Definitions of this PuzzleComponent</dd></dl> |
| </li> |
| </ul> |
| <a name="getValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValues</h4> |
| <pre><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a> getValues()</pre> |
| <div class="block">ATTRIBUTE PuzzlePiece only: Get all value Definitions</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The constant value Definitions of this PuzzleComponent</dd></dl> |
| </li> |
| </ul> |
| <a name="getParents()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParents</h4> |
| <pre><a href="../../schema2template/model/PuzzlePieceSet.html" title="class in schema2template.model">PuzzlePieceSet</a> getParents()</pre> |
| <div class="block">Get all parent Definitions</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The parent Definitions of this PuzzleComponent</dd></dl> |
| </li> |
| </ul> |
| <a name="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre><a href="../../schema2template/model/MSVExpressionType.html" title="enum in schema2template.model">MSVExpressionType</a> getType()</pre> |
| <div class="block">Get type of PuzzlePiece [ELEMENT, ATTRIBUTE, VALUE, DATA]</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The type of this PuzzleComponent</dd></dl> |
| </li> |
| </ul> |
| <a name="canHaveText()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHaveText</h4> |
| <pre>boolean canHaveText()</pre> |
| <div class="block">Determines whether this PuzzleComponent allows a text node as child.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>True if a text node is allowed, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="isSingleton(schema2template.model.PuzzleComponent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSingleton</h4> |
| <pre>boolean isSingleton(<a href="../../schema2template/model/PuzzleComponent.html" title="interface in schema2template.model">PuzzleComponent</a> child)</pre> |
| <div class="block">Determines whether the child PuzzlePiece(s) is/are singleton(s) |
| |
| Convention: If child is a collection this method returns false if one child element is no singleton. |
| If this is a collection this method returns false if child is no singleton for one element of this.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - PuzzleComponent child</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>True if child is defined as Singleton, falso otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="getCollection()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCollection</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../schema2template/model/PuzzlePiece.html" title="class in schema2template.model">PuzzlePiece</a>> getCollection()</pre> |
| <div class="block">Method to treat NamedDefined as a Collection of PuzzlePiece</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Collection of PuzzlePiece objects</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/PuzzleComponent.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/NamespaceDictionary.html" title="class in schema2template.model"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../schema2template/model/PuzzlePiece.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/PuzzleComponent.html" target="_top">Frames</a></li> |
| <li><a href="PuzzleComponent.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
