public interface

VideoArchive

implements ILazy AnnotationObject
vars.annotation.VideoArchive
Known Indirect Subclasses

Summary

Constants
String PROP_NAME
String PROP_START_TIME_CODE
String PROP_VIDEO_ARCHIVE_SET
Public Methods
abstract void addVideoFrame(VideoFrame videoFrame)
abstract VideoFrame findVideoFrameByTimeCode(String timecode)
Searches the VideoArchive and returns the first video frame with the given time code;
abstract Collection<VideoFrame> getEmptyVideoFrames()
Empty VideoFrames are those that do not contain any observations.
abstract String getName()
Get the tape number of this VideoArchive.
abstract String getStartTimecode()
Stored in DB as a String instead of Timecode object
abstract VideoArchiveSet getVideoArchiveSet()
abstract List<VideoFrame> getVideoFrames()
Retrieve the videoframe collection.
abstract void removeVideoFrame(VideoFrame videoFrame)
abstract void setName(String videoArchiveName)
Set the tape number of this VideoArchive using the specified Integer.
abstract void setStartTimecode(String timecode)
The timecode is stored in DB as a String instead of Timecode object - Castor uses this method for O/R.
[Expand]
Inherited Methods
From interface vars.ILazy
From interface vars.VARSObject

Constants

public static final String PROP_NAME

Constant Value: "name"

public static final String PROP_START_TIME_CODE

Constant Value: "startTimecode"

public static final String PROP_VIDEO_ARCHIVE_SET

Constant Value: "videoArchiveSet"

Public Methods

public abstract void addVideoFrame (VideoFrame videoFrame)

public abstract VideoFrame findVideoFrameByTimeCode (String timecode)

Searches the VideoArchive and returns the first video frame with the given time code;

Parameters
timecode A String in the format of HH:MM:SS:FF
Returns
  • The VideoFrame with a timecode that matches the argument. If no matches are found null is returned. If multiple matches exist the first one found is returned.

public abstract Collection<VideoFrame> getEmptyVideoFrames ()

Empty VideoFrames are those that do not contain any observations. In general, this method isn't really needed. However, when reading vif files, occasionally an empty one escapes through. This finds thes errant beasts and returns references to them.

Returns
  • A collection of VideoFrames that do not contain any observations. The collection will be empty if no empty VideoFrames were found.

public abstract String getName ()

Get the tape number of this VideoArchive.

Returns
  • The integer tape number.

public abstract String getStartTimecode ()

Stored in DB as a String instead of Timecode object

public abstract VideoArchiveSet getVideoArchiveSet ()

public abstract List<VideoFrame> getVideoFrames ()

Retrieve the videoframe collection. Note: This can result in a database access if the VideoArchive has been persisted and retrieved from the database. Do not add or remove items directly from this collections.

Returns
  • A synchronized collection.

public abstract void removeVideoFrame (VideoFrame videoFrame)

public abstract void setName (String videoArchiveName)

Set the tape number of this VideoArchive using the specified Integer.

Parameters
videoArchiveName An Integer tape number for this VideoArchive.

public abstract void setStartTimecode (String timecode)

The timecode is stored in DB as a String instead of Timecode object - Castor uses this method for O/R. Developers should use setTimeCode instead of this method.