org.lsst.ccs.gconsole.plugins.trending

Class TrendingChannel

java.lang.Object

org.lsst.ccs.gconsole.plugins.trending.TrendingChannel

All Implemented Interfaces:

Serializable, Comparable<TrendingChannel>

public class TrendingChannel
extends Object
implements Serializable, Comparable<TrendingChannel>

Trending channel identifier. The channel contains a unique path used for placement in the tree of channels, and a title used for naming plots. Channel equality and comparisons are based on their paths.

Author:

onoprien

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TrendingChannel(String path) Constructs a channel with a title equal to the path.
TrendingChannel(String path, String title) Constructs a channel.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TrendingChannel other)
boolean	equals(Object obj)
String	getPath() Returns the slash-separated path to this channel in the tree of channels displayed by the trending tool.
String	getTitle() Returns the title of this channel used for naming and identifying plots.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TrendingChannel

public TrendingChannel(String path)

Constructs a channel with a title equal to the path.

Parameters:

path - The path used for placement in the tree of channels.

TrendingChannel

public TrendingChannel(String path,
                       String title)

Constructs a channel.

Parameters:

path - The path used for placement in the tree of channels.

title - The title used for naming.

Method Detail

getPath

public String getPath()

Returns the slash-separated path to this channel in the tree of channels displayed by the trending tool.

Returns:

The path used for placement in the tree of channels.

getTitle

public String getTitle()

Returns the title of this channel used for naming and identifying plots.

Returns:

The title of this channel.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(TrendingChannel other)

Specified by:

compareTo in interface Comparable<TrendingChannel>