source: javadoc/genius/core/issue/Issue.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0
File size: 20.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:56 CEST 2018 -->
6<title>Issue (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Issue (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":6,"i2":6,"i3":6,"i4":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/Issue.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li>Prev&nbsp;Class</li>
53<li><a href="../../../genius/core/issue/IssueDiscrete.html" title="class in genius.core.issue"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/issue/Issue.html" target="_top">Frames</a></li>
57<li><a href="Issue.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.issue</div>
96<h2 title="Class Issue" class="title">Class Issue</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li><a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">genius.core.issue.Objective</a></li>
104<li>
105<ul class="inheritance">
106<li>genius.core.issue.Issue</li>
107</ul>
108</li>
109</ul>
110</li>
111</ul>
112<div class="description">
113<ul class="blockList">
114<li class="blockList">
115<dl>
116<dt>All Implemented Interfaces:</dt>
117<dd>java.io.Serializable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode</dd>
118</dl>
119<dl>
120<dt>Direct Known Subclasses:</dt>
121<dd><a href="../../../genius/core/issue/IssueDiscrete.html" title="class in genius.core.issue">IssueDiscrete</a>, <a href="../../../genius/core/issue/IssueInteger.html" title="class in genius.core.issue">IssueInteger</a>, <a href="../../../genius/core/issue/IssueReal.html" title="class in genius.core.issue">IssueReal</a></dd>
122</dl>
123<hr>
124<br>
125<pre>public abstract class <span class="typeNameLabel">Issue</span>
126extends <a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a></pre>
127<div class="block">Class <a href="../../../genius/core/issue/Issue.html" title="class in genius.core.issue"><code>Issue</code></a> represents a negotiation issue to be settled in a negotiation.
128 Issues in a domain are identified by unique <code>index</code> field.</div>
129<dl>
130<dt><span class="simpleTagLabel">Author:</span></dt>
131<dd>Tim Baarslag & Dmytro Tykhonov</dd>
132<dt><span class="seeLabel">See Also:</span></dt>
133<dd><a href="../../../serialized-form.html#genius.core.issue.Issue">Serialized Form</a></dd>
134</dl>
135</li>
136</ul>
137</div>
138<div class="summary">
139<ul class="blockList">
140<li class="blockList">
141<!-- ======== CONSTRUCTOR SUMMARY ======== -->
142<ul class="blockList">
143<li class="blockList"><a name="constructor.summary">
144<!-- -->
145</a>
146<h3>Constructor Summary</h3>
147<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
148<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
149<tr>
150<th class="colOne" scope="col">Constructor and Description</th>
151</tr>
152<tr class="altColor">
153<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#Issue-java.lang.String-int-">Issue</a></span>(java.lang.String&nbsp;name,
154 int&nbsp;issueNumber)</code>
155<div class="block">Creates a new issue give its name and number.</div>
156</td>
157</tr>
158<tr class="rowColor">
159<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#Issue-java.lang.String-int-genius.core.issue.Objective-">Issue</a></span>(java.lang.String&nbsp;name,
160 int&nbsp;issueNumber,
161 <a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;parent)</code>
162<div class="block">Creates a new issue give its name, number, and parent.</div>
163</td>
164</tr>
165</table>
166</li>
167</ul>
168<!-- ========== METHOD SUMMARY =========== -->
169<ul class="blockList">
170<li class="blockList"><a name="method.summary">
171<!-- -->
172</a>
173<h3>Method Summary</h3>
174<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
175<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
176<tr>
177<th class="colFirst" scope="col">Modifier and Type</th>
178<th class="colLast" scope="col">Method and Description</th>
179</tr>
180<tr id="i0" class="altColor">
181<td class="colFirst"><code>void</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#addChild-genius.core.issue.Objective-">addChild</a></span>(<a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;newObjective)</code>
183<div class="block">Overrides addChild from Objective to do nothing, since Issues can't have children.</div>
184</td>
185</tr>
186<tr id="i1" class="rowColor">
187<td class="colFirst"><code>abstract boolean</code></td>
188<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#checkInRange-genius.core.issue.Value-">checkInRange</a></span>(<a href="../../../genius/core/issue/Value.html" title="class in genius.core.issue">Value</a>&nbsp;value)</code>
189<div class="block">Method to check if the given value is in the range specified
190 by the issue.</div>
191</td>
192</tr>
193<tr id="i2" class="altColor">
194<td class="colFirst"><code>abstract java.lang.String</code></td>
195<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#convertToString--">convertToString</a></span>()</code>&nbsp;</td>
196</tr>
197<tr id="i3" class="rowColor">
198<td class="colFirst"><code>abstract <a href="../../../genius/core/issue/ISSUETYPE.html" title="enum in genius.core.issue">ISSUETYPE</a></code></td>
199<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#getType--">getType</a></span>()</code>
200<div class="block">This method is added for convenience.</div>
201</td>
202</tr>
203<tr id="i4" class="altColor">
204<td class="colFirst"><code><a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a></code></td>
205<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/issue/Issue.html#toXML--">toXML</a></span>()</code>
206<div class="block">Returns a SimpleElement representation of this issue.</div>
207</td>
208</tr>
209</table>
210<ul class="blockList">
211<li class="blockList"><a name="methods.inherited.from.class.genius.core.issue.Objective">
212<!-- -->
213</a>
214<h3>Methods inherited from class&nbsp;genius.core.issue.<a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a></h3>
215<code><a href="../../../genius/core/issue/Objective.html#children--">children</a>, <a href="../../../genius/core/issue/Objective.html#equalContents-genius.core.issue.Objective-">equalContents</a>, <a href="../../../genius/core/issue/Objective.html#equals-java.lang.Object-">equals</a>, <a href="../../../genius/core/issue/Objective.html#getAllowsChildren--">getAllowsChildren</a>, <a href="../../../genius/core/issue/Objective.html#getChildAt-int-">getChildAt</a>, <a href="../../../genius/core/issue/Objective.html#getChildCount--">getChildCount</a>, <a href="../../../genius/core/issue/Objective.html#getChildren--">getChildren</a>, <a href="../../../genius/core/issue/Objective.html#getChildWithID-int-">getChildWithID</a>, <a href="../../../genius/core/issue/Objective.html#getDescription--">getDescription</a>, <a href="../../../genius/core/issue/Objective.html#getHighestObjectiveNr-int-">getHighestObjectiveNr</a>, <a href="../../../genius/core/issue/Objective.html#getIndex-javax.swing.tree.TreeNode-">getIndex</a>, <a href="../../../genius/core/issue/Objective.html#getName--">getName</a>, <a href="../../../genius/core/issue/Objective.html#getNumber--">getNumber</a>, <a href="../../../genius/core/issue/Objective.html#getObjective-int-">getObjective</a>, <a href="../../../genius/core/issue/Objective.html#getParent--">getParent</a>, <a href="../../../genius/core/issue/Objective.html#getPath--">getPath</a>, <a href="../../../genius/core/issue/Objective.html#getPreorderEnumeration--">getPreorderEnumeration</a>, <a href="../../../genius/core/issue/Objective.html#getPreorderIssueEnumeration--">getPreorderIssueEnumeration</a>, <a href="../../../genius/core/issue/Objective.html#getPreorderObjectiveEnumeration--">getPreorderObjectiveEnumeration</a>, <a href="../../../genius/core/issue/Objective.html#getSiblings--">getSiblings</a>, <a href="../../../genius/core/issue/Objective.html#getUserObject--">getUserObject</a>, <a href="../../../genius/core/issue/Objective.html#hashCode--">hashCode</a>, <a href="../../../genius/core/issue/Objective.html#insert-javax.swing.tree.MutableTreeNode-int-">insert</a>, <a href="../../../genius/core/issue/Objective.html#isIssue--">isIssue</a>, <a href="../../../genius/core/issue/Objective.html#isLeaf--">isLeaf</a>, <a href="../../../genius/core/issue/Objective.html#isObjective--">isObjective</a>, <a href="../../../genius/core/issue/Objective.html#isParent-genius.core.issue.Objective-">isParent</a>, <a href="../../../genius/core/issue/Objective.html#remove-int-">remove</a>, <a href="../../../genius/core/issue/Objective.html#remove-javax.swing.tree.MutableTreeNode-">remove</a>, <a href="../../../genius/core/issue/Objective.html#removeFromParent--">removeFromParent</a>, <a href="../../../genius/core/issue/Objective.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../../genius/core/issue/Objective.html#setName-java.lang.String-">setName</a>, <a href="../../../genius/core/issue/Objective.html#setNumber-int-">setNumber</a>, <a href="../../../genius/core/issue/Objective.html#setParent-javax.swing.tree.MutableTreeNode-">setParent</a>, <a href="../../../genius/core/issue/Objective.html#setUserObject-java.lang.Object-">setUserObject</a>, <a href="../../../genius/core/issue/Objective.html#toString--">toString</a></code></li>
216</ul>
217<ul class="blockList">
218<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
219<!-- -->
220</a>
221<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
222<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
223</ul>
224</li>
225</ul>
226</li>
227</ul>
228</div>
229<div class="details">
230<ul class="blockList">
231<li class="blockList">
232<!-- ========= CONSTRUCTOR DETAIL ======== -->
233<ul class="blockList">
234<li class="blockList"><a name="constructor.detail">
235<!-- -->
236</a>
237<h3>Constructor Detail</h3>
238<a name="Issue-java.lang.String-int-">
239<!-- -->
240</a>
241<ul class="blockList">
242<li class="blockList">
243<h4>Issue</h4>
244<pre>public&nbsp;Issue(java.lang.String&nbsp;name,
245 int&nbsp;issueNumber)</pre>
246<div class="block">Creates a new issue give its name and number.</div>
247<dl>
248<dt><span class="paramLabel">Parameters:</span></dt>
249<dd><code>name</code> - of the issue.</dd>
250<dd><code>issueNumber</code> - unique ID of the issue.</dd>
251</dl>
252</li>
253</ul>
254<a name="Issue-java.lang.String-int-genius.core.issue.Objective-">
255<!-- -->
256</a>
257<ul class="blockListLast">
258<li class="blockList">
259<h4>Issue</h4>
260<pre>public&nbsp;Issue(java.lang.String&nbsp;name,
261 int&nbsp;issueNumber,
262 <a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;parent)</pre>
263<div class="block">Creates a new issue give its name, number, and parent.</div>
264<dl>
265<dt><span class="paramLabel">Parameters:</span></dt>
266<dd><code>name</code> - of the issue.</dd>
267<dd><code>issueNumber</code> - uniqueID of the issue.</dd>
268<dd><code>parent</code> - objective of the issue.</dd>
269</dl>
270</li>
271</ul>
272</li>
273</ul>
274<!-- ============ METHOD DETAIL ========== -->
275<ul class="blockList">
276<li class="blockList"><a name="method.detail">
277<!-- -->
278</a>
279<h3>Method Detail</h3>
280<a name="getType--">
281<!-- -->
282</a>
283<ul class="blockList">
284<li class="blockList">
285<h4>getType</h4>
286<pre>public abstract&nbsp;<a href="../../../genius/core/issue/ISSUETYPE.html" title="enum in genius.core.issue">ISSUETYPE</a>&nbsp;getType()</pre>
287<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../genius/core/issue/Objective.html#getType--">Objective</a></code></span></div>
288<div class="block">This method is added for convenience. It is simply an alternative
289 implementation of the getType method from the Issue class. It will always
290 return that the type is Objective. This method must be overridden in
291 Issue to return the type of the Issue.</div>
292<dl>
293<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
294<dd><code><a href="../../../genius/core/issue/Objective.html#getType--">getType</a></code>&nbsp;in class&nbsp;<code><a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a></code></dd>
295<dt><span class="returnLabel">Returns:</span></dt>
296<dd>ISSUETYPE.OBJECTIVE</dd>
297</dl>
298</li>
299</ul>
300<a name="convertToString--">
301<!-- -->
302</a>
303<ul class="blockList">
304<li class="blockList">
305<h4>convertToString</h4>
306<pre>public abstract&nbsp;java.lang.String&nbsp;convertToString()</pre>
307<dl>
308<dt><span class="returnLabel">Returns:</span></dt>
309<dd>corresponding string representation</dd>
310</dl>
311</li>
312</ul>
313<a name="checkInRange-genius.core.issue.Value-">
314<!-- -->
315</a>
316<ul class="blockList">
317<li class="blockList">
318<h4>checkInRange</h4>
319<pre>public abstract&nbsp;boolean&nbsp;checkInRange(<a href="../../../genius/core/issue/Value.html" title="class in genius.core.issue">Value</a>&nbsp;value)</pre>
320<div class="block">Method to check if the given value is in the range specified
321 by the issue.</div>
322<dl>
323<dt><span class="paramLabel">Parameters:</span></dt>
324<dd><code>value</code> - to be checked.</dd>
325<dt><span class="returnLabel">Returns:</span></dt>
326<dd>true if in range.</dd>
327</dl>
328</li>
329</ul>
330<a name="addChild-genius.core.issue.Objective-">
331<!-- -->
332</a>
333<ul class="blockList">
334<li class="blockList">
335<h4>addChild</h4>
336<pre>public&nbsp;void&nbsp;addChild(<a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;newObjective)</pre>
337<div class="block">Overrides addChild from Objective to do nothing, since Issues can't have children. This
338 method simply returns without doing anything.</div>
339<dl>
340<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
341<dd><code><a href="../../../genius/core/issue/Objective.html#addChild-genius.core.issue.Objective-">addChild</a></code>&nbsp;in class&nbsp;<code><a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a></code></dd>
342<dt><span class="paramLabel">Parameters:</span></dt>
343<dd><code>newObjective</code> - gets negated.</dd>
344</dl>
345</li>
346</ul>
347<a name="toXML--">
348<!-- -->
349</a>
350<ul class="blockListLast">
351<li class="blockList">
352<h4>toXML</h4>
353<pre>public&nbsp;<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;toXML()</pre>
354<div class="block">Returns a SimpleElement representation of this issue.</div>
355<dl>
356<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
357<dd><code><a href="../../../genius/core/issue/Objective.html#toXML--">toXML</a></code>&nbsp;in class&nbsp;<code><a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a></code></dd>
358<dt><span class="returnLabel">Returns:</span></dt>
359<dd>The SimpleElement with this issues name and index.</dd>
360</dl>
361</li>
362</ul>
363</li>
364</ul>
365</li>
366</ul>
367</div>
368</div>
369<!-- ========= END OF CLASS DATA ========= -->
370<!-- ======= START OF BOTTOM NAVBAR ====== -->
371<div class="bottomNav"><a name="navbar.bottom">
372<!-- -->
373</a>
374<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
375<a name="navbar.bottom.firstrow">
376<!-- -->
377</a>
378<ul class="navList" title="Navigation">
379<li><a href="../../../overview-summary.html">Overview</a></li>
380<li><a href="package-summary.html">Package</a></li>
381<li class="navBarCell1Rev">Class</li>
382<li><a href="class-use/Issue.html">Use</a></li>
383<li><a href="package-tree.html">Tree</a></li>
384<li><a href="../../../deprecated-list.html">Deprecated</a></li>
385<li><a href="../../../index-all.html">Index</a></li>
386<li><a href="../../../help-doc.html">Help</a></li>
387</ul>
388</div>
389<div class="subNav">
390<ul class="navList">
391<li>Prev&nbsp;Class</li>
392<li><a href="../../../genius/core/issue/IssueDiscrete.html" title="class in genius.core.issue"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
393</ul>
394<ul class="navList">
395<li><a href="../../../index.html?genius/core/issue/Issue.html" target="_top">Frames</a></li>
396<li><a href="Issue.html" target="_top">No&nbsp;Frames</a></li>
397</ul>
398<ul class="navList" id="allclasses_navbar_bottom">
399<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
400</ul>
401<div>
402<script type="text/javascript"><!--
403 allClassesLink = document.getElementById("allclasses_navbar_bottom");
404 if(window==top) {
405 allClassesLink.style.display = "block";
406 }
407 else {
408 allClassesLink.style.display = "none";
409 }
410 //-->
411</script>
412</div>
413<div>
414<ul class="subNavList">
415<li>Summary:&nbsp;</li>
416<li>Nested&nbsp;|&nbsp;</li>
417<li>Field&nbsp;|&nbsp;</li>
418<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
419<li><a href="#method.summary">Method</a></li>
420</ul>
421<ul class="subNavList">
422<li>Detail:&nbsp;</li>
423<li>Field&nbsp;|&nbsp;</li>
424<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
425<li><a href="#method.detail">Method</a></li>
426</ul>
427</div>
428<a name="skip.navbar.bottom">
429<!-- -->
430</a></div>
431<!-- ======== END OF BOTTOM NAVBAR ======= -->
432</body>
433</html>
Note: See TracBrowser for help on using the repository browser.