public interface

VideoArchiveSet

implements AnnotationObject
vars.annotation.VideoArchiveSet
Known Indirect Subclasses

Summary

Constants
String PROP_END_DATE
String PROP_FORMAT_CODE
String PROP_PLATFORM_NAME
String PROP_SHIP_NAME
String PROP_START_DATE
String PROP_TRACKING_NUMBER
Public Methods
abstract void addCameraDeployment(CameraDeployment cameraDeployment)
Add to the CameraPlatformDeployment collection.
abstract void addVideoArchive(VideoArchive videoArchive)
Add an VideoArchive.
abstract Set<CameraDeployment> getCameraDeployments()
Gets the cameraPlatformDeploymentColl attribute of the VideoArchiveSet object
abstract Date getEndDate()
Gets the endDTG attribute of the VideoArchiveSet object
abstract char getFormatCode()
Get the char Format Code for this VideoArchiveSet.
abstract String getPlatformName()
Get the String platform name for this VideoArchiveSet.
abstract String getShipName()
Get the String ship name for this VideoArchiveSet.
abstract Date getStartDate()
Gets the startDTG attribute of the VideoArchiveSet object
abstract String getTrackingNumber()
Gets the trackingNumber attribute of the VideoArchiveSet object
abstract VideoArchive getVideoArchiveByName(String videoArchiveName)
Retrieve a child VideoArchive with the matching videoArchiveName (which is a unique key)
abstract Set<VideoArchive> getVideoArchives()
Gets the videoArchiveColl attribute of the VideoArchiveSet object
abstract List<VideoFrame> getVideoFrames()
This is a convience method to retrieve all VideoFrames that are stored in all the child VideoArchives.
abstract boolean hasSequenceNumber(int seqNumber)
abstract boolean hasVideoArchiveName(String videoArchiveName)
abstract void removeCameraDeployment(CameraDeployment cpd)

abstract void removeVideoArchive(VideoArchive va)

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

Constants

public static final String PROP_END_DATE

Constant Value: "endDate"

public static final String PROP_FORMAT_CODE

Constant Value: "formatCode"

public static final String PROP_PLATFORM_NAME

Constant Value: "platformName"

public static final String PROP_SHIP_NAME

Constant Value: "shipName"

public static final String PROP_START_DATE

Constant Value: "startDate"

public static final String PROP_TRACKING_NUMBER

Constant Value: "trackingNumber"

Public Methods

public abstract void addCameraDeployment (CameraDeployment cameraDeployment)

Add to the CameraPlatformDeployment collection.

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

public abstract void addVideoArchive (VideoArchive videoArchive)

Add an VideoArchive.

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

public abstract 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 abstract Date getEndDate ()

Gets the endDTG attribute of the VideoArchiveSet object

Returns
  • The endDTG value

public abstract char getFormatCode ()

Get the char Format Code for this VideoArchiveSet.

Returns
  • The char Format Code for this VideoArchiveSet.

public abstract String getPlatformName ()

Get the String platform name for this VideoArchiveSet.

Returns
  • The String platform name for this VideoArchiveSet.

public abstract String getShipName ()

Get the String ship name for this VideoArchiveSet.

Returns
  • The String ship name for this VideoArchiveSet.

public abstract Date getStartDate ()

Gets the startDTG attribute of the VideoArchiveSet object

Returns
  • The startDTG value

public abstract String getTrackingNumber ()

Gets the trackingNumber attribute of the VideoArchiveSet object

Returns
  • The trackingNumber value

public abstract 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 abstract Set<VideoArchive> getVideoArchives ()

Gets the videoArchiveColl attribute of the VideoArchiveSet object

Returns
  • The videoArchiveColl value

public abstract 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 abstract boolean hasSequenceNumber (int seqNumber)

Parameters
seqNumber The sequence number to search for
Returns
  • true if this VideoArchiveSet contains a CameraPlatfomDeployment with the given seqNumber. false otherwise.

public abstract boolean hasVideoArchiveName (String videoArchiveName)

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

public abstract void removeCameraDeployment (CameraDeployment cpd)

public abstract void removeVideoArchive (VideoArchive va)

public abstract void setEndDate (Date endDTG)

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

Parameters
endDTG The new endDTG value

public abstract void setFormatCode (char formatCode)

Required by Castor.

Parameters
formatCode The new formatCode value

public abstract 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 abstract void setShipName (String shipName)

Set the ship name that produces this VideoArchiveSet

Parameters
shipName Can only be up to 4 characcters long

public abstract 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 abstract void setTrackingNumber (String trackingNumber)

Set the trackingNumber

Parameters
trackingNumber It can be up to 7 characters long