12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:28 CEST 2014 -->
- <title>SegmentedTimeline (JFreeChart Class Library (version 1.0.19-fx))</title>
- <meta name="date" content="2014-07-31">
- <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="SegmentedTimeline (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- 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};
- var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/SegmentedTimeline.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/chart/axis/QuarterDateFormat.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/axis/SegmentedTimeline.html" target="_top">Frames</a></li>
- <li><a href="SegmentedTimeline.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li><a href="#nested.class.summary">Nested</a> | </li>
- <li><a href="#field.summary">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.jfree.chart.axis</div>
- <h2 title="Class SegmentedTimeline" class="title">Class SegmentedTimeline</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>org.jfree.chart.axis.SegmentedTimeline</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <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>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.154">SegmentedTimeline</a>
- extends java.lang.Object
- 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>
- <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,
- excluded and exception segments.
- <p>A Timeline will present a series of values to be used for an axis. Each
- Timeline must provide transformation methods between domain values and
- timeline values.</p>
- <p>A timeline can be used as parameter to a
- <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
- supports. This class implements a timeline formed by segments of equal
- length (ex. days, hours, minutes) where some segments can be included in the
- timeline and others excluded. Therefore timelines like "working days" or
- "working hours" can be created where non-working days or non-working hours
- respectively can be removed from the timeline, and therefore from the axis.
- This creates a smooth plot with equal separation between all included
- segments.</p>
- <p>Because Timelines were created mainly for Date related axis, values are
- represented as longs instead of doubles. In this case, the domain value is
- just the number of milliseconds since January 1, 1970, 00:00:00 GMT as
- defined by the getTime() method of <code>Date</code>.</p>
- <p>In this class, a segment is defined as a unit of time of fixed length.
- Examples of segments are: days, hours, minutes, etc. The size of a segment
- is defined as the number of milliseconds in the segment. Some useful segment
- sizes are defined as constants in this class: DAY_SEGMENT_SIZE,
- HOUR_SEGMENT_SIZE, FIFTEEN_MINUTE_SEGMENT_SIZE and MINUTE_SEGMENT_SIZE.</p>
- <p>Segments are group together to form a Segment Group. Each Segment Group will
- contain a number of Segments included and a number of Segments excluded. This
- Segment Group structure will repeat for the whole timeline.</p>
- <p>For example, a working days SegmentedTimeline would be formed by a group of
- 7 daily segments, where there are 5 included (Monday through Friday) and 2
- excluded (Saturday and Sunday) segments.</p>
- <p>Following is a diagram that explains the major attributes that define a
- segment. Each box is one segment and must be of fixed length (ms, second,
- hour, day, etc).</p>
- <pre>
- start time
- |
- v
- 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ...
- +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+...
- | | | | | |EE|EE| | | | | |EE|EE| | | | | |EE|EE|
- +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+...
- \____________/ \___/ \_/
- \/ | |
- included excluded segment
- segments segments size
- \_________ _______/
- \/
- segment group
- </pre>
- Legend:<br>
- <space> = Included segment<br>
- EE = Excluded segments in the base timeline<br>
- <p>In the example, the following segment attributes are presented:</p>
- <ul>
- <li>segment size: the size of each segment in ms.
- <li>start time: the start of the first segment of the first segment group to
- consider.
- <li>included segments: the number of segments to include in the group.
- <li>excluded segments: the number of segments to exclude in the group.
- </ul>
- <p>Exception Segments are allowed. These exception segments are defined as
- segments that would have been in the included segments of the Segment Group,
- but should be excluded for special reasons. In the previous working days
- SegmentedTimeline example, holidays would be considered exceptions.</p>
- <p>Additionally the <code>startTime</code>, or start of the first Segment of
- the smallest segment group needs to be defined. This startTime could be
- relative to January 1, 1970, 00:00:00 GMT or any other date. This creates a
- point of reference to start counting Segment Groups. For example, for the
- working days SegmentedTimeline, the <code>startTime</code> could be
- 00:00:00 GMT of the first Monday after January 1, 1970. In this class, the
- constant FIRST_MONDAY_AFTER_1900 refers to a reference point of the first
- Monday of the last century.</p>
- <p>A SegmentedTimeline can include a baseTimeline. This combination of
- timelines allows the creation of more complex timelines. For example, in
- order to implement a SegmentedTimeline for an intraday stock trading
- application, where the trading period is defined as 9:00 AM through 4:00 PM
- Monday through Friday, two SegmentedTimelines are used. The first one (the
- baseTimeline) would be a working day SegmentedTimeline (daily timeline
- Monday through Friday). On top of this baseTimeline, a second one is defined
- that maps the 9:00 AM to 4:00 PM period. Because the baseTimeline defines a
- timeline of Monday through Friday, the resulting (combined) timeline will
- expose the period 9:00 AM through 4:00 PM only on Monday through Friday,
- and will remove all other intermediate intervals.</p>
- <p>Two factory methods newMondayThroughFridayTimeline() and
- newFifteenMinuteTimeline() are provided as examples to create special
- SegmentedTimelines.</p></div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/axis/DateAxis.html" title="class in org.jfree.chart.axis"><code>DateAxis</code></a>,
- <a href="../../../../serialized-form.html#org.jfree.chart.axis.SegmentedTimeline">Serialized Form</a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="nested.class.summary">
- <!-- -->
- </a>
- <h3>Nested Class Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
- <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Class and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected class </code></td>
- <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>
- <div class="block">Special <code>SegmentRange</code> that came from the BaseTimeline.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>class </code></td>
- <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>
- <div class="block">Internal class to represent a valid segment for this timeline.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected class </code></td>
- <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>
- <div class="block">Private internal class to represent a range of segments.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- =========== FIELD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.summary">
- <!-- -->
- </a>
- <h3>Field Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
- <caption><span>Fields</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Field and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#DAY_SEGMENT_SIZE">DAY_SEGMENT_SIZE</a></span></code>
- <div class="block">Defines a day segment size in ms.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>static java.util.TimeZone</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#DEFAULT_TIME_ZONE">DEFAULT_TIME_ZONE</a></span></code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">As of 1.0.7. When the default time zone is required,
- just call <code>TimeZone.getDefault()</code>.</span></div>
- </div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static long</code></td>
- <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>
- <div class="block">Defines a 15-minute segment size in ms.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>static long</code></td>
- <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>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">As of 1.0.7. This field doesn't take into account changes
- to the default time zone.</span></div>
- </div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#HOUR_SEGMENT_SIZE">HOUR_SEGMENT_SIZE</a></span></code>
- <div class="block">Defines a one hour segment size in ms.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>static long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#MINUTE_SEGMENT_SIZE">MINUTE_SEGMENT_SIZE</a></span></code>
- <div class="block">Defines a one-minute segment size in ms.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static java.util.TimeZone</code></td>
- <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>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">As of 1.0.7. This field is initialised based on the
- default time zone, and doesn't take into account subsequent
- changes to the default.</span></div>
- </div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#SegmentedTimeline-long-int-int-">SegmentedTimeline</a></span>(long segmentSize,
- int segmentsIncluded,
- int segmentsExcluded)</code>
- <div class="block">Constructs a new segmented timeline, optionaly using another segmented
- timeline as its base.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <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 date)</code>
- <div class="block">Adds a segment relative to the baseTimeline as an exception.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addBaseTimelineException-long-">addBaseTimelineException</a></span>(long domainValue)</code>
- <div class="block">Adds a segment relative to the baseTimeline as an exception.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addBaseTimelineExclusions-long-long-">addBaseTimelineExclusions</a></span>(long fromBaseDomainValue,
- long toBaseDomainValue)</code>
- <div class="block">Adds all excluded segments from the BaseTimeline as exceptions to our
- timeline.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <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 exceptionDate)</code>
- <div class="block">Adds a segment as an exception.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addException-long-">addException</a></span>(long millisecond)</code>
- <div class="block">Adds a segment as an exception.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#addException-long-long-">addException</a></span>(long fromDomainValue,
- long toDomainValue)</code>
- <div class="block">Adds a segment range as an exception.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <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 exceptionList)</code>
- <div class="block">Adds a list of dates as segment exceptions.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>java.lang.Object</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#clone--">clone</a></span>()</code>
- <div class="block">Returns a clone of the timeline.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <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 dateDomainValueStart,
- java.util.Date dateDomainValueEnd)</code>
- <div class="block">Returns <code>true</code> if a range of values are contained in the
- timeline.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#containsDomainRange-long-long-">containsDomainRange</a></span>(long domainValueStart,
- long domainValueEnd)</code>
- <div class="block">Returns <code>true</code> if a range of values are contained in the
- timeline.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <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 date)</code>
- <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#containsDomainValue-long-">containsDomainValue</a></span>(long millisecond)</code>
- <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <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 o)</code>
- <div class="block">Returns true if we are equal to the parameter</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code>static long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#firstMondayAfter1900--">firstMondayAfter1900</a></span>()</code>
- <div class="block">Returns the milliseconds for midnight of the first Monday after
- 1-Jan-1900, ignoring daylight savings.</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getAdjustForDaylightSaving--">getAdjustForDaylightSaving</a></span>()</code>
- <div class="block">Returns the flag that controls whether or not the daylight saving
- adjustment is applied.</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getBaseTimeline--">getBaseTimeline</a></span>()</code>
- <div class="block">Returns our baseTimeline, or <code>null</code> if none.</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code>java.util.Date</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getDate-long-">getDate</a></span>(long value)</code>
- <div class="block">Converts a millisecond value into a <code>Date</code> object.</div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getExceptionSegmentCount-long-long-">getExceptionSegmentCount</a></span>(long fromMillisecond,
- long toMillisecond)</code>
- <div class="block">Returns the number of exception segments wholly contained in the
- (fromDomainValue, toDomainValue) interval.</div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code>java.util.List</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getExceptionSegments--">getExceptionSegments</a></span>()</code>
- <div class="block">Returns a list of all the exception segments.</div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getGroupSegmentCount--">getGroupSegmentCount</a></span>()</code>
- <div class="block">Returns the number of segments in a segment group.</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <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>
- <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 date)</code>
- <div class="block">Returns a segment that contains a date.</div>
- </td>
- </tr>
- <tr id="i21" class="rowColor">
- <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>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegment-long-">getSegment</a></span>(long millisecond)</code>
- <div class="block">Returns a segment that contains a domainValue.</div>
- </td>
- </tr>
- <tr id="i22" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsExcluded--">getSegmentsExcluded</a></span>()</code>
- <div class="block">Returns the number of segments excluded per segment group.</div>
- </td>
- </tr>
- <tr id="i23" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsExcludedSize--">getSegmentsExcludedSize</a></span>()</code>
- <div class="block">Returns the size in milliseconds of the segments excluded per segment
- group.</div>
- </td>
- </tr>
- <tr id="i24" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsGroupSize--">getSegmentsGroupSize</a></span>()</code>
- <div class="block">Returns the size in milliseconds of a segment group.</div>
- </td>
- </tr>
- <tr id="i25" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsIncluded--">getSegmentsIncluded</a></span>()</code>
- <div class="block">Returns the number of segments included per segment group.</div>
- </td>
- </tr>
- <tr id="i26" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentsIncludedSize--">getSegmentsIncludedSize</a></span>()</code>
- <div class="block">Returns the size in ms of the segments included per segment group.</div>
- </td>
- </tr>
- <tr id="i27" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getSegmentSize--">getSegmentSize</a></span>()</code>
- <div class="block">Returns the size of one segment in ms.</div>
- </td>
- </tr>
- <tr id="i28" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getStartTime--">getStartTime</a></span>()</code>
- <div class="block">Returns the start time for the timeline.</div>
- </td>
- </tr>
- <tr id="i29" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <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 date)</code>
- <div class="block">Special method that handles conversion between the Default Time Zone and
- a UTC time zone with no DST.</div>
- </td>
- </tr>
- <tr id="i30" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#getTimeFromLong-long-">getTimeFromLong</a></span>(long date)</code>
- <div class="block">Converts a date/time value to take account of daylight savings time.</div>
- </td>
- </tr>
- <tr id="i31" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#hashCode--">hashCode</a></span>()</code>
- <div class="block">Returns a hash code for this object.</div>
- </td>
- </tr>
- <tr id="i32" class="altColor">
- <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#newFifteenMinuteTimeline--">newFifteenMinuteTimeline</a></span>()</code>
- <div class="block">Factory method to create a 15-min, 9:00 AM thought 4:00 PM, Monday
- through Friday SegmentedTimeline.</div>
- </td>
- </tr>
- <tr id="i33" class="rowColor">
- <td class="colFirst"><code>static <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#newMondayThroughFridayTimeline--">newMondayThroughFridayTimeline</a></span>()</code>
- <div class="block">Factory method to create a Monday through Friday SegmentedTimeline.</div>
- </td>
- </tr>
- <tr id="i34" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#setAdjustForDaylightSaving-boolean-">setAdjustForDaylightSaving</a></span>(boolean adjust)</code>
- <div class="block">Sets the flag that controls whether or not the daylight saving adjustment
- is applied.</div>
- </td>
- </tr>
- <tr id="i35" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <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> baseTimeline)</code>
- <div class="block">Sets the base timeline.</div>
- </td>
- </tr>
- <tr id="i36" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <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 exceptionSegments)</code>
- <div class="block">Sets the exception segments list.</div>
- </td>
- </tr>
- <tr id="i37" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#setStartTime-long-">setStartTime</a></span>(long millisecond)</code>
- <div class="block">Sets the start time for the timeline.</div>
- </td>
- </tr>
- <tr id="i38" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#toMillisecond-long-">toMillisecond</a></span>(long timelineValue)</code>
- <div class="block">Translates a value relative to the timeline into a millisecond.</div>
- </td>
- </tr>
- <tr id="i39" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <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 date)</code>
- <div class="block">Translates a date into a value relative to the segmented timeline.</div>
- </td>
- </tr>
- <tr id="i40" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html#toTimelineValue-long-">toTimelineValue</a></span>(long millisecond)</code>
- <div class="block">Translates a value relative to the domain value (all Dates) into a value
- relative to the segmented timeline.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ FIELD DETAIL =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.detail">
- <!-- -->
- </a>
- <h3>Field Detail</h3>
- <a name="DAY_SEGMENT_SIZE">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>DAY_SEGMENT_SIZE</h4>
- <pre>public static final long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.164">DAY_SEGMENT_SIZE</a></pre>
- <div class="block">Defines a day segment size in ms.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.DAY_SEGMENT_SIZE">Constant Field Values</a></dd>
- </dl>
- </li>
- </ul>
- <a name="HOUR_SEGMENT_SIZE">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>HOUR_SEGMENT_SIZE</h4>
- <pre>public static final long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.167">HOUR_SEGMENT_SIZE</a></pre>
- <div class="block">Defines a one hour segment size in ms.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.HOUR_SEGMENT_SIZE">Constant Field Values</a></dd>
- </dl>
- </li>
- </ul>
- <a name="FIFTEEN_MINUTE_SEGMENT_SIZE">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FIFTEEN_MINUTE_SEGMENT_SIZE</h4>
- <pre>public static final long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.170">FIFTEEN_MINUTE_SEGMENT_SIZE</a></pre>
- <div class="block">Defines a 15-minute segment size in ms.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.FIFTEEN_MINUTE_SEGMENT_SIZE">Constant Field Values</a></dd>
- </dl>
- </li>
- </ul>
- <a name="MINUTE_SEGMENT_SIZE">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>MINUTE_SEGMENT_SIZE</h4>
- <pre>public static final long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.173">MINUTE_SEGMENT_SIZE</a></pre>
- <div class="block">Defines a one-minute segment size in ms.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../constant-values.html#org.jfree.chart.axis.SegmentedTimeline.MINUTE_SEGMENT_SIZE">Constant Field Values</a></dd>
- </dl>
- </li>
- </ul>
- <a name="FIRST_MONDAY_AFTER_1900">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FIRST_MONDAY_AFTER_1900</h4>
- <pre>public static long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.188">FIRST_MONDAY_AFTER_1900</a></pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of 1.0.7. This field doesn't take into account changes
- to the default time zone.</span></div>
- <div class="block">Utility constant that defines the startTime as the first monday after
- 1/1/1970. This should be used when creating a SegmentedTimeline for
- Monday through Friday. See static block below for calculation of this
- constant.</div>
- </li>
- </ul>
- <a name="NO_DST_TIME_ZONE">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>NO_DST_TIME_ZONE</h4>
- <pre>public static java.util.TimeZone <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.199">NO_DST_TIME_ZONE</a></pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of 1.0.7. This field is initialised based on the
- default time zone, and doesn't take into account subsequent
- changes to the default.</span></div>
- <div class="block">Utility TimeZone object that has no DST and an offset equal to the
- default TimeZone. This allows easy arithmetic between days as each one
- will have equal size.</div>
- </li>
- </ul>
- <a name="DEFAULT_TIME_ZONE">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>DEFAULT_TIME_ZONE</h4>
- <pre>public static java.util.TimeZone <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.210">DEFAULT_TIME_ZONE</a></pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of 1.0.7. When the default time zone is required,
- just call <code>TimeZone.getDefault()</code>.</span></div>
- <div class="block">This is the default time zone where the application is running. See
- getTime() below where we make use of certain transformations between
- times in the default time zone and the no-dst time zone used for our
- calculations.</div>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="SegmentedTimeline-long-int-int-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>SegmentedTimeline</h4>
- <pre>public <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.314">SegmentedTimeline</a>(long segmentSize,
- int segmentsIncluded,
- int segmentsExcluded)</pre>
- <div class="block">Constructs a new segmented timeline, optionaly using another segmented
- timeline as its base. This chaining of SegmentedTimelines allows further
- segmentation into smaller timelines.
- If a base</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>segmentSize</code> - the size of a segment in ms. This time unit will be
- used to compute the included and excluded segments of the
- timeline.</dd>
- <dd><code>segmentsIncluded</code> - Number of consecutive segments to include.</dd>
- <dd><code>segmentsExcluded</code> - Number of consecutive segments to exclude.</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="firstMondayAfter1900--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>firstMondayAfter1900</h4>
- <pre>public static long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.341">firstMondayAfter1900</a>()</pre>
- <div class="block">Returns the milliseconds for midnight of the first Monday after
- 1-Jan-1900, ignoring daylight savings.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The milliseconds.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.7</dd>
- </dl>
- </li>
- </ul>
- <a name="newMondayThroughFridayTimeline--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>newMondayThroughFridayTimeline</h4>
- <pre>public static <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.366">newMondayThroughFridayTimeline</a>()</pre>
- <div class="block">Factory method to create a Monday through Friday SegmentedTimeline.
- <P>
- The <code>startTime</code> of the resulting timeline will be midnight
- of the first Monday after 1/1/1900.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A fully initialized SegmentedTimeline.</dd>
- </dl>
- </li>
- </ul>
- <a name="newFifteenMinuteTimeline--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>newFifteenMinuteTimeline</h4>
- <pre>public static <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.390">newFifteenMinuteTimeline</a>()</pre>
- <div class="block">Factory method to create a 15-min, 9:00 AM thought 4:00 PM, Monday
- through Friday SegmentedTimeline.
- <P>
- This timeline uses a segmentSize of FIFTEEN_MIN_SEGMENT_SIZE. The
- segment group is defined as 28 included segments (9:00 AM through
- 4:00 PM) and 68 excluded segments (4:00 PM through 9:00 AM the next day).
- <P>
- In order to exclude Saturdays and Sundays it uses a baseTimeline that
- only includes Monday through Friday days.
- <P>
- The <code>startTime</code> of the resulting timeline will be 9:00 AM
- after the startTime of the baseTimeline. This will correspond to 9:00 AM
- of the first Monday after 1/1/1900.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A fully initialized SegmentedTimeline.</dd>
- </dl>
- </li>
- </ul>
- <a name="getAdjustForDaylightSaving--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAdjustForDaylightSaving</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.405">getAdjustForDaylightSaving</a>()</pre>
- <div class="block">Returns the flag that controls whether or not the daylight saving
- adjustment is applied.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A boolean.</dd>
- </dl>
- </li>
- </ul>
- <a name="setAdjustForDaylightSaving-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setAdjustForDaylightSaving</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.415">setAdjustForDaylightSaving</a>(boolean adjust)</pre>
- <div class="block">Sets the flag that controls whether or not the daylight saving adjustment
- is applied.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>adjust</code> - the flag.</dd>
- </dl>
- </li>
- </ul>
- <a name="setStartTime-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setStartTime</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.429">setStartTime</a>(long millisecond)</pre>
- <div class="block">Sets the start time for the timeline. This is the beginning of segment
- zero.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millisecond</code> - the start time (encoded as in java.util.Date).</dd>
- </dl>
- </li>
- </ul>
- <a name="getStartTime--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getStartTime</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.439">getStartTime</a>()</pre>
- <div class="block">Returns the start time for the timeline. This is the beginning of
- segment zero.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The start time.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentsExcluded--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentsExcluded</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.448">getSegmentsExcluded</a>()</pre>
- <div class="block">Returns the number of segments excluded per segment group.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The number of segments excluded.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentsExcludedSize--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentsExcludedSize</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.458">getSegmentsExcludedSize</a>()</pre>
- <div class="block">Returns the size in milliseconds of the segments excluded per segment
- group.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The size in milliseconds.</dd>
- </dl>
- </li>
- </ul>
- <a name="getGroupSegmentCount--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getGroupSegmentCount</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.468">getGroupSegmentCount</a>()</pre>
- <div class="block">Returns the number of segments in a segment group. This will be equal to
- segments included plus segments excluded.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The number of segments.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentsGroupSize--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentsGroupSize</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.478">getSegmentsGroupSize</a>()</pre>
- <div class="block">Returns the size in milliseconds of a segment group. This will be equal
- to size of the segments included plus the size of the segments excluded.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment group size in milliseconds.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentsIncluded--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentsIncluded</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.487">getSegmentsIncluded</a>()</pre>
- <div class="block">Returns the number of segments included per segment group.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The number of segments.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentsIncludedSize--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentsIncludedSize</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.496">getSegmentsIncludedSize</a>()</pre>
- <div class="block">Returns the size in ms of the segments included per segment group.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment size in milliseconds.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegmentSize--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegmentSize</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.505">getSegmentSize</a>()</pre>
- <div class="block">Returns the size of one segment in ms.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The segment size in milliseconds.</dd>
- </dl>
- </li>
- </ul>
- <a name="getExceptionSegments--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getExceptionSegments</h4>
- <pre>public java.util.List <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.515">getExceptionSegments</a>()</pre>
- <div class="block">Returns a list of all the exception segments. This list is not
- modifiable.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The exception segments.</dd>
- </dl>
- </li>
- </ul>
- <a name="setExceptionSegments-java.util.List-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setExceptionSegments</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.524">setExceptionSegments</a>(java.util.List exceptionSegments)</pre>
- <div class="block">Sets the exception segments list.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>exceptionSegments</code> - the exception segments.</dd>
- </dl>
- </li>
- </ul>
- <a name="getBaseTimeline--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getBaseTimeline</h4>
- <pre>public <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis">SegmentedTimeline</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.533">getBaseTimeline</a>()</pre>
- <div class="block">Returns our baseTimeline, or <code>null</code> if none.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The base timeline.</dd>
- </dl>
- </li>
- </ul>
- <a name="setBaseTimeline-org.jfree.chart.axis.SegmentedTimeline-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setBaseTimeline</h4>
- <pre>public void <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> baseTimeline)</pre>
- <div class="block">Sets the base timeline.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>baseTimeline</code> - the timeline.</dd>
- </dl>
- </li>
- </ul>
- <a name="toTimelineValue-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>toTimelineValue</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.580">toTimelineValue</a>(long millisecond)</pre>
- <div class="block">Translates a value relative to the domain value (all Dates) into a value
- relative to the segmented timeline. The values relative to the segmented
- timeline are all consecutives starting at zero at the startTime.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue-long-">toTimelineValue</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millisecond</code> - the millisecond (as encoded by java.util.Date).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The timeline value.</dd>
- </dl>
- </li>
- </ul>
- <a name="toTimelineValue-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>toTimelineValue</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.644">toTimelineValue</a>(java.util.Date date)</pre>
- <div class="block">Translates a date into a value relative to the segmented timeline. The
- values relative to the segmented timeline are all consecutives starting
- at zero at the startTime.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#toTimelineValue-java.util.Date-">toTimelineValue</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>date</code> - date relative to the domain.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The timeline value (in milliseconds).</dd>
- </dl>
- </li>
- </ul>
- <a name="toMillisecond-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>toMillisecond</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.657">toMillisecond</a>(long timelineValue)</pre>
- <div class="block">Translates a value relative to the timeline into a millisecond.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#toMillisecond-long-">toMillisecond</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>timelineValue</code> - the timeline value (in milliseconds).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The domain value (in milliseconds).</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.html" title="class in org.jfree.chart.axis"><code>SegmentedTimeline</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getTimeFromLong-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getTimeFromLong</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.706">getTimeFromLong</a>(long date)</pre>
- <div class="block">Converts a date/time value to take account of daylight savings time.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>date</code> - the milliseconds.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The milliseconds.</dd>
- </dl>
- </li>
- </ul>
- <a name="containsDomainValue-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>containsDomainValue</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.735">containsDomainValue</a>(long millisecond)</pre>
- <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue-long-">containsDomainValue</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millisecond</code> - the value to verify.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if value is contained in the timeline.</dd>
- </dl>
- </li>
- </ul>
- <a name="containsDomainValue-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>containsDomainValue</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.748">containsDomainValue</a>(java.util.Date date)</pre>
- <div class="block">Returns <code>true</code> if a value is contained in the timeline.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainValue-java.util.Date-">containsDomainValue</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>date</code> - date to verify</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if value is contained in the timeline</dd>
- </dl>
- </li>
- </ul>
- <a name="containsDomainRange-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>containsDomainRange</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.763">containsDomainRange</a>(long domainValueStart,
- long domainValueEnd)</pre>
- <div class="block">Returns <code>true</code> if a range of values are contained in the
- timeline. This is implemented verifying that all segments are in the
- range.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange-long-long-">containsDomainRange</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>domainValueStart</code> - start of the range to verify</dd>
- <dd><code>domainValueEnd</code> - end of the range to verify</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if the range is contained in the timeline</dd>
- </dl>
- </li>
- </ul>
- <a name="containsDomainRange-java.util.Date-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>containsDomainRange</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.796">containsDomainRange</a>(java.util.Date dateDomainValueStart,
- java.util.Date dateDomainValueEnd)</pre>
- <div class="block">Returns <code>true</code> if a range of values are contained in the
- timeline. This is implemented verifying that all segments are in the
- range.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/chart/axis/Timeline.html#containsDomainRange-java.util.Date-java.util.Date-">containsDomainRange</a></code> in interface <code><a href="../../../../org/jfree/chart/axis/Timeline.html" title="interface in org.jfree.chart.axis">Timeline</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>dateDomainValueStart</code> - start of the range to verify</dd>
- <dd><code>dateDomainValueEnd</code> - end of the range to verify</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if the range is contained in the timeline</dd>
- </dl>
- </li>
- </ul>
- <a name="addException-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addException</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.814">addException</a>(long millisecond)</pre>
- <div class="block">Adds a segment as an exception. An exception segment is defined as a
- segment to exclude from what would otherwise be considered a valid
- segment of the timeline. An exception segment can not be contained
- inside an already excluded segment. If so, no action will occur (the
- proposed exception segment will be discarded).
- <p>
- The segment is identified by a domainValue into any part of the segment.
- Therefore the segmentStart <= domainValue <= segmentEnd.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millisecond</code> - domain value to treat as an exception</dd>
- </dl>
- </li>
- </ul>
- <a name="addException-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addException</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.833">addException</a>(long fromDomainValue,
- long toDomainValue)</pre>
- <div class="block">Adds a segment range as an exception. An exception segment is defined as
- a segment to exclude from what would otherwise be considered a valid
- segment of the timeline. An exception segment can not be contained
- inside an already excluded segment. If so, no action will occur (the
- proposed exception segment will be discarded).
- <p>
- The segment range is identified by a domainValue that begins a valid
- segment and ends with a domainValue that ends a valid segment.
- Therefore the range will contain all segments whose segmentStart
- <= domainValue and segmentEnd <= toDomainValue.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>fromDomainValue</code> - start of domain range to treat as an exception</dd>
- <dd><code>toDomainValue</code> - end of domain range to treat as an exception</dd>
- </dl>
- </li>
- </ul>
- <a name="addException-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addException</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.848">addException</a>(java.util.Date exceptionDate)</pre>
- <div class="block">Adds a segment as an exception. An exception segment is defined as a
- segment to exclude from what would otherwise be considered a valid
- segment of the timeline. An exception segment can not be contained
- inside an already excluded segment. If so, no action will occur (the
- proposed exception segment will be discarded).
- <p>
- The segment is identified by a Date into any part of the segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>exceptionDate</code> - Date into the segment to exclude.</dd>
- </dl>
- </li>
- </ul>
- <a name="addExceptions-java.util.List-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addExceptions</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.865">addExceptions</a>(java.util.List exceptionList)</pre>
- <div class="block">Adds a list of dates as segment exceptions. Each exception segment is
- defined as a segment to exclude from what would otherwise be considered
- a valid segment of the timeline. An exception segment can not be
- contained inside an already excluded segment. If so, no action will
- occur (the proposed exception segment will be discarded).
- <p>
- The segment is identified by a Date into any part of the segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>exceptionList</code> - List of Date objects that identify the segments to
- exclude.</dd>
- </dl>
- </li>
- </ul>
- <a name="addBaseTimelineException-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addBaseTimelineException</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.904">addBaseTimelineException</a>(long domainValue)</pre>
- <div class="block">Adds a segment relative to the baseTimeline as an exception. Because a
- base segment is normally larger than our segments, this may add one or
- more segment ranges to the exception list.
- <p>
- An exception segment is defined as a segment
- to exclude from what would otherwise be considered a valid segment of
- the timeline. An exception segment can not be contained inside an
- already excluded segment. If so, no action will occur (the proposed
- exception segment will be discarded).
- <p>
- The segment is identified by a domainValue into any part of the
- baseTimeline segment.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>domainValue</code> - domain value to teat as a baseTimeline exception.</dd>
- </dl>
- </li>
- </ul>
- <a name="addBaseTimelineException-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addBaseTimelineException</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.948">addBaseTimelineException</a>(java.util.Date date)</pre>
- <div class="block">Adds a segment relative to the baseTimeline as an exception. An
- exception segment is defined as a segment to exclude from what would
- otherwise be considered a valid segment of the timeline. An exception
- segment can not be contained inside an already excluded segment. If so,
- no action will occure (the proposed exception segment will be discarded).
- <p>
- The segment is identified by a domainValue into any part of the segment.
- Therefore the segmentStart <= domainValue <= segmentEnd.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>date</code> - date domain value to treat as a baseTimeline exception</dd>
- </dl>
- </li>
- </ul>
- <a name="addBaseTimelineExclusions-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addBaseTimelineExclusions</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.961">addBaseTimelineExclusions</a>(long fromBaseDomainValue,
- long toBaseDomainValue)</pre>
- <div class="block">Adds all excluded segments from the BaseTimeline as exceptions to our
- timeline. This allows us to combine two timelines for more complex
- calculations.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>fromBaseDomainValue</code> - Start of the range where exclusions will be
- extracted.</dd>
- <dd><code>toBaseDomainValue</code> - End of the range to process.</dd>
- </dl>
- </li>
- </ul>
- <a name="getExceptionSegmentCount-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getExceptionSegmentCount</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1019">getExceptionSegmentCount</a>(long fromMillisecond,
- long toMillisecond)</pre>
- <div class="block">Returns the number of exception segments wholly contained in the
- (fromDomainValue, toDomainValue) interval.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>fromMillisecond</code> - the beginning of the interval.</dd>
- <dd><code>toMillisecond</code> - the end of the interval.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>Number of exception segments contained in the interval.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegment-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegment</h4>
- <pre>public <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1050">getSegment</a>(long millisecond)</pre>
- <div class="block">Returns a segment that contains a domainValue. If the domainValue is
- not contained in the timeline (because it is not contained in the
- baseTimeline), a Segment that contains
- <code>index + segmentSize*m</code> will be returned for the smallest
- <code>m</code> possible.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>millisecond</code> - index into the segment</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A Segment that contains index, or the next possible Segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSegment-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSegment</h4>
- <pre>public <a href="../../../../org/jfree/chart/axis/SegmentedTimeline.Segment.html" title="class in org.jfree.chart.axis">SegmentedTimeline.Segment</a> <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1068">getSegment</a>(java.util.Date date)</pre>
- <div class="block">Returns a segment that contains a date. For accurate calculations,
- the calendar should use TIME_ZONE for its calculation (or any other
- similar time zone).
- If the date is not contained in the timeline (because it is not
- contained in the baseTimeline), a Segment that contains
- <code>date + segmentSize*m</code> will be returned for the smallest
- <code>m</code> possible.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>date</code> - date into the segment</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A Segment that contains date, or the next possible Segment.</dd>
- </dl>
- </li>
- </ul>
- <a name="equals-java.lang.Object-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>equals</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1094">equals</a>(java.lang.Object o)</pre>
- <div class="block">Returns true if we are equal to the parameter</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>o</code> - Object to verify with us</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> or <code>false</code></dd>
- </dl>
- </li>
- </ul>
- <a name="hashCode--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hashCode</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1117">hashCode</a>()</pre>
- <div class="block">Returns a hash code for this object.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A hash code.</dd>
- </dl>
- </li>
- </ul>
- <a name="getTime-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getTime</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1176">getTime</a>(java.util.Date date)</pre>
- <div class="block">Special method that handles conversion between the Default Time Zone and
- a UTC time zone with no DST. This is needed so all days have the same
- size. This method is the prefered way of converting a Data into
- milliseconds for usage in this class.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>date</code> - Date to convert to long.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The milliseconds.</dd>
- </dl>
- </li>
- </ul>
- <a name="getDate-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDate</h4>
- <pre>public java.util.Date <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1203">getDate</a>(long value)</pre>
- <div class="block">Converts a millisecond value into a <code>Date</code> object.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>value</code> - the millisecond value.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The date.</dd>
- </dl>
- </li>
- </ul>
- <a name="clone--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>clone</h4>
- <pre>public java.lang.Object <a href="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1216">clone</a>()
- throws java.lang.CloneNotSupportedException</pre>
- <div class="block">Returns a clone of the timeline.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>clone</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A clone.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code>java.lang.CloneNotSupportedException</code> - ??.</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/SegmentedTimeline.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/chart/axis/QuarterDateFormat.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/axis/SegmentedTimeline.BaseTimelineSegmentRange.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/axis/SegmentedTimeline.html" target="_top">Frames</a></li>
- <li><a href="SegmentedTimeline.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li><a href="#nested.class.summary">Nested</a> | </li>
- <li><a href="#field.summary">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|