public class

VideoArchiveSetImpl

extends Object
implements Serializable VideoArchiveSet JPAEntity
java.lang.Object
   ↳ vars.annotation.jpa.VideoArchiveSetImpl

Summary

[Expand]
Inherited Constants
From interface vars.annotation.VideoArchiveSet
Public Constructors
VideoArchiveSetImpl()
Public Methods
void addCameraDeployment(CameraDeployment cameraDeployment)
Add to the CameraPlatformDeployment collection.
void addVideoArchive(VideoArchive videoArchive)
Add an VideoArchive.
boolean equals(Object obj)
Set<CameraDeployment> getCameraDeployments()
Gets the cameraPlatformDeploymentColl attribute of the VideoArchiveSet object
Date getEndDate()
Gets the endDTG attribute of the VideoArchiveSet object
char getFormatCode()
Get the char Format Code for this VideoArchiveSet.
Long getId()
String getPlatformName()
Get the String platform name for this VideoArchiveSet.
Object getPrimaryKey()
String getShipName()
Get the String ship name for this VideoArchiveSet.
Date getStartDate()
Gets the startDTG attribute of the VideoArchiveSet object
String getTrackingNumber()
Gets the trackingNumber attribute of the VideoArchiveSet object
VideoArchive getVideoArchiveByName(String videoArchiveName)
Retrieve a child VideoArchive with the matching videoArchiveName (which is a unique key)
Set<VideoArchive> getVideoArchives()
Gets the videoArchiveColl attribute of the VideoArchiveSet object
List<VideoFrame> getVideoFrames()
This is a convience method to retrieve all VideoFrames that are stored in all the child VideoArchives.
boolean hasSequenceNumber(int seqNumber)
boolean hasVideoArchiveName(String videoArchiveName)
int hashCode()
void removeCameraDeployment(CameraDeployment cameraDeployment)

void removeVideoArchive(VideoArchive videoArchive)

void setEndDate(Date endDTG)
Sets the ending date of the time period that a VideoArchiveSet represents
void setFormatCode(char formatCode)
Required by Castor.
void setId(Long id)
void setPlatformName(String platformName)
Set the name of the platform that the Camera was mounted onto.
void setShipName(String shipName)
Set the ship name that produces this VideoArchiveSet
void setStartDate(Date startDTG)
Sets the starting date of the time period that a VideoArchiveSet was recorded over attribute of the VideoArchiveSet object
void setTrackingNumber(String trackingNumber)
Set the trackingNumber
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface vars.VARSObject
From interface vars.annotation.VideoArchiveSet
From interface vars.jpa.JPAEntity

Public Constructors

public VideoArchiveSetImpl ()

Public Methods

public void addCameraDeployment (CameraDeployment cameraDeployment)

Add to the CameraPlatformDeployment collection.

Returns
  • The passed CameraPlatformDeployment object if added, the matching CameraPlatformDeployment object otherwise.

public void addVideoArchive (VideoArchive videoArchive)

Add an VideoArchive.

Returns
  • The passed VideoArchive object if added, the matching VideoArchive object otherwise.

public boolean equals (Object obj)

public Set<CameraDeployment> getCameraDeployments ()

Gets the cameraPlatformDeploymentColl attribute of the VideoArchiveSet object

Returns
  • The cameraPlatformDeploymentColl. This is a synchronized list of CameraPlatformDeployment objects. Remember to synchronize on it before using it's iterator.

public Date getEndDate ()

Gets the endDTG attribute of the VideoArchiveSet object

Returns
  • The endDTG value

public char getFormatCode ()

Get the char Format Code for this VideoArchiveSet.

Returns
  • The char Format Code for this VideoArchiveSet.

public Long getId ()

public String getPlatformName ()

Get the String platform name for this VideoArchiveSet.

Returns
  • The String platform name for this VideoArchiveSet.

public Object getPrimaryKey ()

public String getShipName ()

Get the String ship name for this VideoArchiveSet.

Returns
  • The String ship name for this VideoArchiveSet.

public Date getStartDate ()

Gets the startDTG attribute of the VideoArchiveSet object

Returns
  • The startDTG value

public String getTrackingNumber ()

Gets the trackingNumber attribute of the VideoArchiveSet object

Returns
  • The trackingNumber value

public VideoArchive getVideoArchiveByName (String videoArchiveName)

Retrieve a child VideoArchive with the matching videoArchiveName (which is a unique key)

Parameters
videoArchiveName The videoArchiveName to search for. If null is supplied then the return will always be null.
Returns
  • The matching videoarchive if this VideoArchvieSet contains a VideoArchive with the given videoArchiveName. null otherwise.

public Set<VideoArchive> getVideoArchives ()

Gets the videoArchiveColl attribute of the VideoArchiveSet object

Returns
  • The videoArchiveColl value

public List<VideoFrame> getVideoFrames ()

This is a convience method to retrieve all VideoFrames that are stored in all the child VideoArchives.

Returns
  • A collection of ALL VideoFrames that are part of this VideoArchiveSet

public boolean hasSequenceNumber (int seqNumber)

public boolean hasVideoArchiveName (String videoArchiveName)

public int hashCode ()

public void removeCameraDeployment (CameraDeployment cameraDeployment)

public void removeVideoArchive (VideoArchive videoArchive)

public void setEndDate (Date endDTG)

Sets the ending date of the time period that a VideoArchiveSet represents

Parameters
endDTG The new endDTG value

public void setFormatCode (char formatCode)

Required by Castor.

Parameters
formatCode The new formatCode value

public void setId (Long id)

public void setPlatformName (String platformName)

Set the name of the platform that the Camera was mounted onto. Typically this will be the ROV name

Parameters
platformName The ROV name. It can be up to 4 characters long.

public void setShipName (String shipName)

Set the ship name that produces this VideoArchiveSet

Parameters
shipName Can only be up to 4 characcters long

public void setStartDate (Date startDTG)

Sets the starting date of the time period that a VideoArchiveSet was recorded over attribute of the VideoArchiveSet object

Parameters
startDTG The new startDTG value

public void setTrackingNumber (String trackingNumber)

Set the trackingNumber

Parameters
trackingNumber It can be up to 7 characters long

public String toString ()