SegmentedTimeline.html 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580
  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_05) on Thu Jul 31 14:50:28 CEST 2014 -->
  6. <title>SegmentedTimeline (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  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="SegmentedTimeline (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":9,"i33":9,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/SegmentedTimeline.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-files/index-1.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><a href="../../../../org/jfree/chart/axis/QuarterDateFormat.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/axis/SegmentedTimeline.html" target="_top">Frames</a></li>
  57. <li><a href="SegmentedTimeline.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  78. <li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">org.jfree.chart.axis</div>
  96. <h2 title="Class SegmentedTimeline" class="title">Class SegmentedTimeline</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>org.jfree.chart.axis.SegmentedTimeline</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable, java.lang.Cloneable, <a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.154">SegmentedTimeline</a>
  117. extends java.lang.Object
  118. implements <a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a>, java.lang.Cloneable, java.io.Serializable</pre>
  119. <div class="block">A <a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis"><code>Timeline</code></a> that implements a "segmented" timeline with included,
  120. excluded and exception segments.
  121. <p>A Timeline will present a series of values to be used for an axis. Each
  122. Timeline must provide transformation methods between domain values and
  123. timeline values.</p>
  124. <p>A timeline can be used as parameter to a
  125. <a href="../../../../org/jfree/chart/axis/DateAxis.html" title="class in org.jfree.chart.axis"><code>DateAxis</code></a> to define the values that this axis
  126. supports. This class implements a timeline formed by segments of equal
  127. length (ex. days, hours, minutes) where some segments can be included in the
  128. timeline and others excluded. Therefore timelines like "working days" or
  129. "working hours" can be created where non-working days or non-working hours
  130. respectively can be removed from the timeline, and therefore from the axis.
  131. This creates a smooth plot with equal separation between all included
  132. segments.</p>
  133. <p>Because Timelines were created mainly for Date related axis, values are
  134. represented as longs instead of doubles. In this case, the domain value is
  135. just the number of milliseconds since January 1, 1970, 00:00:00 GMT as
  136. defined by the getTime() method of <code>Date</code>.</p>
  137. <p>In this class, a segment is defined as a unit of time of fixed length.
  138. Examples of segments are: days, hours, minutes, etc. The size of a segment
  139. is defined as the number of milliseconds in the segment. Some useful segment
  140. sizes are defined as constants in this class: DAY_SEGMENT_SIZE,
  141. HOUR_SEGMENT_SIZE, FIFTEEN_MINUTE_SEGMENT_SIZE and MINUTE_SEGMENT_SIZE.</p>
  142. <p>Segments are group together to form a Segment Group. Each Segment Group will
  143. contain a number of Segments included and a number of Segments excluded. This
  144. Segment Group structure will repeat for the whole timeline.</p>
  145. <p>For example, a working days SegmentedTimeline would be formed by a group of
  146. 7 daily segments, where there are 5 included (Monday through Friday) and 2
  147. excluded (Saturday and Sunday) segments.</p>
  148. <p>Following is a diagram that explains the major attributes that define a
  149. segment. Each box is one segment and must be of fixed length (ms, second,
  150. hour, day, etc).</p>
  151. <pre>
  152. start time
  153. |
  154. v
  155. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ...
  156. +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+...
  157. | | | | | |EE|EE| | | | | |EE|EE| | | | | |EE|EE|
  158. +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+...
  159. \____________/ \___/ \_/
  160. \/ | |
  161. included excluded segment
  162. segments segments size
  163. \_________ _______/
  164. \/
  165. segment group
  166. </pre>
  167. Legend:<br>
  168. &lt;space&gt; = Included segment<br>
  169. EE = Excluded segments in the base timeline<br>
  170. <p>In the example, the following segment attributes are presented:</p>
  171. <ul>
  172. <li>segment size: the size of each segment in ms.
  173. <li>start time: the start of the first segment of the first segment group to
  174. consider.
  175. <li>included segments: the number of segments to include in the group.
  176. <li>excluded segments: the number of segments to exclude in the group.
  177. </ul>
  178. <p>Exception Segments are allowed. These exception segments are defined as
  179. segments that would have been in the included segments of the Segment Group,
  180. but should be excluded for special reasons. In the previous working days
  181. SegmentedTimeline example, holidays would be considered exceptions.</p>
  182. <p>Additionally the <code>startTime</code>, or start of the first Segment of
  183. the smallest segment group needs to be defined. This startTime could be
  184. relative to January 1, 1970, 00:00:00 GMT or any other date. This creates a
  185. point of reference to start counting Segment Groups. For example, for the
  186. working days SegmentedTimeline, the <code>startTime</code> could be
  187. 00:00:00 GMT of the first Monday after January 1, 1970. In this class, the
  188. constant FIRST_MONDAY_AFTER_1900 refers to a reference point of the first
  189. Monday of the last century.</p>
  190. <p>A SegmentedTimeline can include a baseTimeline. This combination of
  191. timelines allows the creation of more complex timelines. For example, in
  192. order to implement a SegmentedTimeline for an intraday stock trading
  193. application, where the trading period is defined as 9:00 AM through 4:00 PM
  194. Monday through Friday, two SegmentedTimelines are used. The first one (the
  195. baseTimeline) would be a working day SegmentedTimeline (daily timeline
  196. Monday through Friday). On top of this baseTimeline, a second one is defined
  197. that maps the 9:00 AM to 4:00 PM period. Because the baseTimeline defines a
  198. timeline of Monday through Friday, the resulting (combined) timeline will
  199. expose the period 9:00 AM through 4:00 PM only on Monday through Friday,
  200. and will remove all other intermediate intervals.</p>
  201. <p>Two factory methods newMondayThroughFridayTimeline() and
  202. newFifteenMinuteTimeline() are provided as examples to create special
  203. SegmentedTimelines.</p></div>
  204. <dl>
  205. <dt><span class="seeLabel">See Also:</span></dt>
  206. <dd><a href="../../../../org/jfree/chart/axis/DateAxis.html" title="class in org.jfree.chart.axis"><code>DateAxis</code></a>,
  207. <a href="../../../../serialized-form.html#org.jfree.chart.axis.SegmentedTimeline">Serialized Form</a></dd>
  208. </dl>
  209. </li>
  210. </ul>
  211. </div>
  212. <div class="summary">
  213. <ul class="blockList">
  214. <li class="blockList">
  215. <!-- ======== NESTED CLASS SUMMARY ======== -->
  216. <ul class="blockList">
  217. <li class="blockList"><a name="nested.class.summary">
  218. <!-- -->
  219. </a>
  220. <h3>Nested Class Summary</h3>
  221. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
  222. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  223. <tr>
  224. <th class="colFirst" scope="col">Modifier and Type</th>
  225. <th class="colLast" scope="col">Class and Description</th>
  226. </tr>
  227. <tr class="altColor">
  228. <td class="colFirst"><code>protected class&nbsp;</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis">SegmentedTimeline.BaseTimelineSegmentRange</a></span></code>
  230. <div class="block">Special <code>SegmentRange</code> that came from the BaseTimeline.</div>
  231. </td>
  232. </tr>
  233. <tr class="rowColor">
  234. <td class="colFirst"><code>class&nbsp;</code></td>
  235. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a></span></code>
  236. <div class="block">Internal class to represent a valid segment for this timeline.</div>
  237. </td>
  238. </tr>
  239. <tr class="altColor">
  240. <td class="colFirst"><code>protected class&nbsp;</code></td>
  241. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.SegmentRange.html" title="class in org.jfree.chart.axis">SegmentedTimeline.SegmentRange</a></span></code>
  242. <div class="block">Private internal class to represent a range of segments.</div>
  243. </td>
  244. </tr>
  245. </table>
  246. </li>
  247. </ul>
  248. <!-- =========== FIELD SUMMARY =========== -->
  249. <ul class="blockList">
  250. <li class="blockList"><a name="field.summary">
  251. <!-- -->
  252. </a>
  253. <h3>Field Summary</h3>
  254. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  255. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  256. <tr>
  257. <th class="colFirst" scope="col">Modifier and Type</th>
  258. <th class="colLast" scope="col">Field and Description</th>
  259. </tr>
  260. <tr class="altColor">
  261. <td class="colFirst"><code>static long</code></td>
  262. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#DAY_SEGMENT_SIZE">DAY_SEGMENT_SIZE</a></span></code>
  263. <div class="block">Defines a day segment size in ms.</div>
  264. </td>
  265. </tr>
  266. <tr class="rowColor">
  267. <td class="colFirst"><code>static java.util.TimeZone</code></td>
  268. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#DEFAULT_TIME_ZONE">DEFAULT_TIME_ZONE</a></span></code>
  269. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  270. <div class="block"><span class="deprecationComment">As of 1.0.7. When the default time zone is required,
  271. just call <code>TimeZone.getDefault()</code>.</span></div>
  272. </div>
  273. </td>
  274. </tr>
  275. <tr class="altColor">
  276. <td class="colFirst"><code>static long</code></td>
  277. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#FIFTEEN_MINUTE_SEGMENT_SIZE">FIFTEEN_MINUTE_SEGMENT_SIZE</a></span></code>
  278. <div class="block">Defines a 15-minute segment size in ms.</div>
  279. </td>
  280. </tr>
  281. <tr class="rowColor">
  282. <td class="colFirst"><code>static long</code></td>
  283. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#FIRST_MONDAY_AFTER_1900">FIRST_MONDAY_AFTER_1900</a></span></code>
  284. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  285. <div class="block"><span class="deprecationComment">As of 1.0.7. This field doesn't take into account changes
  286. to the default time zone.</span></div>
  287. </div>
  288. </td>
  289. </tr>
  290. <tr class="altColor">
  291. <td class="colFirst"><code>static long</code></td>
  292. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#HOUR_SEGMENT_SIZE">HOUR_SEGMENT_SIZE</a></span></code>
  293. <div class="block">Defines a one hour segment size in ms.</div>
  294. </td>
  295. </tr>
  296. <tr class="rowColor">
  297. <td class="colFirst"><code>static long</code></td>
  298. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#MINUTE_SEGMENT_SIZE">MINUTE_SEGMENT_SIZE</a></span></code>
  299. <div class="block">Defines a one-minute segment size in ms.</div>
  300. </td>
  301. </tr>
  302. <tr class="altColor">
  303. <td class="colFirst"><code>static java.util.TimeZone</code></td>
  304. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#NO_DST_TIME_ZONE">NO_DST_TIME_ZONE</a></span></code>
  305. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  306. <div class="block"><span class="deprecationComment">As of 1.0.7. This field is initialised based on the
  307. default time zone, and doesn't take into account subsequent
  308. changes to the default.</span></div>
  309. </div>
  310. </td>
  311. </tr>
  312. </table>
  313. </li>
  314. </ul>
  315. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  316. <ul class="blockList">
  317. <li class="blockList"><a name="constructor.summary">
  318. <!-- -->
  319. </a>
  320. <h3>Constructor Summary</h3>
  321. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  322. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  323. <tr>
  324. <th class="colOne" scope="col">Constructor and Description</th>
  325. </tr>
  326. <tr class="altColor">
  327. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#SegmentedTimeline-long-int-int-">SegmentedTimeline</a></span>(long&nbsp;segmentSize,
  328. int&nbsp;segmentsIncluded,
  329. int&nbsp;segmentsExcluded)</code>
  330. <div class="block">Constructs a new segmented timeline, optionaly using another segmented
  331. timeline as its base.</div>
  332. </td>
  333. </tr>
  334. </table>
  335. </li>
  336. </ul>
  337. <!-- ========== METHOD SUMMARY =========== -->
  338. <ul class="blockList">
  339. <li class="blockList"><a name="method.summary">
  340. <!-- -->
  341. </a>
  342. <h3>Method Summary</h3>
  343. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  344. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
  345. <tr>
  346. <th class="colFirst" scope="col">Modifier and Type</th>
  347. <th class="colLast" scope="col">Method and Description</th>
  348. </tr>
  349. <tr id="i0" class="altColor">
  350. <td class="colFirst"><code>void</code></td>
  351. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addBaseTimelineException-java.util.Date-">addBaseTimelineException</a></span>(java.util.Date&nbsp;date)</code>
  352. <div class="block">Adds a segment relative to the baseTimeline as an exception.</div>
  353. </td>
  354. </tr>
  355. <tr id="i1" class="rowColor">
  356. <td class="colFirst"><code>void</code></td>
  357. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addBaseTimelineException-long-">addBaseTimelineException</a></span>(long&nbsp;domainValue)</code>
  358. <div class="block">Adds a segment relative to the baseTimeline as an exception.</div>
  359. </td>
  360. </tr>
  361. <tr id="i2" class="altColor">
  362. <td class="colFirst"><code>void</code></td>
  363. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addBaseTimelineExclusions-long-long-">addBaseTimelineExclusions</a></span>(long&nbsp;fromBaseDomainValue,
  364. long&nbsp;toBaseDomainValue)</code>
  365. <div class="block">Adds all excluded segments from the BaseTimeline as exceptions to our
  366. timeline.</div>
  367. </td>
  368. </tr>
  369. <tr id="i3" class="rowColor">
  370. <td class="colFirst"><code>void</code></td>
  371. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addException-java.util.Date-">addException</a></span>(java.util.Date&nbsp;exceptionDate)</code>
  372. <div class="block">Adds a segment as an exception.</div>
  373. </td>
  374. </tr>
  375. <tr id="i4" class="altColor">
  376. <td class="colFirst"><code>void</code></td>
  377. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addException-long-">addException</a></span>(long&nbsp;millisecond)</code>
  378. <div class="block">Adds a segment as an exception.</div>
  379. </td>
  380. </tr>
  381. <tr id="i5" class="rowColor">
  382. <td class="colFirst"><code>void</code></td>
  383. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addException-long-long-">addException</a></span>(long&nbsp;fromDomainValue,
  384. long&nbsp;toDomainValue)</code>
  385. <div class="block">Adds a segment range as an exception.</div>
  386. </td>
  387. </tr>
  388. <tr id="i6" class="altColor">
  389. <td class="colFirst"><code>void</code></td>
  390. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addExceptions-java.util.List-">addExceptions</a></span>(java.util.List&nbsp;exceptionList)</code>
  391. <div class="block">Adds a list of dates as segment exceptions.</div>
  392. </td>
  393. </tr>
  394. <tr id="i7" class="rowColor">
  395. <td class="colFirst"><code>java.lang.Object</code></td>
  396. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#clone--">clone</a></span>()</code>
  397. <div class="block">Returns a clone of the timeline.</div>
  398. </td>
  399. </tr>
  400. <tr id="i8" class="altColor">
  401. <td class="colFirst"><code>boolean</code></td>
  402. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#containsDomainRange-java.util.Date-java.util.Date-">containsDomainRange</a></span>(java.util.Date&nbsp;dateDomainValueStart,
  403. java.util.Date&nbsp;dateDomainValueEnd)</code>
  404. <div class="block">Returns <code>true</code> if a range of values are contained in the
  405. timeline.</div>
  406. </td>
  407. </tr>
  408. <tr id="i9" class="rowColor">
  409. <td class="colFirst"><code>boolean</code></td>
  410. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#containsDomainRange-long-long-">containsDomainRange</a></span>(long&nbsp;domainValueStart,
  411. long&nbsp;domainValueEnd)</code>
  412. <div class="block">Returns <code>true</code> if a range of values are contained in the
  413. timeline.</div>
  414. </td>
  415. </tr>
  416. <tr id="i10" class="altColor">
  417. <td class="colFirst"><code>boolean</code></td>
  418. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#containsDomainValue-java.util.Date-">containsDomainValue</a></span>(java.util.Date&nbsp;date)</code>
  419. <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
  420. </td>
  421. </tr>
  422. <tr id="i11" class="rowColor">
  423. <td class="colFirst"><code>boolean</code></td>
  424. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#containsDomainValue-long-">containsDomainValue</a></span>(long&nbsp;millisecond)</code>
  425. <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
  426. </td>
  427. </tr>
  428. <tr id="i12" class="altColor">
  429. <td class="colFirst"><code>boolean</code></td>
  430. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;o)</code>
  431. <div class="block">Returns true if we are equal to the parameter</div>
  432. </td>
  433. </tr>
  434. <tr id="i13" class="rowColor">
  435. <td class="colFirst"><code>static long</code></td>
  436. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#firstMondayAfter1900--">firstMondayAfter1900</a></span>()</code>
  437. <div class="block">Returns the milliseconds for midnight of the first Monday after
  438. 1-Jan-1900, ignoring daylight savings.</div>
  439. </td>
  440. </tr>
  441. <tr id="i14" class="altColor">
  442. <td class="colFirst"><code>boolean</code></td>
  443. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getAdjustForDaylightSaving--">getAdjustForDaylightSaving</a></span>()</code>
  444. <div class="block">Returns the flag that controls whether or not the daylight saving
  445. adjustment is applied.</div>
  446. </td>
  447. </tr>
  448. <tr id="i15" class="rowColor">
  449. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></code></td>
  450. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getBaseTimeline--">getBaseTimeline</a></span>()</code>
  451. <div class="block">Returns our baseTimeline, or <code>null</code> if none.</div>
  452. </td>
  453. </tr>
  454. <tr id="i16" class="altColor">
  455. <td class="colFirst"><code>java.util.Date</code></td>
  456. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getDate-long-">getDate</a></span>(long&nbsp;value)</code>
  457. <div class="block">Converts a millisecond value into a <code>Date</code> object.</div>
  458. </td>
  459. </tr>
  460. <tr id="i17" class="rowColor">
  461. <td class="colFirst"><code>long</code></td>
  462. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getExceptionSegmentCount-long-long-">getExceptionSegmentCount</a></span>(long&nbsp;fromMillisecond,
  463. long&nbsp;toMillisecond)</code>
  464. <div class="block">Returns the number of exception segments wholly contained in the
  465. (fromDomainValue, toDomainValue) interval.</div>
  466. </td>
  467. </tr>
  468. <tr id="i18" class="altColor">
  469. <td class="colFirst"><code>java.util.List</code></td>
  470. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getExceptionSegments--">getExceptionSegments</a></span>()</code>
  471. <div class="block">Returns a list of all the exception segments.</div>
  472. </td>
  473. </tr>
  474. <tr id="i19" class="rowColor">
  475. <td class="colFirst"><code>int</code></td>
  476. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getGroupSegmentCount--">getGroupSegmentCount</a></span>()</code>
  477. <div class="block">Returns the number of segments in a segment group.</div>
  478. </td>
  479. </tr>
  480. <tr id="i20" class="altColor">
  481. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a></code></td>
  482. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegment-java.util.Date-">getSegment</a></span>(java.util.Date&nbsp;date)</code>
  483. <div class="block">Returns a segment that contains a date.</div>
  484. </td>
  485. </tr>
  486. <tr id="i21" class="rowColor">
  487. <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a></code></td>
  488. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegment-long-">getSegment</a></span>(long&nbsp;millisecond)</code>
  489. <div class="block">Returns a segment that contains a domainValue.</div>
  490. </td>
  491. </tr>
  492. <tr id="i22" class="altColor">
  493. <td class="colFirst"><code>int</code></td>
  494. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsExcluded--">getSegmentsExcluded</a></span>()</code>
  495. <div class="block">Returns the number of segments excluded per segment group.</div>
  496. </td>
  497. </tr>
  498. <tr id="i23" class="rowColor">
  499. <td class="colFirst"><code>long</code></td>
  500. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsExcludedSize--">getSegmentsExcludedSize</a></span>()</code>
  501. <div class="block">Returns the size in milliseconds of the segments excluded per segment
  502. group.</div>
  503. </td>
  504. </tr>
  505. <tr id="i24" class="altColor">
  506. <td class="colFirst"><code>long</code></td>
  507. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsGroupSize--">getSegmentsGroupSize</a></span>()</code>
  508. <div class="block">Returns the size in milliseconds of a segment group.</div>
  509. </td>
  510. </tr>
  511. <tr id="i25" class="rowColor">
  512. <td class="colFirst"><code>int</code></td>
  513. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsIncluded--">getSegmentsIncluded</a></span>()</code>
  514. <div class="block">Returns the number of segments included per segment group.</div>
  515. </td>
  516. </tr>
  517. <tr id="i26" class="altColor">
  518. <td class="colFirst"><code>long</code></td>
  519. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsIncludedSize--">getSegmentsIncludedSize</a></span>()</code>
  520. <div class="block">Returns the size in ms of the segments included per segment group.</div>
  521. </td>
  522. </tr>
  523. <tr id="i27" class="rowColor">
  524. <td class="colFirst"><code>long</code></td>
  525. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentSize--">getSegmentSize</a></span>()</code>
  526. <div class="block">Returns the size of one segment in ms.</div>
  527. </td>
  528. </tr>
  529. <tr id="i28" class="altColor">
  530. <td class="colFirst"><code>long</code></td>
  531. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getStartTime--">getStartTime</a></span>()</code>
  532. <div class="block">Returns the start time for the timeline.</div>
  533. </td>
  534. </tr>
  535. <tr id="i29" class="rowColor">
  536. <td class="colFirst"><code>long</code></td>
  537. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getTime-java.util.Date-">getTime</a></span>(java.util.Date&nbsp;date)</code>
  538. <div class="block">Special method that handles conversion between the Default Time Zone and
  539. a UTC time zone with no DST.</div>
  540. </td>
  541. </tr>
  542. <tr id="i30" class="altColor">
  543. <td class="colFirst"><code>long</code></td>
  544. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getTimeFromLong-long-">getTimeFromLong</a></span>(long&nbsp;date)</code>
  545. <div class="block">Converts a date/time value to take account of daylight savings time.</div>
  546. </td>
  547. </tr>
  548. <tr id="i31" class="rowColor">
  549. <td class="colFirst"><code>int</code></td>
  550. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#hashCode--">hashCode</a></span>()</code>
  551. <div class="block">Returns a hash code for this object.</div>
  552. </td>
  553. </tr>
  554. <tr id="i32" class="altColor">
  555. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></code></td>
  556. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#newFifteenMinuteTimeline--">newFifteenMinuteTimeline</a></span>()</code>
  557. <div class="block">Factory method to create a 15-min, 9:00 AM thought 4:00 PM, Monday
  558. through Friday SegmentedTimeline.</div>
  559. </td>
  560. </tr>
  561. <tr id="i33" class="rowColor">
  562. <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></code></td>
  563. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#newMondayThroughFridayTimeline--">newMondayThroughFridayTimeline</a></span>()</code>
  564. <div class="block">Factory method to create a Monday through Friday SegmentedTimeline.</div>
  565. </td>
  566. </tr>
  567. <tr id="i34" class="altColor">
  568. <td class="colFirst"><code>void</code></td>
  569. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#setAdjustForDaylightSaving-boolean-">setAdjustForDaylightSaving</a></span>(boolean&nbsp;adjust)</code>
  570. <div class="block">Sets the flag that controls whether or not the daylight saving adjustment
  571. is applied.</div>
  572. </td>
  573. </tr>
  574. <tr id="i35" class="rowColor">
  575. <td class="colFirst"><code>void</code></td>
  576. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#setBaseTimeline-org.jfree.chart.axis.SegmentedTimeline-">setBaseTimeline</a></span>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a>&nbsp;baseTimeline)</code>
  577. <div class="block">Sets the base timeline.</div>
  578. </td>
  579. </tr>
  580. <tr id="i36" class="altColor">
  581. <td class="colFirst"><code>void</code></td>
  582. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#setExceptionSegments-java.util.List-">setExceptionSegments</a></span>(java.util.List&nbsp;exceptionSegments)</code>
  583. <div class="block">Sets the exception segments list.</div>
  584. </td>
  585. </tr>
  586. <tr id="i37" class="rowColor">
  587. <td class="colFirst"><code>void</code></td>
  588. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#setStartTime-long-">setStartTime</a></span>(long&nbsp;millisecond)</code>
  589. <div class="block">Sets the start time for the timeline.</div>
  590. </td>
  591. </tr>
  592. <tr id="i38" class="altColor">
  593. <td class="colFirst"><code>long</code></td>
  594. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#toMillisecond-long-">toMillisecond</a></span>(long&nbsp;timelineValue)</code>
  595. <div class="block">Translates a value relative to the timeline into a millisecond.</div>
  596. </td>
  597. </tr>
  598. <tr id="i39" class="rowColor">
  599. <td class="colFirst"><code>long</code></td>
  600. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#toTimelineValue-java.util.Date-">toTimelineValue</a></span>(java.util.Date&nbsp;date)</code>
  601. <div class="block">Translates a date into a value relative to the segmented timeline.</div>
  602. </td>
  603. </tr>
  604. <tr id="i40" class="altColor">
  605. <td class="colFirst"><code>long</code></td>
  606. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#toTimelineValue-long-">toTimelineValue</a></span>(long&nbsp;millisecond)</code>
  607. <div class="block">Translates a value relative to the domain value (all Dates) into a value
  608. relative to the segmented timeline.</div>
  609. </td>
  610. </tr>
  611. </table>
  612. <ul class="blockList">
  613. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  614. <!-- -->
  615. </a>
  616. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  617. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  618. </ul>
  619. </li>
  620. </ul>
  621. </li>
  622. </ul>
  623. </div>
  624. <div class="details">
  625. <ul class="blockList">
  626. <li class="blockList">
  627. <!-- ============ FIELD DETAIL =========== -->
  628. <ul class="blockList">
  629. <li class="blockList"><a name="field.detail">
  630. <!-- -->
  631. </a>
  632. <h3>Field Detail</h3>
  633. <a name="DAY_SEGMENT_SIZE">
  634. <!-- -->
  635. </a>
  636. <ul class="blockList">
  637. <li class="blockList">
  638. <h4>DAY_SEGMENT_SIZE</h4>
  639. <pre>public static final&nbsp;long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.164">DAY_SEGMENT_SIZE</a></pre>
  640. <div class="block">Defines a day segment size in ms.</div>
  641. <dl>
  642. <dt><span class="seeLabel">See Also:</span></dt>
  643. <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.DAY_SEGMENT_SIZE">Constant Field Values</a></dd>
  644. </dl>
  645. </li>
  646. </ul>
  647. <a name="HOUR_SEGMENT_SIZE">
  648. <!-- -->
  649. </a>
  650. <ul class="blockList">
  651. <li class="blockList">
  652. <h4>HOUR_SEGMENT_SIZE</h4>
  653. <pre>public static final&nbsp;long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.167">HOUR_SEGMENT_SIZE</a></pre>
  654. <div class="block">Defines a one hour segment size in ms.</div>
  655. <dl>
  656. <dt><span class="seeLabel">See Also:</span></dt>
  657. <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.HOUR_SEGMENT_SIZE">Constant Field Values</a></dd>
  658. </dl>
  659. </li>
  660. </ul>
  661. <a name="FIFTEEN_MINUTE_SEGMENT_SIZE">
  662. <!-- -->
  663. </a>
  664. <ul class="blockList">
  665. <li class="blockList">
  666. <h4>FIFTEEN_MINUTE_SEGMENT_SIZE</h4>
  667. <pre>public static final&nbsp;long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.170">FIFTEEN_MINUTE_SEGMENT_SIZE</a></pre>
  668. <div class="block">Defines a 15-minute segment size in ms.</div>
  669. <dl>
  670. <dt><span class="seeLabel">See Also:</span></dt>
  671. <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.FIFTEEN_MINUTE_SEGMENT_SIZE">Constant Field Values</a></dd>
  672. </dl>
  673. </li>
  674. </ul>
  675. <a name="MINUTE_SEGMENT_SIZE">
  676. <!-- -->
  677. </a>
  678. <ul class="blockList">
  679. <li class="blockList">
  680. <h4>MINUTE_SEGMENT_SIZE</h4>
  681. <pre>public static final&nbsp;long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.173">MINUTE_SEGMENT_SIZE</a></pre>
  682. <div class="block">Defines a one-minute segment size in ms.</div>
  683. <dl>
  684. <dt><span class="seeLabel">See Also:</span></dt>
  685. <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.MINUTE_SEGMENT_SIZE">Constant Field Values</a></dd>
  686. </dl>
  687. </li>
  688. </ul>
  689. <a name="FIRST_MONDAY_AFTER_1900">
  690. <!-- -->
  691. </a>
  692. <ul class="blockList">
  693. <li class="blockList">
  694. <h4>FIRST_MONDAY_AFTER_1900</h4>
  695. <pre>public static&nbsp;long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.188">FIRST_MONDAY_AFTER_1900</a></pre>
  696. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.7. This field doesn't take into account changes
  697. to the default time zone.</span></div>
  698. <div class="block">Utility constant that defines the startTime as the first monday after
  699. 1/1/1970. This should be used when creating a SegmentedTimeline for
  700. Monday through Friday. See static block below for calculation of this
  701. constant.</div>
  702. </li>
  703. </ul>
  704. <a name="NO_DST_TIME_ZONE">
  705. <!-- -->
  706. </a>
  707. <ul class="blockList">
  708. <li class="blockList">
  709. <h4>NO_DST_TIME_ZONE</h4>
  710. <pre>public static&nbsp;java.util.TimeZone <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.199">NO_DST_TIME_ZONE</a></pre>
  711. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.7. This field is initialised based on the
  712. default time zone, and doesn't take into account subsequent
  713. changes to the default.</span></div>
  714. <div class="block">Utility TimeZone object that has no DST and an offset equal to the
  715. default TimeZone. This allows easy arithmetic between days as each one
  716. will have equal size.</div>
  717. </li>
  718. </ul>
  719. <a name="DEFAULT_TIME_ZONE">
  720. <!-- -->
  721. </a>
  722. <ul class="blockListLast">
  723. <li class="blockList">
  724. <h4>DEFAULT_TIME_ZONE</h4>
  725. <pre>public static&nbsp;java.util.TimeZone <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.210">DEFAULT_TIME_ZONE</a></pre>
  726. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.7. When the default time zone is required,
  727. just call <code>TimeZone.getDefault()</code>.</span></div>
  728. <div class="block">This is the default time zone where the application is running. See
  729. getTime() below where we make use of certain transformations between
  730. times in the default time zone and the no-dst time zone used for our
  731. calculations.</div>
  732. </li>
  733. </ul>
  734. </li>
  735. </ul>
  736. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  737. <ul class="blockList">
  738. <li class="blockList"><a name="constructor.detail">
  739. <!-- -->
  740. </a>
  741. <h3>Constructor Detail</h3>
  742. <a name="SegmentedTimeline-long-int-int-">
  743. <!-- -->
  744. </a>
  745. <ul class="blockListLast">
  746. <li class="blockList">
  747. <h4>SegmentedTimeline</h4>
  748. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.314">SegmentedTimeline</a>(long&nbsp;segmentSize,
  749. int&nbsp;segmentsIncluded,
  750. int&nbsp;segmentsExcluded)</pre>
  751. <div class="block">Constructs a new segmented timeline, optionaly using another segmented
  752. timeline as its base. This chaining of SegmentedTimelines allows further
  753. segmentation into smaller timelines.
  754. If a base</div>
  755. <dl>
  756. <dt><span class="paramLabel">Parameters:</span></dt>
  757. <dd><code>segmentSize</code> - the size of a segment in ms. This time unit will be
  758. used to compute the included and excluded segments of the
  759. timeline.</dd>
  760. <dd><code>segmentsIncluded</code> - Number of consecutive segments to include.</dd>
  761. <dd><code>segmentsExcluded</code> - Number of consecutive segments to exclude.</dd>
  762. </dl>
  763. </li>
  764. </ul>
  765. </li>
  766. </ul>
  767. <!-- ============ METHOD DETAIL ========== -->
  768. <ul class="blockList">
  769. <li class="blockList"><a name="method.detail">
  770. <!-- -->
  771. </a>
  772. <h3>Method Detail</h3>
  773. <a name="firstMondayAfter1900--">
  774. <!-- -->
  775. </a>
  776. <ul class="blockList">
  777. <li class="blockList">
  778. <h4>firstMondayAfter1900</h4>
  779. <pre>public static&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.341">firstMondayAfter1900</a>()</pre>
  780. <div class="block">Returns the milliseconds for midnight of the first Monday after
  781. 1-Jan-1900, ignoring daylight savings.</div>
  782. <dl>
  783. <dt><span class="returnLabel">Returns:</span></dt>
  784. <dd>The milliseconds.</dd>
  785. <dt><span class="simpleTagLabel">Since:</span></dt>
  786. <dd>1.0.7</dd>
  787. </dl>
  788. </li>
  789. </ul>
  790. <a name="newMondayThroughFridayTimeline--">
  791. <!-- -->
  792. </a>
  793. <ul class="blockList">
  794. <li class="blockList">
  795. <h4>newMondayThroughFridayTimeline</h4>
  796. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.366">newMondayThroughFridayTimeline</a>()</pre>
  797. <div class="block">Factory method to create a Monday through Friday SegmentedTimeline.
  798. <P>
  799. The <code>startTime</code> of the resulting timeline will be midnight
  800. of the first Monday after 1/1/1900.</div>
  801. <dl>
  802. <dt><span class="returnLabel">Returns:</span></dt>
  803. <dd>A fully initialized SegmentedTimeline.</dd>
  804. </dl>
  805. </li>
  806. </ul>
  807. <a name="newFifteenMinuteTimeline--">
  808. <!-- -->
  809. </a>
  810. <ul class="blockList">
  811. <li class="blockList">
  812. <h4>newFifteenMinuteTimeline</h4>
  813. <pre>public static&nbsp;<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.390">newFifteenMinuteTimeline</a>()</pre>
  814. <div class="block">Factory method to create a 15-min, 9:00 AM thought 4:00 PM, Monday
  815. through Friday SegmentedTimeline.
  816. <P>
  817. This timeline uses a segmentSize of FIFTEEN_MIN_SEGMENT_SIZE. The
  818. segment group is defined as 28 included segments (9:00 AM through
  819. 4:00 PM) and 68 excluded segments (4:00 PM through 9:00 AM the next day).
  820. <P>
  821. In order to exclude Saturdays and Sundays it uses a baseTimeline that
  822. only includes Monday through Friday days.
  823. <P>
  824. The <code>startTime</code> of the resulting timeline will be 9:00 AM
  825. after the startTime of the baseTimeline. This will correspond to 9:00 AM
  826. of the first Monday after 1/1/1900.</div>
  827. <dl>
  828. <dt><span class="returnLabel">Returns:</span></dt>
  829. <dd>A fully initialized SegmentedTimeline.</dd>
  830. </dl>
  831. </li>
  832. </ul>
  833. <a name="getAdjustForDaylightSaving--">
  834. <!-- -->
  835. </a>
  836. <ul class="blockList">
  837. <li class="blockList">
  838. <h4>getAdjustForDaylightSaving</h4>
  839. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.405">getAdjustForDaylightSaving</a>()</pre>
  840. <div class="block">Returns the flag that controls whether or not the daylight saving
  841. adjustment is applied.</div>
  842. <dl>
  843. <dt><span class="returnLabel">Returns:</span></dt>
  844. <dd>A boolean.</dd>
  845. </dl>
  846. </li>
  847. </ul>
  848. <a name="setAdjustForDaylightSaving-boolean-">
  849. <!-- -->
  850. </a>
  851. <ul class="blockList">
  852. <li class="blockList">
  853. <h4>setAdjustForDaylightSaving</h4>
  854. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.415">setAdjustForDaylightSaving</a>(boolean&nbsp;adjust)</pre>
  855. <div class="block">Sets the flag that controls whether or not the daylight saving adjustment
  856. is applied.</div>
  857. <dl>
  858. <dt><span class="paramLabel">Parameters:</span></dt>
  859. <dd><code>adjust</code> - the flag.</dd>
  860. </dl>
  861. </li>
  862. </ul>
  863. <a name="setStartTime-long-">
  864. <!-- -->
  865. </a>
  866. <ul class="blockList">
  867. <li class="blockList">
  868. <h4>setStartTime</h4>
  869. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.429">setStartTime</a>(long&nbsp;millisecond)</pre>
  870. <div class="block">Sets the start time for the timeline. This is the beginning of segment
  871. zero.</div>
  872. <dl>
  873. <dt><span class="paramLabel">Parameters:</span></dt>
  874. <dd><code>millisecond</code> - the start time (encoded as in java.util.Date).</dd>
  875. </dl>
  876. </li>
  877. </ul>
  878. <a name="getStartTime--">
  879. <!-- -->
  880. </a>
  881. <ul class="blockList">
  882. <li class="blockList">
  883. <h4>getStartTime</h4>
  884. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.439">getStartTime</a>()</pre>
  885. <div class="block">Returns the start time for the timeline. This is the beginning of
  886. segment zero.</div>
  887. <dl>
  888. <dt><span class="returnLabel">Returns:</span></dt>
  889. <dd>The start time.</dd>
  890. </dl>
  891. </li>
  892. </ul>
  893. <a name="getSegmentsExcluded--">
  894. <!-- -->
  895. </a>
  896. <ul class="blockList">
  897. <li class="blockList">
  898. <h4>getSegmentsExcluded</h4>
  899. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.448">getSegmentsExcluded</a>()</pre>
  900. <div class="block">Returns the number of segments excluded per segment group.</div>
  901. <dl>
  902. <dt><span class="returnLabel">Returns:</span></dt>
  903. <dd>The number of segments excluded.</dd>
  904. </dl>
  905. </li>
  906. </ul>
  907. <a name="getSegmentsExcludedSize--">
  908. <!-- -->
  909. </a>
  910. <ul class="blockList">
  911. <li class="blockList">
  912. <h4>getSegmentsExcludedSize</h4>
  913. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.458">getSegmentsExcludedSize</a>()</pre>
  914. <div class="block">Returns the size in milliseconds of the segments excluded per segment
  915. group.</div>
  916. <dl>
  917. <dt><span class="returnLabel">Returns:</span></dt>
  918. <dd>The size in milliseconds.</dd>
  919. </dl>
  920. </li>
  921. </ul>
  922. <a name="getGroupSegmentCount--">
  923. <!-- -->
  924. </a>
  925. <ul class="blockList">
  926. <li class="blockList">
  927. <h4>getGroupSegmentCount</h4>
  928. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.468">getGroupSegmentCount</a>()</pre>
  929. <div class="block">Returns the number of segments in a segment group. This will be equal to
  930. segments included plus segments excluded.</div>
  931. <dl>
  932. <dt><span class="returnLabel">Returns:</span></dt>
  933. <dd>The number of segments.</dd>
  934. </dl>
  935. </li>
  936. </ul>
  937. <a name="getSegmentsGroupSize--">
  938. <!-- -->
  939. </a>
  940. <ul class="blockList">
  941. <li class="blockList">
  942. <h4>getSegmentsGroupSize</h4>
  943. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.478">getSegmentsGroupSize</a>()</pre>
  944. <div class="block">Returns the size in milliseconds of a segment group. This will be equal
  945. to size of the segments included plus the size of the segments excluded.</div>
  946. <dl>
  947. <dt><span class="returnLabel">Returns:</span></dt>
  948. <dd>The segment group size in milliseconds.</dd>
  949. </dl>
  950. </li>
  951. </ul>
  952. <a name="getSegmentsIncluded--">
  953. <!-- -->
  954. </a>
  955. <ul class="blockList">
  956. <li class="blockList">
  957. <h4>getSegmentsIncluded</h4>
  958. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.487">getSegmentsIncluded</a>()</pre>
  959. <div class="block">Returns the number of segments included per segment group.</div>
  960. <dl>
  961. <dt><span class="returnLabel">Returns:</span></dt>
  962. <dd>The number of segments.</dd>
  963. </dl>
  964. </li>
  965. </ul>
  966. <a name="getSegmentsIncludedSize--">
  967. <!-- -->
  968. </a>
  969. <ul class="blockList">
  970. <li class="blockList">
  971. <h4>getSegmentsIncludedSize</h4>
  972. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.496">getSegmentsIncludedSize</a>()</pre>
  973. <div class="block">Returns the size in ms of the segments included per segment group.</div>
  974. <dl>
  975. <dt><span class="returnLabel">Returns:</span></dt>
  976. <dd>The segment size in milliseconds.</dd>
  977. </dl>
  978. </li>
  979. </ul>
  980. <a name="getSegmentSize--">
  981. <!-- -->
  982. </a>
  983. <ul class="blockList">
  984. <li class="blockList">
  985. <h4>getSegmentSize</h4>
  986. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.505">getSegmentSize</a>()</pre>
  987. <div class="block">Returns the size of one segment in ms.</div>
  988. <dl>
  989. <dt><span class="returnLabel">Returns:</span></dt>
  990. <dd>The segment size in milliseconds.</dd>
  991. </dl>
  992. </li>
  993. </ul>
  994. <a name="getExceptionSegments--">
  995. <!-- -->
  996. </a>
  997. <ul class="blockList">
  998. <li class="blockList">
  999. <h4>getExceptionSegments</h4>
  1000. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.515">getExceptionSegments</a>()</pre>
  1001. <div class="block">Returns a list of all the exception segments. This list is not
  1002. modifiable.</div>
  1003. <dl>
  1004. <dt><span class="returnLabel">Returns:</span></dt>
  1005. <dd>The exception segments.</dd>
  1006. </dl>
  1007. </li>
  1008. </ul>
  1009. <a name="setExceptionSegments-java.util.List-">
  1010. <!-- -->
  1011. </a>
  1012. <ul class="blockList">
  1013. <li class="blockList">
  1014. <h4>setExceptionSegments</h4>
  1015. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.524">setExceptionSegments</a>(java.util.List&nbsp;exceptionSegments)</pre>
  1016. <div class="block">Sets the exception segments list.</div>
  1017. <dl>
  1018. <dt><span class="paramLabel">Parameters:</span></dt>
  1019. <dd><code>exceptionSegments</code> - the exception segments.</dd>
  1020. </dl>
  1021. </li>
  1022. </ul>
  1023. <a name="getBaseTimeline--">
  1024. <!-- -->
  1025. </a>
  1026. <ul class="blockList">
  1027. <li class="blockList">
  1028. <h4>getBaseTimeline</h4>
  1029. <pre>public&nbsp;<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.533">getBaseTimeline</a>()</pre>
  1030. <div class="block">Returns our baseTimeline, or <code>null</code> if none.</div>
  1031. <dl>
  1032. <dt><span class="returnLabel">Returns:</span></dt>
  1033. <dd>The base timeline.</dd>
  1034. </dl>
  1035. </li>
  1036. </ul>
  1037. <a name="setBaseTimeline-org.jfree.chart.axis.SegmentedTimeline-">
  1038. <!-- -->
  1039. </a>
  1040. <ul class="blockList">
  1041. <li class="blockList">
  1042. <h4>setBaseTimeline</h4>
  1043. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.542">setBaseTimeline</a>(<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a>&nbsp;baseTimeline)</pre>
  1044. <div class="block">Sets the base timeline.</div>
  1045. <dl>
  1046. <dt><span class="paramLabel">Parameters:</span></dt>
  1047. <dd><code>baseTimeline</code> - the timeline.</dd>
  1048. </dl>
  1049. </li>
  1050. </ul>
  1051. <a name="toTimelineValue-long-">
  1052. <!-- -->
  1053. </a>
  1054. <ul class="blockList">
  1055. <li class="blockList">
  1056. <h4>toTimelineValue</h4>
  1057. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.580">toTimelineValue</a>(long&nbsp;millisecond)</pre>
  1058. <div class="block">Translates a value relative to the domain value (all Dates) into a value
  1059. relative to the segmented timeline. The values relative to the segmented
  1060. timeline are all consecutives starting at zero at the startTime.</div>
  1061. <dl>
  1062. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1063. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue-long-">toTimelineValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1064. <dt><span class="paramLabel">Parameters:</span></dt>
  1065. <dd><code>millisecond</code> - the millisecond (as encoded by java.util.Date).</dd>
  1066. <dt><span class="returnLabel">Returns:</span></dt>
  1067. <dd>The timeline value.</dd>
  1068. </dl>
  1069. </li>
  1070. </ul>
  1071. <a name="toTimelineValue-java.util.Date-">
  1072. <!-- -->
  1073. </a>
  1074. <ul class="blockList">
  1075. <li class="blockList">
  1076. <h4>toTimelineValue</h4>
  1077. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.644">toTimelineValue</a>(java.util.Date&nbsp;date)</pre>
  1078. <div class="block">Translates a date into a value relative to the segmented timeline. The
  1079. values relative to the segmented timeline are all consecutives starting
  1080. at zero at the startTime.</div>
  1081. <dl>
  1082. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1083. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue-java.util.Date-">toTimelineValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1084. <dt><span class="paramLabel">Parameters:</span></dt>
  1085. <dd><code>date</code> - date relative to the domain.</dd>
  1086. <dt><span class="returnLabel">Returns:</span></dt>
  1087. <dd>The timeline value (in milliseconds).</dd>
  1088. </dl>
  1089. </li>
  1090. </ul>
  1091. <a name="toMillisecond-long-">
  1092. <!-- -->
  1093. </a>
  1094. <ul class="blockList">
  1095. <li class="blockList">
  1096. <h4>toMillisecond</h4>
  1097. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.657">toMillisecond</a>(long&nbsp;timelineValue)</pre>
  1098. <div class="block">Translates a value relative to the timeline into a millisecond.</div>
  1099. <dl>
  1100. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1101. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#toMillisecond-long-">toMillisecond</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1102. <dt><span class="paramLabel">Parameters:</span></dt>
  1103. <dd><code>timelineValue</code> - the timeline value (in milliseconds).</dd>
  1104. <dt><span class="returnLabel">Returns:</span></dt>
  1105. <dd>The domain value (in milliseconds).</dd>
  1106. <dt><span class="seeLabel">See Also:</span></dt>
  1107. <dd><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><code>SegmentedTimeline</code></a></dd>
  1108. </dl>
  1109. </li>
  1110. </ul>
  1111. <a name="getTimeFromLong-long-">
  1112. <!-- -->
  1113. </a>
  1114. <ul class="blockList">
  1115. <li class="blockList">
  1116. <h4>getTimeFromLong</h4>
  1117. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.706">getTimeFromLong</a>(long&nbsp;date)</pre>
  1118. <div class="block">Converts a date/time value to take account of daylight savings time.</div>
  1119. <dl>
  1120. <dt><span class="paramLabel">Parameters:</span></dt>
  1121. <dd><code>date</code> - the milliseconds.</dd>
  1122. <dt><span class="returnLabel">Returns:</span></dt>
  1123. <dd>The milliseconds.</dd>
  1124. </dl>
  1125. </li>
  1126. </ul>
  1127. <a name="containsDomainValue-long-">
  1128. <!-- -->
  1129. </a>
  1130. <ul class="blockList">
  1131. <li class="blockList">
  1132. <h4>containsDomainValue</h4>
  1133. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.735">containsDomainValue</a>(long&nbsp;millisecond)</pre>
  1134. <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
  1135. <dl>
  1136. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1137. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue-long-">containsDomainValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1138. <dt><span class="paramLabel">Parameters:</span></dt>
  1139. <dd><code>millisecond</code> - the value to verify.</dd>
  1140. <dt><span class="returnLabel">Returns:</span></dt>
  1141. <dd><code>true</code> if value is contained in the timeline.</dd>
  1142. </dl>
  1143. </li>
  1144. </ul>
  1145. <a name="containsDomainValue-java.util.Date-">
  1146. <!-- -->
  1147. </a>
  1148. <ul class="blockList">
  1149. <li class="blockList">
  1150. <h4>containsDomainValue</h4>
  1151. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.748">containsDomainValue</a>(java.util.Date&nbsp;date)</pre>
  1152. <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
  1153. <dl>
  1154. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1155. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue-java.util.Date-">containsDomainValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1156. <dt><span class="paramLabel">Parameters:</span></dt>
  1157. <dd><code>date</code> - date to verify</dd>
  1158. <dt><span class="returnLabel">Returns:</span></dt>
  1159. <dd><code>true</code> if value is contained in the timeline</dd>
  1160. </dl>
  1161. </li>
  1162. </ul>
  1163. <a name="containsDomainRange-long-long-">
  1164. <!-- -->
  1165. </a>
  1166. <ul class="blockList">
  1167. <li class="blockList">
  1168. <h4>containsDomainRange</h4>
  1169. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.763">containsDomainRange</a>(long&nbsp;domainValueStart,
  1170. long&nbsp;domainValueEnd)</pre>
  1171. <div class="block">Returns <code>true</code> if a range of values are contained in the
  1172. timeline. This is implemented verifying that all segments are in the
  1173. range.</div>
  1174. <dl>
  1175. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1176. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange-long-long-">containsDomainRange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1177. <dt><span class="paramLabel">Parameters:</span></dt>
  1178. <dd><code>domainValueStart</code> - start of the range to verify</dd>
  1179. <dd><code>domainValueEnd</code> - end of the range to verify</dd>
  1180. <dt><span class="returnLabel">Returns:</span></dt>
  1181. <dd><code>true</code> if the range is contained in the timeline</dd>
  1182. </dl>
  1183. </li>
  1184. </ul>
  1185. <a name="containsDomainRange-java.util.Date-java.util.Date-">
  1186. <!-- -->
  1187. </a>
  1188. <ul class="blockList">
  1189. <li class="blockList">
  1190. <h4>containsDomainRange</h4>
  1191. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.796">containsDomainRange</a>(java.util.Date&nbsp;dateDomainValueStart,
  1192. java.util.Date&nbsp;dateDomainValueEnd)</pre>
  1193. <div class="block">Returns <code>true</code> if a range of values are contained in the
  1194. timeline. This is implemented verifying that all segments are in the
  1195. range.</div>
  1196. <dl>
  1197. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1198. <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange-java.util.Date-java.util.Date-">containsDomainRange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
  1199. <dt><span class="paramLabel">Parameters:</span></dt>
  1200. <dd><code>dateDomainValueStart</code> - start of the range to verify</dd>
  1201. <dd><code>dateDomainValueEnd</code> - end of the range to verify</dd>
  1202. <dt><span class="returnLabel">Returns:</span></dt>
  1203. <dd><code>true</code> if the range is contained in the timeline</dd>
  1204. </dl>
  1205. </li>
  1206. </ul>
  1207. <a name="addException-long-">
  1208. <!-- -->
  1209. </a>
  1210. <ul class="blockList">
  1211. <li class="blockList">
  1212. <h4>addException</h4>
  1213. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.814">addException</a>(long&nbsp;millisecond)</pre>
  1214. <div class="block">Adds a segment as an exception. An exception segment is defined as a
  1215. segment to exclude from what would otherwise be considered a valid
  1216. segment of the timeline. An exception segment can not be contained
  1217. inside an already excluded segment. If so, no action will occur (the
  1218. proposed exception segment will be discarded).
  1219. <p>
  1220. The segment is identified by a domainValue into any part of the segment.
  1221. Therefore the segmentStart &lt;= domainValue &lt;= segmentEnd.</div>
  1222. <dl>
  1223. <dt><span class="paramLabel">Parameters:</span></dt>
  1224. <dd><code>millisecond</code> - domain value to treat as an exception</dd>
  1225. </dl>
  1226. </li>
  1227. </ul>
  1228. <a name="addException-long-long-">
  1229. <!-- -->
  1230. </a>
  1231. <ul class="blockList">
  1232. <li class="blockList">
  1233. <h4>addException</h4>
  1234. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.833">addException</a>(long&nbsp;fromDomainValue,
  1235. long&nbsp;toDomainValue)</pre>
  1236. <div class="block">Adds a segment range as an exception. An exception segment is defined as
  1237. a segment to exclude from what would otherwise be considered a valid
  1238. segment of the timeline. An exception segment can not be contained
  1239. inside an already excluded segment. If so, no action will occur (the
  1240. proposed exception segment will be discarded).
  1241. <p>
  1242. The segment range is identified by a domainValue that begins a valid
  1243. segment and ends with a domainValue that ends a valid segment.
  1244. Therefore the range will contain all segments whose segmentStart
  1245. &lt;= domainValue and segmentEnd &lt;= toDomainValue.</div>
  1246. <dl>
  1247. <dt><span class="paramLabel">Parameters:</span></dt>
  1248. <dd><code>fromDomainValue</code> - start of domain range to treat as an exception</dd>
  1249. <dd><code>toDomainValue</code> - end of domain range to treat as an exception</dd>
  1250. </dl>
  1251. </li>
  1252. </ul>
  1253. <a name="addException-java.util.Date-">
  1254. <!-- -->
  1255. </a>
  1256. <ul class="blockList">
  1257. <li class="blockList">
  1258. <h4>addException</h4>
  1259. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.848">addException</a>(java.util.Date&nbsp;exceptionDate)</pre>
  1260. <div class="block">Adds a segment as an exception. An exception segment is defined as a
  1261. segment to exclude from what would otherwise be considered a valid
  1262. segment of the timeline. An exception segment can not be contained
  1263. inside an already excluded segment. If so, no action will occur (the
  1264. proposed exception segment will be discarded).
  1265. <p>
  1266. The segment is identified by a Date into any part of the segment.</div>
  1267. <dl>
  1268. <dt><span class="paramLabel">Parameters:</span></dt>
  1269. <dd><code>exceptionDate</code> - Date into the segment to exclude.</dd>
  1270. </dl>
  1271. </li>
  1272. </ul>
  1273. <a name="addExceptions-java.util.List-">
  1274. <!-- -->
  1275. </a>
  1276. <ul class="blockList">
  1277. <li class="blockList">
  1278. <h4>addExceptions</h4>
  1279. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.865">addExceptions</a>(java.util.List&nbsp;exceptionList)</pre>
  1280. <div class="block">Adds a list of dates as segment exceptions. Each exception segment is
  1281. defined as a segment to exclude from what would otherwise be considered
  1282. a valid segment of the timeline. An exception segment can not be
  1283. contained inside an already excluded segment. If so, no action will
  1284. occur (the proposed exception segment will be discarded).
  1285. <p>
  1286. The segment is identified by a Date into any part of the segment.</div>
  1287. <dl>
  1288. <dt><span class="paramLabel">Parameters:</span></dt>
  1289. <dd><code>exceptionList</code> - List of Date objects that identify the segments to
  1290. exclude.</dd>
  1291. </dl>
  1292. </li>
  1293. </ul>
  1294. <a name="addBaseTimelineException-long-">
  1295. <!-- -->
  1296. </a>
  1297. <ul class="blockList">
  1298. <li class="blockList">
  1299. <h4>addBaseTimelineException</h4>
  1300. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.904">addBaseTimelineException</a>(long&nbsp;domainValue)</pre>
  1301. <div class="block">Adds a segment relative to the baseTimeline as an exception. Because a
  1302. base segment is normally larger than our segments, this may add one or
  1303. more segment ranges to the exception list.
  1304. <p>
  1305. An exception segment is defined as a segment
  1306. to exclude from what would otherwise be considered a valid segment of
  1307. the timeline. An exception segment can not be contained inside an
  1308. already excluded segment. If so, no action will occur (the proposed
  1309. exception segment will be discarded).
  1310. <p>
  1311. The segment is identified by a domainValue into any part of the
  1312. baseTimeline segment.</div>
  1313. <dl>
  1314. <dt><span class="paramLabel">Parameters:</span></dt>
  1315. <dd><code>domainValue</code> - domain value to teat as a baseTimeline exception.</dd>
  1316. </dl>
  1317. </li>
  1318. </ul>
  1319. <a name="addBaseTimelineException-java.util.Date-">
  1320. <!-- -->
  1321. </a>
  1322. <ul class="blockList">
  1323. <li class="blockList">
  1324. <h4>addBaseTimelineException</h4>
  1325. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.948">addBaseTimelineException</a>(java.util.Date&nbsp;date)</pre>
  1326. <div class="block">Adds a segment relative to the baseTimeline as an exception. An
  1327. exception segment is defined as a segment to exclude from what would
  1328. otherwise be considered a valid segment of the timeline. An exception
  1329. segment can not be contained inside an already excluded segment. If so,
  1330. no action will occure (the proposed exception segment will be discarded).
  1331. <p>
  1332. The segment is identified by a domainValue into any part of the segment.
  1333. Therefore the segmentStart &lt;= domainValue &lt;= segmentEnd.</div>
  1334. <dl>
  1335. <dt><span class="paramLabel">Parameters:</span></dt>
  1336. <dd><code>date</code> - date domain value to treat as a baseTimeline exception</dd>
  1337. </dl>
  1338. </li>
  1339. </ul>
  1340. <a name="addBaseTimelineExclusions-long-long-">
  1341. <!-- -->
  1342. </a>
  1343. <ul class="blockList">
  1344. <li class="blockList">
  1345. <h4>addBaseTimelineExclusions</h4>
  1346. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.961">addBaseTimelineExclusions</a>(long&nbsp;fromBaseDomainValue,
  1347. long&nbsp;toBaseDomainValue)</pre>
  1348. <div class="block">Adds all excluded segments from the BaseTimeline as exceptions to our
  1349. timeline. This allows us to combine two timelines for more complex
  1350. calculations.</div>
  1351. <dl>
  1352. <dt><span class="paramLabel">Parameters:</span></dt>
  1353. <dd><code>fromBaseDomainValue</code> - Start of the range where exclusions will be
  1354. extracted.</dd>
  1355. <dd><code>toBaseDomainValue</code> - End of the range to process.</dd>
  1356. </dl>
  1357. </li>
  1358. </ul>
  1359. <a name="getExceptionSegmentCount-long-long-">
  1360. <!-- -->
  1361. </a>
  1362. <ul class="blockList">
  1363. <li class="blockList">
  1364. <h4>getExceptionSegmentCount</h4>
  1365. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1019">getExceptionSegmentCount</a>(long&nbsp;fromMillisecond,
  1366. long&nbsp;toMillisecond)</pre>
  1367. <div class="block">Returns the number of exception segments wholly contained in the
  1368. (fromDomainValue, toDomainValue) interval.</div>
  1369. <dl>
  1370. <dt><span class="paramLabel">Parameters:</span></dt>
  1371. <dd><code>fromMillisecond</code> - the beginning of the interval.</dd>
  1372. <dd><code>toMillisecond</code> - the end of the interval.</dd>
  1373. <dt><span class="returnLabel">Returns:</span></dt>
  1374. <dd>Number of exception segments contained in the interval.</dd>
  1375. </dl>
  1376. </li>
  1377. </ul>
  1378. <a name="getSegment-long-">
  1379. <!-- -->
  1380. </a>
  1381. <ul class="blockList">
  1382. <li class="blockList">
  1383. <h4>getSegment</h4>
  1384. <pre>public&nbsp;<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1050">getSegment</a>(long&nbsp;millisecond)</pre>
  1385. <div class="block">Returns a segment that contains a domainValue. If the domainValue is
  1386. not contained in the timeline (because it is not contained in the
  1387. baseTimeline), a Segment that contains
  1388. <code>index + segmentSize*m</code> will be returned for the smallest
  1389. <code>m</code> possible.</div>
  1390. <dl>
  1391. <dt><span class="paramLabel">Parameters:</span></dt>
  1392. <dd><code>millisecond</code> - index into the segment</dd>
  1393. <dt><span class="returnLabel">Returns:</span></dt>
  1394. <dd>A Segment that contains index, or the next possible Segment.</dd>
  1395. </dl>
  1396. </li>
  1397. </ul>
  1398. <a name="getSegment-java.util.Date-">
  1399. <!-- -->
  1400. </a>
  1401. <ul class="blockList">
  1402. <li class="blockList">
  1403. <h4>getSegment</h4>
  1404. <pre>public&nbsp;<a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a>&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1068">getSegment</a>(java.util.Date&nbsp;date)</pre>
  1405. <div class="block">Returns a segment that contains a date. For accurate calculations,
  1406. the calendar should use TIME_ZONE for its calculation (or any other
  1407. similar time zone).
  1408. If the date is not contained in the timeline (because it is not
  1409. contained in the baseTimeline), a Segment that contains
  1410. <code>date + segmentSize*m</code> will be returned for the smallest
  1411. <code>m</code> possible.</div>
  1412. <dl>
  1413. <dt><span class="paramLabel">Parameters:</span></dt>
  1414. <dd><code>date</code> - date into the segment</dd>
  1415. <dt><span class="returnLabel">Returns:</span></dt>
  1416. <dd>A Segment that contains date, or the next possible Segment.</dd>
  1417. </dl>
  1418. </li>
  1419. </ul>
  1420. <a name="equals-java.lang.Object-">
  1421. <!-- -->
  1422. </a>
  1423. <ul class="blockList">
  1424. <li class="blockList">
  1425. <h4>equals</h4>
  1426. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1094">equals</a>(java.lang.Object&nbsp;o)</pre>
  1427. <div class="block">Returns true if we are equal to the parameter</div>
  1428. <dl>
  1429. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  1430. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  1431. <dt><span class="paramLabel">Parameters:</span></dt>
  1432. <dd><code>o</code> - Object to verify with us</dd>
  1433. <dt><span class="returnLabel">Returns:</span></dt>
  1434. <dd><code>true</code> or <code>false</code></dd>
  1435. </dl>
  1436. </li>
  1437. </ul>
  1438. <a name="hashCode--">
  1439. <!-- -->
  1440. </a>
  1441. <ul class="blockList">
  1442. <li class="blockList">
  1443. <h4>hashCode</h4>
  1444. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1117">hashCode</a>()</pre>
  1445. <div class="block">Returns a hash code for this object.</div>
  1446. <dl>
  1447. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  1448. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  1449. <dt><span class="returnLabel">Returns:</span></dt>
  1450. <dd>A hash code.</dd>
  1451. </dl>
  1452. </li>
  1453. </ul>
  1454. <a name="getTime-java.util.Date-">
  1455. <!-- -->
  1456. </a>
  1457. <ul class="blockList">
  1458. <li class="blockList">
  1459. <h4>getTime</h4>
  1460. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1176">getTime</a>(java.util.Date&nbsp;date)</pre>
  1461. <div class="block">Special method that handles conversion between the Default Time Zone and
  1462. a UTC time zone with no DST. This is needed so all days have the same
  1463. size. This method is the prefered way of converting a Data into
  1464. milliseconds for usage in this class.</div>
  1465. <dl>
  1466. <dt><span class="paramLabel">Parameters:</span></dt>
  1467. <dd><code>date</code> - Date to convert to long.</dd>
  1468. <dt><span class="returnLabel">Returns:</span></dt>
  1469. <dd>The milliseconds.</dd>
  1470. </dl>
  1471. </li>
  1472. </ul>
  1473. <a name="getDate-long-">
  1474. <!-- -->
  1475. </a>
  1476. <ul class="blockList">
  1477. <li class="blockList">
  1478. <h4>getDate</h4>
  1479. <pre>public&nbsp;java.util.Date&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1203">getDate</a>(long&nbsp;value)</pre>
  1480. <div class="block">Converts a millisecond value into a <code>Date</code> object.</div>
  1481. <dl>
  1482. <dt><span class="paramLabel">Parameters:</span></dt>
  1483. <dd><code>value</code> - the millisecond value.</dd>
  1484. <dt><span class="returnLabel">Returns:</span></dt>
  1485. <dd>The date.</dd>
  1486. </dl>
  1487. </li>
  1488. </ul>
  1489. <a name="clone--">
  1490. <!-- -->
  1491. </a>
  1492. <ul class="blockListLast">
  1493. <li class="blockList">
  1494. <h4>clone</h4>
  1495. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1216">clone</a>()
  1496. throws java.lang.CloneNotSupportedException</pre>
  1497. <div class="block">Returns a clone of the timeline.</div>
  1498. <dl>
  1499. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  1500. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  1501. <dt><span class="returnLabel">Returns:</span></dt>
  1502. <dd>A clone.</dd>
  1503. <dt><span class="throwsLabel">Throws:</span></dt>
  1504. <dd><code>java.lang.CloneNotSupportedException</code> - ??.</dd>
  1505. </dl>
  1506. </li>
  1507. </ul>
  1508. </li>
  1509. </ul>
  1510. </li>
  1511. </ul>
  1512. </div>
  1513. </div>
  1514. <!-- ========= END OF CLASS DATA ========= -->
  1515. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  1516. <div class="bottomNav"><a name="navbar.bottom">
  1517. <!-- -->
  1518. </a>
  1519. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  1520. <a name="navbar.bottom.firstrow">
  1521. <!-- -->
  1522. </a>
  1523. <ul class="navList" title="Navigation">
  1524. <li><a href="../../../../overview-summary.html">Overview</a></li>
  1525. <li><a href="package-summary.html">Package</a></li>
  1526. <li class="navBarCell1Rev">Class</li>
  1527. <li><a href="class-use/SegmentedTimeline.html">Use</a></li>
  1528. <li><a href="package-tree.html">Tree</a></li>
  1529. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  1530. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  1531. <li><a href="../../../../help-doc.html">Help</a></li>
  1532. </ul>
  1533. </div>
  1534. <div class="subNav">
  1535. <ul class="navList">
  1536. <li><a href="../../../../org/jfree/chart/axis/QuarterDateFormat.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  1537. <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  1538. </ul>
  1539. <ul class="navList">
  1540. <li><a href="../../../../index.html?org/jfree/chart/axis/SegmentedTimeline.html" target="_top">Frames</a></li>
  1541. <li><a href="SegmentedTimeline.html" target="_top">No&nbsp;Frames</a></li>
  1542. </ul>
  1543. <ul class="navList" id="allclasses_navbar_bottom">
  1544. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  1545. </ul>
  1546. <div>
  1547. <script type="text/javascript"><!--
  1548. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  1549. if(window==top) {
  1550. allClassesLink.style.display = "block";
  1551. }
  1552. else {
  1553. allClassesLink.style.display = "none";
  1554. }
  1555. //-->
  1556. </script>
  1557. </div>
  1558. <div>
  1559. <ul class="subNavList">
  1560. <li>Summary:&nbsp;</li>
  1561. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  1562. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  1563. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  1564. <li><a href="#method.summary">Method</a></li>
  1565. </ul>
  1566. <ul class="subNavList">
  1567. <li>Detail:&nbsp;</li>
  1568. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  1569. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  1570. <li><a href="#method.detail">Method</a></li>
  1571. </ul>
  1572. </div>
  1573. <a name="skip.navbar.bottom">
  1574. <!-- -->
  1575. </a></div>
  1576. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  1577. </body>
  1578. </html>