nl.lxtreme.ols.api.data
Class ChannelAnnotation

java.lang.Object
  extended by nl.lxtreme.ols.api.data.ChannelAnnotation
All Implemented Interfaces:
Comparable<ChannelAnnotation>

Deprecated.

@Deprecated
public final class ChannelAnnotation
extends Object
implements Comparable<ChannelAnnotation>

Provides an annotation for a single channel.


Constructor Summary
ChannelAnnotation(long aStartIndex, long aEndIndex, Object aData)
          Deprecated. Creates a new ChannelAnnotation instance.
 
Method Summary
 int compareTo(ChannelAnnotation aAnnotation)
          Deprecated.  
 boolean equals(Object obj)
          Deprecated. 
 Object getData()
          Deprecated.  
 long getEndTimestamp()
          Deprecated.  
 long getStartTimestamp()
          Deprecated.  
 int hashCode()
          Deprecated. 
 boolean isInRange(long aTimestamp)
          Deprecated. Returns whether this annotation starts before the given index and ends after the given index.
 boolean isInRange(long aStartIndex, long aEndIndex)
          Deprecated. Returns whether this annotation's start index is before the given end index and its end index is after the given start index.
 String toString()
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ChannelAnnotation

public ChannelAnnotation(long aStartIndex,
                         long aEndIndex,
                         Object aData)
Deprecated. 
Creates a new ChannelAnnotation instance.

Parameters:
aStartIndex - the sample index on which this annotation starts;
aEndIndex - the end index on which this annotation ends;
aData - the actual annotated data.
Method Detail

compareTo

public int compareTo(ChannelAnnotation aAnnotation)
Deprecated. 
Specified by:
compareTo in interface Comparable<ChannelAnnotation>
See Also:
Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)
Deprecated. 

Overrides:
equals in class Object

getData

public Object getData()
Deprecated. 
Returns:
the data

getEndTimestamp

public long getEndTimestamp()
Deprecated. 
Returns:
the endIndex

getStartTimestamp

public long getStartTimestamp()
Deprecated. 
Returns:
the startIndex

hashCode

public int hashCode()
Deprecated. 

Overrides:
hashCode in class Object

isInRange

public boolean isInRange(long aTimestamp)
Deprecated. 
Returns whether this annotation starts before the given index and ends after the given index.

Parameters:
aIndex - the index.
Returns:
true if this annotation is valid at the given index (see above), false otherwise.

isInRange

public boolean isInRange(long aStartIndex,
                         long aEndIndex)
Deprecated. 
Returns whether this annotation's start index is before the given end index and its end index is after the given start index.

Parameters:
aStartIndex - the starting index;
aEndIndex - the ending index.
Returns:
true if this annotation is valid between the given range (see above), false otherwise.

toString

public String toString()
Deprecated. 
Overrides:
toString in class Object
See Also:
Object.toString()


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.