TimeWindow (LSST CCS Graphical User Interface 4.2.11 API)

java.lang.Object
- org.lsst.ccs.gconsole.plugins.trending.timeselection.TimeWindow

```
public final class TimeWindow
extends Object
```
Time window used by trending plots. The standard format for string representation of time window edges is "MM/dd/yyyy HH:mm:ss" for fixed edges and "now - XXX" (where XXX is time in milliseconds) for sliding edges.

Author:

turri, onoprien

Field Summary

Fields
Modifier and Type Field and Description

static SimpleDateFormat DATE_FORMAT

static String DATE_PATTERN

static Pattern EDGE_PATTERN

Fields
Modifier and Type	Field and Description
`static SimpleDateFormat`	`DATE_FORMAT`
`static String`	`DATE_PATTERN`
`static Pattern`	`EDGE_PATTERN`

Constructor Summary

Constructors
Constructor and Description
`TimeWindow(String name)` Constructs a named time window with no start and end values.
`TimeWindow(String name, long start, long end, boolean persistent)` Constructs time window instance.
`TimeWindow(String name, String start, String end, boolean persistent)` Constructs time window instance.
`TimeWindow(TimeWindow seed)` Constructs anonymous, non-persistent time window with the same start and end values as the seed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Comparator<TimeWindow>`	`compareByName()` Returns comparator that compares time windows by names.
`static Comparator`	`compareByTime()` Returns comparator that compares time windows by last use times, most recent first.
`long`	`getLastUseTime()` Returns the time in milliseconds when this time window was last selected.
`long`	`getLength()` Returns time window length.
`long`	`getLowerEdge()` Returns the current value of the lower edge of this window, in milliseconds since Epoch.
`long`	`getLowerEdge(long currentTime)` Returns the lower edge of this time window at the specified time, in milliseconds since Epoch.
`long`	`getLowerEdgeDelay()` Returns the difference between the lower edge of this time window and the current time, in milliseconds.
`String`	`getLowerEdgeString()` Returns the lower edge of this time window in standard format.
`String`	`getName()` Returns the name of this time window.
`long`	`getUpperEdge()` Returns the current value of the upper edge of this window, in milliseconds since Epoch.
`long`	`getUpperEdge(long currentTime)` Returns the upper edge of this time window at the specified time, in milliseconds since Epoch.
`long`	`getUpperEdgeDelay()` Returns the difference between the upper edge of this time window and the current time, in milliseconds.
`String`	`getUpperEdgeString()` Returns the upper edge of this time window in standard format.
`boolean`	`isFixed()` Returns `true` if both edges do not depend on current time.
`boolean`	`isLowerEdgeFixed()` Returns `true` if lower edge does not depend on current time.
`boolean`	`isPersistent()` Returns `true` if this time window should be persisted between sessions.
`boolean`	`isUpperEdgeFixed()` Returns `true` if upper edge does not depend on current time.
`static TimeWindow`	`parseCompressedString(String s)` Parses string representation of this time window used for saving it in application properties.
`static long`	`parseEdge(String edgeString)` Parses string representation of a time window edge in standard format.
`void`	`setLowerEdge(String edge)` Sets lower edge of this time window.
`void`	`setName(String name)` Sets the name of this time window.
`void`	`setPersistent(boolean persistent)` Sets the flag that indicate whether or not this time window should be persisted between sessions.
`void`	`setUpperEdge(String edge)` Sets upper edge of this time window.
`String`	`toCompressedString()` Returns string representation of this time window used for saving it in application properties.
`String`	`toString()` Returns user-readable string representation of this time window.
`void`	`touch()` Sets the time when this time window was last selected to the current system time.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DATE_PATTERN
```
public static final String DATE_PATTERN
```
    See Also:
    
    Constant Field Values
  - DATE_FORMAT
```
public static final SimpleDateFormat DATE_FORMAT
```
  - EDGE_PATTERN
```
public static final Pattern EDGE_PATTERN
```
- Constructor Detail
  - TimeWindow
```
public TimeWindow(String name,
                  long start,
                  long end,
                  boolean persistent)
```
    Constructs time window instance.
    
    Parameters:
    
    name - Time window name.
    
    start - Time window start, in seconds since Epoch.
    
    end - Time window end, in seconds since Epoch.
    
    persistent - True is this time window will be persisted between console sessions.
    
    Throws:
    
    IllegalArgumentException - If the combination of arguments is illegal.
  - TimeWindow
```
public TimeWindow(String name,
                  String start,
                  String end,
                  boolean persistent)
```
    Constructs time window instance.
    
    Parameters:
    
    name - Time window name.
    
    start - Time window start, in standard format.
    
    end - Time window end, in standard format.
    
    persistent - True is this time window will be persisted between console sessions.
    
    Throws:
    
    IllegalArgumentException - If the combination of arguments is illegal, or the strings cannot be parsed.
  - TimeWindow
```
public TimeWindow(String name)
```
    Constructs a named time window with no start and end values. Used as marker instances.
    
    Parameters:
    
    name - Time window name.
  - TimeWindow
```
public TimeWindow(TimeWindow seed)
```
    Constructs anonymous, non-persistent time window with the same start and end values as the seed. Used to provide initial values for dialogs.
    
    Parameters:
    
    seed - Time window that provides start and end values.
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of this time window.
  - setName
```
public void setName(String name)
```
    Sets the name of this time window.
  - isFixed
```
public boolean isFixed()
```
    Returns true if both edges do not depend on current time.
  - isLowerEdgeFixed
```
public boolean isLowerEdgeFixed()
```
    Returns true if lower edge does not depend on current time.
  - isUpperEdgeFixed
```
public boolean isUpperEdgeFixed()
```
    Returns true if upper edge does not depend on current time.
  - getLowerEdgeDelay
```
public long getLowerEdgeDelay()
```
    Returns the difference between the lower edge of this time window and the current time, in milliseconds.
  - getUpperEdgeDelay
```
public long getUpperEdgeDelay()
```
    Returns the difference between the upper edge of this time window and the current time, in milliseconds.
  - getLowerEdge
```
public long getLowerEdge()
```
    Returns the current value of the lower edge of this window, in milliseconds since Epoch.
  - getUpperEdge
```
public long getUpperEdge()
```
    Returns the current value of the upper edge of this window, in milliseconds since Epoch.
  - getLowerEdge
```
public long getLowerEdge(long currentTime)
```
    Returns the lower edge of this time window at the specified time, in milliseconds since Epoch.
  - getUpperEdge
```
public long getUpperEdge(long currentTime)
```
    Returns the upper edge of this time window at the specified time, in milliseconds since Epoch.
  - getLowerEdgeString
```
public String getLowerEdgeString()
```
    Returns the lower edge of this time window in standard format.
  - getUpperEdgeString
```
public String getUpperEdgeString()
```
    Returns the upper edge of this time window in standard format.
  - setLowerEdge
```
public void setLowerEdge(String edge)
```
    Sets lower edge of this time window.
    
    Parameters:
    
    edge - Edge value in standard format.
    
    Throws:
    
    IllegalArgumentException - if the specified string is not in standard format.
  - setUpperEdge
```
public void setUpperEdge(String edge)
```
    Sets upper edge of this time window.
    
    Parameters:
    
    edge - Edge value in standard format.
    
    Throws:
    
    IllegalArgumentException - if the specified string is not in standard format.
  - getLength
```
public long getLength()
```
    Returns time window length. If the length is variable, current length is returned.
    
    Returns:
    
    Window duration in milliseconds.
  - isPersistent
```
public boolean isPersistent()
```
    Returns true if this time window should be persisted between sessions.
  - setPersistent
```
public void setPersistent(boolean persistent)
```
    Sets the flag that indicate whether or not this time window should be persisted between sessions.
  - getLastUseTime
```
public long getLastUseTime()
```
    Returns the time in milliseconds when this time window was last selected.
  - touch
```
public void touch()
```
    Sets the time when this time window was last selected to the current system time.
  - toString
```
public String toString()
```
    Returns user-readable string representation of this time window.
    
    Overrides:
    
    toString in class Object
  - toCompressedString
```
public String toCompressedString()
```
    Returns string representation of this time window used for saving it in application properties.
  - parseEdge
```
public static long parseEdge(String edgeString)
```
    Parses string representation of a time window edge in standard format.
    
    Returns:
    
    Time window edge represented as a long.
  - parseCompressedString
```
public static TimeWindow parseCompressedString(String s)
```
    Parses string representation of this time window used for saving it in application properties.
  - compareByName
```
public static Comparator<TimeWindow> compareByName()
```
    Returns comparator that compares time windows by names.
  - compareByTime
```
public static Comparator compareByTime()
```
    Returns comparator that compares time windows by last use times, most recent first.

Class TimeWindow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATE_PATTERN

DATE_FORMAT

EDGE_PATTERN

Constructor Detail

TimeWindow

TimeWindow

TimeWindow

TimeWindow

Method Detail

getName

setName

isFixed

isLowerEdgeFixed

isUpperEdgeFixed

getLowerEdgeDelay

getUpperEdgeDelay

getLowerEdge

getUpperEdge

getLowerEdge

getUpperEdge

getLowerEdgeString

getUpperEdgeString

setLowerEdge

setUpperEdge

getLength

isPersistent

setPersistent

getLastUseTime

touch

toString

toCompressedString

parseEdge

parseCompressedString

compareByName

compareByTime