public class

SegmentedTimeline.Segment

extends Object
implements Serializable Cloneable Comparable<T>
java.lang.Object
   ↳ org.jfree.chart.axis.SegmentedTimeline.Segment
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Internal class to represent a valid segment for this timeline. A segment is valid on a timeline if it is part of its included, excluded or exception segments.

Each segment will know its segment number, segmentStart, segmentEnd and index inside the segment.

Summary

Fields
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.
Protected Constructors
SegmentedTimeline.Segment()
Protected constructor only used by sub-classes.
SegmentedTimeline.Segment(long millisecond)
Creates a segment for a given point in time.
Public Methods
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(SegmentedTimeline.Segment segment)
Returns true if a segment is contained in this segment.
boolean contains(long from, long to)
Returns true if an interval 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 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.
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.
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.
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable

Fields

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.

Protected Constructors

protected SegmentedTimeline.Segment ()

Protected constructor only used by sub-classes.

protected SegmentedTimeline.Segment (long millisecond)

Creates a segment for a given point in time.

Parameters
millisecond the millisecond (as encoded by java.util.Date).

Public Methods

public boolean after (SegmentedTimeline.Segment other)

Returns true if this segment is wholly after another segment.

Parameters
other the other segment.
Returns
  • A boolean.

public boolean before (SegmentedTimeline.Segment other)

Returns true if this segment is wholly before another segment.

Parameters
other the other segment.
Returns
  • A boolean.

public long calculateSegmentNumber (long millis)

Calculates the segment number for a given millisecond.

Parameters
millis the millisecond (as encoded by java.util.Date).
Returns
  • The segment number.

public int compareTo (Object object)

Will compare this Segment with another Segment (from Comparable interface).

Parameters
object The other Segment to compare with
Returns
  • -1: this < object, 0: this.equal(object) and +1: this > object

public boolean contained (long from, long to)

Returns 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.

public boolean contains (long millis)

Returns true if a particular millisecond is contained in this segment.

Parameters
millis the millisecond to verify.
Returns
  • true if the millisecond is contained in the segment.

public boolean contains (SegmentedTimeline.Segment segment)

Returns 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.

public boolean contains (long from, long to)

Returns 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.

public SegmentedTimeline.Segment copy ()

Returns a copy of ourselves or null if there was an exception during cloning.

Returns
  • A copy of this segment.

public void dec (long n)

Decrements the internal attributes of this segment by a number of segments.

Parameters
n Number of segments to decrement.

public void dec ()

Decrements the internal attributes of this segment by one segment. The exact time decremented is segmentSize.

public boolean equals (Object object)

Tests an object (usually another Segment) for equality with this segment.

Parameters
object The other segment to compare with us
Returns
  • true if we are the same segment

public Date getDate ()

Returns a Date that represents the reference point for this segment.

Returns
  • The date.

public long getMillisecond ()

Returns the millisecond used to reference this segment (always between the segmentStart and segmentEnd).

Returns
  • The millisecond.

public long getSegmentCount ()

Returns always one (the number of segments contained in this segment).

Returns
  • The segment count (always 1 for this class).

public long getSegmentEnd ()

Gets the end of this segment in ms.

Returns
  • The segment end.

public long getSegmentNumber ()

Returns the segment number of this segment. Segments start at 0.

Returns
  • The segment number.

public long getSegmentStart ()

Gets the start of this segment in ms.

Returns
  • The segment start.

public boolean inExceptionSegments ()

Returns true if we are an exception segment. This is implemented via a binary search on the exceptionSegments sorted list. If the segment is not listed as an exception in our list and we have a baseTimeline, a check is performed to see if the segment is inside an excluded segment from our base. If so, it is also considered an exception.

Returns
  • true if we are an exception segment.

public boolean inExcludeSegments ()

Returns true if we are an excluded segment.

Returns
  • true or false.

public boolean inIncludeSegments ()

Returns true if we are an included segment and we are not an exception.

Returns
  • true or false.

public void inc (long n)

Increments the internal attributes of this segment by a number of segments.

Parameters
n Number of segments to increment.

public void inc ()

Increments the internal attributes of this segment by one segment. The exact time incremented is segmentSize.

public SegmentedTimeline.Segment intersect (long from, long to)

Returns a segment that is the intersection of this segment and the interval.

Parameters
from the start of the interval.
to the end of the interval.
Returns
  • A segment.

public void moveIndexToEnd ()

Moves the index of this segment to the end of the segment.

public void moveIndexToStart ()

Moves the index of this segment to the beginning if the segment.