segmentedtimeline.html

jfreechart最新源代码

<HR>

<A NAME="containsDomainRange(long, long)"><!-- --></A><H3>
containsDomainRange</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.733"><B>containsDomainRange</B></A>(long&nbsp;domainValueStart,
                                   long&nbsp;domainValueEnd)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><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></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>domainValueStart</CODE> - start of the range to verify<DD><CODE>domainValueEnd</CODE> - end of the range to verify
<DT><B>Returns:</B><DD><code>true</code> if the range is contained in the timeline</DL>
</DD>
</DL>
<HR>

<A NAME="containsDomainRange(java.util.Date, java.util.Date)"><!-- --></A><H3>
containsDomainRange</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.766"><B>containsDomainRange</B></A>(java.util.Date&nbsp;dateDomainValueStart,
                                   java.util.Date&nbsp;dateDomainValueEnd)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><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></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dateDomainValueStart</CODE> - start of the range to verify<DD><CODE>dateDomainValueEnd</CODE> - end of the range to verify
<DT><B>Returns:</B><DD><code>true</code> if the range is contained in the timeline</DL>
</DD>
</DL>
<HR>

<A NAME="addException(long)"><!-- --></A><H3>
addException</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.785"><B>addException</B></A>(long&nbsp;millisecond)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>millisecond</CODE> - domain value to treat as an exception</DL>
</DD>
</DL>
<HR>

<A NAME="addException(long, long)"><!-- --></A><H3>
addException</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.804"><B>addException</B></A>(long&nbsp;fromDomainValue,
                         long&nbsp;toDomainValue)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromDomainValue</CODE> - start of domain range to treat as an exception<DD><CODE>toDomainValue</CODE> - end of domain range to treat as an exception</DL>
</DD>
</DL>
<HR>

<A NAME="addException(java.util.Date)"><!-- --></A><H3>
addException</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.819"><B>addException</B></A>(java.util.Date&nbsp;exceptionDate)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exceptionDate</CODE> - Date into the segment to exclude.</DL>
</DD>
</DL>
<HR>

<A NAME="addExceptions(java.util.List)"><!-- --></A><H3>
addExceptions</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.836"><B>addExceptions</B></A>(java.util.List&nbsp;exceptionList)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exceptionList</CODE> - List of Date objects that identify the segments to
                       exclude.</DL>
</DD>
</DL>
<HR>

<A NAME="addBaseTimelineException(long)"><!-- --></A><H3>
addBaseTimelineException</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.875"><B>addBaseTimelineException</B></A>(long&nbsp;domainValue)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>domainValue</CODE> - domain value to teat as a baseTimeline exception.</DL>
</DD>
</DL>
<HR>

<A NAME="addBaseTimelineException(java.util.Date)"><!-- --></A><H3>
addBaseTimelineException</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.919"><B>addBaseTimelineException</B></A>(java.util.Date&nbsp;date)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - date domain value to treat as a baseTimeline exception</DL>
</DD>
</DL>
<HR>

<A NAME="addBaseTimelineExclusions(long, long)"><!-- --></A><H3>
addBaseTimelineExclusions</H3>
<PRE>
public void <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.932"><B>addBaseTimelineExclusions</B></A>(long&nbsp;fromBaseDomainValue,
                                      long&nbsp;toBaseDomainValue)</PRE>
<DL>
<DD>Adds all excluded segments from the BaseTimeline as exceptions to our 
 timeline. This allows us to combine two timelines for more complex 
 calculations.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromBaseDomainValue</CODE> - Start of the range where exclusions will be 
                            extracted.<DD><CODE>toBaseDomainValue</CODE> - End of the range to process.</DL>
</DD>
</DL>
<HR>

<A NAME="getExceptionSegmentCount(long, long)"><!-- --></A><H3>
getExceptionSegmentCount</H3>
<PRE>
public long <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.991"><B>getExceptionSegmentCount</B></A>(long&nbsp;fromMillisecond,
                                     long&nbsp;toMillisecond)</PRE>
<DL>
<DD>Returns the number of exception segments wholly contained in the
 (fromDomainValue, toDomainValue) interval.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromMillisecond</CODE> - the beginning of the interval.<DD><CODE>toMillisecond</CODE> - the end of the interval.
<DT><B>Returns:</B><DD>Number of exception segments contained in the interval.</DL>
</DD>
</DL>
<HR>

<A NAME="getSegment(long)"><!-- --></A><H3>
getSegment</H3>
<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.1022"><B>getSegment</B></A>(long&nbsp;millisecond)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>millisecond</CODE> - index into the segment
<DT><B>Returns:</B><DD>A Segment that contains index, or the next possible Segment.</DL>
</DD>
</DL>
<HR>

<A NAME="getSegment(java.util.Date)"><!-- --></A><H3>
getSegment</H3>
<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.1040"><B>getSegment</B></A>(java.util.Date&nbsp;date)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - date into the segment
<DT><B>Returns:</B><DD>A Segment that contains date, or the next possible Segment.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1065"><B>equals</B></A>(java.lang.Object&nbsp;o)</PRE>
<DL>
<DD>Returns true if we are equal to the parameter
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>o</CODE> - Object to verify with us
<DT><B>Returns:</B><DD><code>true</code> or <code>false</code></DL>
</DD>
</DL>
<HR>

<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <A HREF="../../../../src-html/org/jfree/chart/axis/SegmentedTimeline.html#line.1088"><B>hashCode</B></A>()</PRE>
<DL>
<DD>Returns a hash code for this object.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A hash code.</DL>
</DD>
</DL>
<HR>

<A NAME="getTime(java.util.Date)"><!-- --></A><H3>
getTime</H3>
<PRE>
public long <A HREF="../../../../src-html/org/jfree/chart/axis/Segmente