org.jfree.chart.axis
public class SegmentedTimeline.Segment extends Object implements Comparable, Cloneable, Serializable
Each segment will know its segment number, segmentStart, segmentEnd and index inside the segment.
| Field Summary | |
|---|---|
| protected long | millisecond A reference point within the segment. |
| protected long | segmentEnd The segment end. |
| protected long | segmentNumber The segment number. |
| protected long | segmentStart The segment start. |
| Constructor Summary | |
|---|---|
| protected | Segment()
Protected constructor only used by sub-classes. |
| protected | Segment(long millisecond)
Creates a segment for a given point in time.
|
| Method Summary | |
|---|---|
| boolean | after(SegmentedTimeline.Segment other)
Returns true if this segment is wholly after another
segment.
|
| boolean | before(SegmentedTimeline.Segment other)
Returns true if this segment is wholly before another
segment.
|
| long | calculateSegmentNumber(long millis)
Calculates the segment number for a given millisecond.
|
| int | compareTo(Object object)
Will compare this Segment with another Segment (from Comparable
interface).
|
| boolean | contained(long from, long to)
Returns true if this segment is contained in an
interval.
|
| boolean | contains(long millis)
Returns true if a particular millisecond is contained in this
segment.
|
| boolean | contains(long from, long to)
Returns true if an interval is contained in this
segment.
|
| boolean | contains(SegmentedTimeline.Segment segment)
Returns true if a segment is contained in this segment.
|
| SegmentedTimeline.Segment | copy()
Returns a copy of ourselves or null if there was an
exception during cloning.
|
| void | dec(long n)
Decrements the internal attributes of this segment by a number of
segments.
|
| void | dec()
Decrements the internal attributes of this segment by one segment.
|
| boolean | equals(Object object)
Tests an object (usually another Segment) for equality
with this segment.
|
| Date | getDate()
Returns a java.util.Date that represents the reference point
for this segment.
|
| long | getMillisecond()
Returns the millisecond used to reference this segment (always
between the segmentStart and segmentEnd).
|
| long | getSegmentCount()
Returns always one (the number of segments contained in this
segment).
|
| long | getSegmentEnd()
Gets the end of this segment in ms.
|
| long | getSegmentNumber()
Returns the segment number of this segment. |
| long | getSegmentStart()
Gets the start of this segment in ms.
|
| void | inc(long n)
Increments the internal attributes of this segment by a number of
segments.
|
| void | inc()
Increments the internal attributes of this segment by one segment.
|
| boolean | inExceptionSegments()
Returns true if we are an exception segment. |
| boolean | inExcludeSegments()
Returns true if we are an excluded segment.
|
| boolean | inIncludeSegments()
Returns true if we are an included segment and we are not an
exception.
|
| SegmentedTimeline.Segment | intersect(long from, long to)
Returns a segment that is the intersection of this segment and the
interval.
|
| void | moveIndexToEnd()
Moves the index of this segment to the end of the segment. |
| void | moveIndexToStart()
Moves the index of this segment to the beginning if the segment. |
Parameters: millisecond the millisecond (as encoded by java.util.Date).
true if this segment is wholly after another
segment.
Parameters: other the other segment.
Returns: A boolean.
true if this segment is wholly before another
segment.
Parameters: other the other segment.
Returns: A boolean.
Parameters: millis the millisecond (as encoded by java.util.Date).
Returns: The segment number.
Parameters: object The other Segment to compare with
Returns: -1: this < object, 0: this.equal(object) and +1: this > object
true if this segment is contained in an
interval.
Parameters: from the start of the interval. to the end of the interval.
Returns: true if this segment is contained in the
interval.
Parameters: millis the millisecond to verify.
Returns: true if the millisecond is contained in the
segment.
true if an interval is contained in this
segment.
Parameters: from the start of the interval. to the end of the interval.
Returns: true if the interval is contained in the
segment.
true if a segment is contained in this segment.
Parameters: segment the segment to test for inclusion
Returns: true if the segment is contained in this
segment.
null if there was an
exception during cloning.
Returns: A copy of this segment.
Parameters: n Number of segments to decrement.
Segment) for equality
with this segment.
Parameters: object The other segment to compare with us
Returns: true if we are the same segment
Returns: The date.
Returns: The millisecond.
Returns: The segment count (always 1 for this class).
Returns: The segment end.
Returns: The segment number.
Returns: The segment start.
Parameters: n Number of segments to increment.
Returns: true if we are an exception segment.
Returns: true or false.
Returns: true or false.
Parameters: from the start of the interval. to the end of the interval.
Returns: A segment.