<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Mon Sep 22 13:06:34 BRT 2014 -->
<title>PlanLibrary</title>
<meta name="date" content="2014-09-22">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PlanLibrary";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/PlanLibrary.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="../../bdi4jade/plan/Plan.EndState.html" title="enum in bdi4jade.plan"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/plan/PlanLibrary.html" target="_top">Frames</a></li>
<li><a href="PlanLibrary.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">bdi4jade.plan</div>
<h2 title="Class PlanLibrary" class="title">Class PlanLibrary</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.plan.PlanLibrary</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PlanLibrary</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">This class represents the plan library of a capability. It aggregates the
plans that can be used to achieve goals.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ingrid Nunes</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../serialized-form.html#bdi4jade.plan.PlanLibrary">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#PlanLibrary--">PlanLibrary</a></span>()</code>
<div class="block">The default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code> </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#PlanLibrary-bdi4jade.core.Capability-">PlanLibrary</a></span>(<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability)</code>
<div class="block">Creates a plan library associated with a capability.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code> </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#PlanLibrary-bdi4jade.core.Capability-java.util.Set-">PlanLibrary</a></span>(<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability,
java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a>> plans)</code>
<div class="block">Creates a plan library base associated with a capability and adds the
plans in the provided set.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#addDefaultPlans--">addDefaultPlans</a></span>()</code>
<div class="block">Adds a set of default plans to this library.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#addPlan-bdi4jade.plan.Plan-">addPlan</a></span>(<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan)</code>
<div class="block">Adds a plan to the plan library.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#canAchieve-bdi4jade.goal.Goal-">canAchieve</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Returns true if there is a plan that can achieve the given goal.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#canHandle-jade.lang.acl.ACLMessage-">canHandle</a></span>(jade.lang.acl.ACLMessage message)</code>
<div class="block">Returns true if there is a plan that can handle the given message.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#getCandidatePlans-bdi4jade.goal.Goal-">getCandidatePlans</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Returns the set of plans that can achieve the given goal.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#getCapability--">getCapability</a></span>()</code>
<div class="block">Returns the capability with which this plan library is associated.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#getPlans--">getPlans</a></span>()</code>
<div class="block">Returns the set of plans that are part of this plan library.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#hasPlan-bdi4jade.plan.Plan-">hasPlan</a></span>(<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan)</code>
<div class="block">Checks if a plan is part of the plan library.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/plan/PlanLibrary.html#removePlan-bdi4jade.plan.Plan-">removePlan</a></span>(<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan)</code>
<div class="block">Removes a plan from the plan library.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PlanLibrary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PlanLibrary</h4>
<pre>protected PlanLibrary()</pre>
<div class="block">The default constructor. It should be only used if persistence frameworks
are used.</div>
</li>
</ul>
<a name="PlanLibrary-bdi4jade.core.Capability-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PlanLibrary</h4>
<pre>public PlanLibrary(<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability)</pre>
<div class="block">Creates a plan library associated with a capability.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>capability</code> - the capability with which this plan library is associated.</dd>
</dl>
</li>
</ul>
<a name="PlanLibrary-bdi4jade.core.Capability-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlanLibrary</h4>
<pre>public PlanLibrary(<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability,
java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a>> plans)</pre>
<div class="block">Creates a plan library base associated with a capability and adds the
plans in the provided set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>capability</code> - the capability with which this plan library is associated.</dd>
<dd><code>plans</code> - the initial plans</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addDefaultPlans--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDefaultPlans</h4>
<pre>protected void addDefaultPlans()</pre>
<div class="block">Adds a set of default plans to this library. It adds plans to achieve the
sequential and parallel goals. This method may be overridden by children
capabilities.</div>
</li>
</ul>
<a name="addPlan-bdi4jade.plan.Plan-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPlan</h4>
<pre>public void addPlan(<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan)</pre>
<div class="block">Adds a plan to the plan library.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plan</code> - the plan to be added.</dd>
</dl>
</li>
</ul>
<a name="canAchieve-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canAchieve</h4>
<pre>public boolean canAchieve(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</pre>
<div class="block">Returns true if there is a plan that can achieve the given goal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be checked.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a plan can achieve the goal, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="canHandle-jade.lang.acl.ACLMessage-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canHandle</h4>
<pre>public boolean canHandle(jade.lang.acl.ACLMessage message)</pre>
<div class="block">Returns true if there is a plan that can handle the given message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the message to be checked.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a plan can handle the message, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getCandidatePlans-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCandidatePlans</h4>
<pre>public java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a>> getCandidatePlans(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</pre>
<div class="block">Returns the set of plans that can achieve the given goal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be achieved.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of plans that can achieve the goal.</dd>
</dl>
</li>
</ul>
<a name="getCapability--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapability</h4>
<pre>public <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> getCapability()</pre>
<div class="block">Returns the capability with which this plan library is associated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the capability.</dd>
</dl>
</li>
</ul>
<a name="getPlans--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlans</h4>
<pre>public java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a>> getPlans()</pre>
<div class="block">Returns the set of plans that are part of this plan library.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the plans.</dd>
</dl>
</li>
</ul>
<a name="hasPlan-bdi4jade.plan.Plan-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPlan</h4>
<pre>public boolean hasPlan(<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan)</pre>
<div class="block">Checks if a plan is part of the plan library.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plan</code> - the plan to be checked</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the plan library contains the plan.</dd>
</dl>
</li>
</ul>
<a name="removePlan-bdi4jade.plan.Plan-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removePlan</h4>
<pre>public boolean removePlan(<a href="../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan)</pre>
<div class="block">Removes a plan from the plan library.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plan</code> - the plan to be removed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the plan was removed, 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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/PlanLibrary.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="../../bdi4jade/plan/Plan.EndState.html" title="enum in bdi4jade.plan"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/plan/PlanLibrary.html" target="_top">Frames</a></li>
<li><a href="PlanLibrary.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>