Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / detection / AbstractClusterMatcher.html
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_191) on Thu Mar 28 11:26:59 PDT 2019 -->
6 <title>AbstractClusterMatcher</title>
7 <meta name="date" content="2019-03-28">
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="AbstractClusterMatcher";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var 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="package-tree.html">Tree</a></li>
44 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
45 <li><a href="../../../../index-files/index-1.html">Index</a></li>
46 <li><a href="../../../../help-doc.html">Help</a></li>
47 </ul>
48 </div>
49 <div class="subNav">
50 <ul class="navList">
51 <li>Prev&nbsp;Class</li>
52 <li><a href="../../../../edu/uci/iotproject/detection/AbstractSignatureDetector.html" title="class in edu.uci.iotproject.detection"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../index.html?edu/uci/iotproject/detection/AbstractClusterMatcher.html" target="_top">Frames</a></li>
56 <li><a href="AbstractClusterMatcher.html" target="_top">No&nbsp;Frames</a></li>
57 </ul>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
60 </ul>
61 <div>
62 <script type="text/javascript"><!--
63   allClassesLink = document.getElementById("allclasses_navbar_top");
64   if(window==top) {
65     allClassesLink.style.display = "block";
66   }
67   else {
68     allClassesLink.style.display = "none";
69   }
70   //-->
71 </script>
72 </div>
73 <div>
74 <ul class="subNavList">
75 <li>Summary:&nbsp;</li>
76 <li>Nested&nbsp;|&nbsp;</li>
77 <li>Field&nbsp;|&nbsp;</li>
78 <li>Constr&nbsp;|&nbsp;</li>
79 <li><a href="#method.summary">Method</a></li>
80 </ul>
81 <ul class="subNavList">
82 <li>Detail:&nbsp;</li>
83 <li>Field&nbsp;|&nbsp;</li>
84 <li>Constr&nbsp;|&nbsp;</li>
85 <li><a href="#method.detail">Method</a></li>
86 </ul>
87 </div>
88 <a name="skip.navbar.top">
89 <!--   -->
90 </a></div>
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
93 <div class="header">
94 <div class="subTitle">edu.uci.iotproject.detection</div>
95 <h2 title="Class AbstractClusterMatcher" class="title">Class AbstractClusterMatcher</h2>
96 </div>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
100 <li>
101 <ul class="inheritance">
102 <li>edu.uci.iotproject.detection.AbstractClusterMatcher</li>
103 </ul>
104 </li>
105 </ul>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
109 <dl>
110 <dt>Direct Known Subclasses:</dt>
111 <dd><a href="../../../../edu/uci/iotproject/detection/layer2/Layer2ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2ClusterMatcher</a>, <a href="../../../../edu/uci/iotproject/detection/layer3/Layer3ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer3">Layer3ClusterMatcher</a></dd>
112 </dl>
113 <hr>
114 <br>
115 <pre>public abstract class <span class="typeNameLabel">AbstractClusterMatcher</span>
116 extends java.lang.Object</pre>
117 <div class="block">Base class for classes that search a traffic trace for sequences of packets that "belong to" a given cluster (in
118  other words, classes that attempt to classify traffic as pertaining to a given cluster).</div>
119 </li>
120 </ul>
121 </div>
122 <div class="summary">
123 <ul class="blockList">
124 <li class="blockList">
125 <!-- ========== METHOD SUMMARY =========== -->
126 <ul class="blockList">
127 <li class="blockList"><a name="method.summary">
128 <!--   -->
129 </a>
130 <h3>Method Summary</h3>
131 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
132 <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>
133 <tr>
134 <th class="colFirst" scope="col">Modifier and Type</th>
135 <th class="colLast" scope="col">Method and Description</th>
136 </tr>
137 <tr id="i0" class="altColor">
138 <td class="colFirst"><code>void</code></td>
139 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html#addObserver-edu.uci.iotproject.detection.ClusterMatcherObserver-">addObserver</a></span>(<a href="../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a>&nbsp;observer)</code>
140 <div class="block">Register for callbacks from this cluster matcher.</div>
141 </td>
142 </tr>
143 <tr id="i1" class="rowColor">
144 <td class="colFirst"><code>void</code></td>
145 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html#removeObserver-edu.uci.iotproject.detection.ClusterMatcherObserver-">removeObserver</a></span>(<a href="../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a>&nbsp;observer)</code>
146 <div class="block">Deregister for callbacks from this cluster matcher.</div>
147 </td>
148 </tr>
149 </table>
150 <ul class="blockList">
151 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
152 <!--   -->
153 </a>
154 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
155 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
156 </ul>
157 </li>
158 </ul>
159 </li>
160 </ul>
161 </div>
162 <div class="details">
163 <ul class="blockList">
164 <li class="blockList">
165 <!-- ============ METHOD DETAIL ========== -->
166 <ul class="blockList">
167 <li class="blockList"><a name="method.detail">
168 <!--   -->
169 </a>
170 <h3>Method Detail</h3>
171 <a name="addObserver-edu.uci.iotproject.detection.ClusterMatcherObserver-">
172 <!--   -->
173 </a>
174 <ul class="blockList">
175 <li class="blockList">
176 <h4>addObserver</h4>
177 <pre>public final&nbsp;void&nbsp;addObserver(<a href="../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a>&nbsp;observer)</pre>
178 <div class="block">Register for callbacks from this cluster matcher.</div>
179 <dl>
180 <dt><span class="paramLabel">Parameters:</span></dt>
181 <dd><code>observer</code> - The target of the callbacks.</dd>
182 </dl>
183 </li>
184 </ul>
185 <a name="removeObserver-edu.uci.iotproject.detection.ClusterMatcherObserver-">
186 <!--   -->
187 </a>
188 <ul class="blockListLast">
189 <li class="blockList">
190 <h4>removeObserver</h4>
191 <pre>public final&nbsp;void&nbsp;removeObserver(<a href="../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a>&nbsp;observer)</pre>
192 <div class="block">Deregister for callbacks from this cluster matcher.</div>
193 <dl>
194 <dt><span class="paramLabel">Parameters:</span></dt>
195 <dd><code>observer</code> - The callback target that is to be deregistered.</dd>
196 </dl>
197 </li>
198 </ul>
199 </li>
200 </ul>
201 </li>
202 </ul>
203 </div>
204 </div>
205 <!-- ========= END OF CLASS DATA ========= -->
206 <!-- ======= START OF BOTTOM NAVBAR ====== -->
207 <div class="bottomNav"><a name="navbar.bottom">
208 <!--   -->
209 </a>
210 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
211 <a name="navbar.bottom.firstrow">
212 <!--   -->
213 </a>
214 <ul class="navList" title="Navigation">
215 <li><a href="../../../../overview-summary.html">Overview</a></li>
216 <li><a href="package-summary.html">Package</a></li>
217 <li class="navBarCell1Rev">Class</li>
218 <li><a href="package-tree.html">Tree</a></li>
219 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
220 <li><a href="../../../../index-files/index-1.html">Index</a></li>
221 <li><a href="../../../../help-doc.html">Help</a></li>
222 </ul>
223 </div>
224 <div class="subNav">
225 <ul class="navList">
226 <li>Prev&nbsp;Class</li>
227 <li><a href="../../../../edu/uci/iotproject/detection/AbstractSignatureDetector.html" title="class in edu.uci.iotproject.detection"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
228 </ul>
229 <ul class="navList">
230 <li><a href="../../../../index.html?edu/uci/iotproject/detection/AbstractClusterMatcher.html" target="_top">Frames</a></li>
231 <li><a href="AbstractClusterMatcher.html" target="_top">No&nbsp;Frames</a></li>
232 </ul>
233 <ul class="navList" id="allclasses_navbar_bottom">
234 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
235 </ul>
236 <div>
237 <script type="text/javascript"><!--
238   allClassesLink = document.getElementById("allclasses_navbar_bottom");
239   if(window==top) {
240     allClassesLink.style.display = "block";
241   }
242   else {
243     allClassesLink.style.display = "none";
244   }
245   //-->
246 </script>
247 </div>
248 <div>
249 <ul class="subNavList">
250 <li>Summary:&nbsp;</li>
251 <li>Nested&nbsp;|&nbsp;</li>
252 <li>Field&nbsp;|&nbsp;</li>
253 <li>Constr&nbsp;|&nbsp;</li>
254 <li><a href="#method.summary">Method</a></li>
255 </ul>
256 <ul class="subNavList">
257 <li>Detail:&nbsp;</li>
258 <li>Field&nbsp;|&nbsp;</li>
259 <li>Constr&nbsp;|&nbsp;</li>
260 <li><a href="#method.detail">Method</a></li>
261 </ul>
262 </div>
263 <a name="skip.navbar.bottom">
264 <!--   -->
265 </a></div>
266 <!-- ======== END OF BOTTOM NAVBAR ======= -->
267 </body>
268 </html>